Add a note in the docs about not editing package files, fixes #779.

This commit is contained in:
Dimitri Fontaine 2012-07-30 19:33:55 +02:00
parent 4b85baa9a1
commit 8e68e637de
2 changed files with 74 additions and 44 deletions

View File

@ -75,26 +75,40 @@ File: el-get.info, Node: Acknowledgments, Next: Glossary, Prev: Introduction,
2 Acknowledgments
*****************
Dimitri Fontaine start the whole project and still manage the releases,
and sometimes even contribute code and documentation.
Dimitri Fontaine started the whole project and still manages the
releases, and sometimes even contribute code and documentation.
Julien Danjou has been a contributor since very early days, about the
first beta tester of the idea, before we really knew how much to
achieve.
Ryan Thompson joined and commented some issues, began contributing
and quickly became top-level and most active contributor to the project,
getting a commit bit and some management duties. He manages tests and
issues on github as much as he can spares time to el-get.
Ryan C. Thompson joined and commented some issues, began contributing
and quickly became top-level and most active contributor to the
project, getting a commit bit and some management duties. He manages
tests and issues on github as much as he can spares time to El-Get.
Dave Abrahams contributed lots of code and efforts to make things
right™. He's still using El-Get, but decided to retire from the
project.
Lots of people (more than we can list here) did contribute to el-get
Lots of people (more than we can list here) did contribute to El-Get
either recipes, bug fixes or ideas to implement, often with code. That
builds up an awesome community, thanks guys!
dim ~/dev/emacs/el-get git --no-pager shortlog -n -s | wc -l
133
dim ~/dev/emacs/el-get git --no-pager shortlog -n -s | head -10
713 Dimitri Fontaine
336 Ryan C. Thompson
110 Dave Abrahams
106 Julien Danjou
73 Ryan Thompson
68 Sébastien Gross
34 Takafumi Arakaki
25 Yakkala Yagnesh Raghava
25 Alex Ott
21 Rüdiger Sonderfeld

File: el-get.info, Node: Glossary, Next: Installing, Prev: Acknowledgments, Up: Top
@ -392,16 +406,10 @@ concurrently, in the background.
When SYNC is `sync', each package will be installed synchronously,
and any error will stop it all.
When SYNC is `wait', then `el-get' will enter a wait-loop and only
let you use Emacs once it has finished with its job. That's useful an
option to use in your *Note user-init-file: (emacs)user-init-file. Note
that each package in the list gets installed in parallel with this
option.
Please note that the `el-get-init' part of `el-get' is always done
synchronously, so you will have to wait here. There's `byte-compile'
support though, and the packages you use are welcome to use `autoload'
too.
synchronously. There's `byte-compile' support though, and the packages
you use are welcome to use `autoload' too. You can also force your
setup to be loaded lazily with the `el-get-is-lazy' variable.
`PACKAGES' is expected to be a list of packages you want to install
or init. When `PACKAGES' is omited (the default), the list of already
@ -580,6 +588,7 @@ variable EL-GET-SOURCES.
* Organizing recipes::
* Getting more recipes::
* Overriding package files::

File: el-get.info, Node: Organizing recipes, Next: Getting more recipes, Up: Recipes
@ -617,7 +626,7 @@ matching `el-get-sources' stanza.
El-Get also supports full User Init files, see *Note User Init::.

File: el-get.info, Node: Getting more recipes, Prev: Organizing recipes, Up: Recipes
File: el-get.info, Node: Getting more recipes, Next: Overriding package files, Prev: Organizing recipes, Up: Recipes
8.2 Getting more recipes
========================
@ -632,6 +641,17 @@ you often have to add some initialisation code. See *Note User Init::.
Emacs Lisp Packages from the ELPA archives you have setup, and make
them automatically available for El-Get.

File: el-get.info, Node: Overriding package files, Prev: Getting more recipes, Up: Recipes
8.3 Overriding package files
============================
El-Get manages the files associated with a package. You can browse
those files using the `el-get-cd' function. It's possible to hack on
those files, be aware that doing so might break your setup capability
to handle upgrades.

File: el-get.info, Node: Authoring Recipes, Prev: Recipes, Up: Top
@ -753,32 +773,33 @@ Tag Table:
Node: Top762
Node: Introduction1227
Node: Acknowledgments2302
Node: Glossary3313
Ref: Glossary - Init4409
Ref: Glossary - Install4711
Ref: Glossary - Recipe5798
Ref: Glossary - Status6222
Ref: Glossary - Update6480
Node: Installing6718
Node: Install the developper version7591
Node: Skip Emacswiki recipes when installing8336
Node: Usage9172
Node: Setup11461
Node: Basic Setup11857
Node: The el-get function13096
Node: Distributed Setup14605
Node: Setup Customization15916
Node: User Init17062
Node: Before and After properties17749
Node: Initialization files19257
Node: Recipes19910
Node: Organizing recipes20356
Node: Getting more recipes21871
Node: Authoring Recipes22536
Node: Recipe format22967
Node: Dependencies23636
Node: Byte Compilation23982
Node: Autoloads24548
Node: Build25674
Node: Glossary3752
Ref: Glossary - Init4848
Ref: Glossary - Install5150
Ref: Glossary - Recipe6237
Ref: Glossary - Status6661
Ref: Glossary - Update6919
Node: Installing7157
Node: Install the developper version8030
Node: Skip Emacswiki recipes when installing8775
Node: Usage9611
Node: Setup11900
Node: Basic Setup12296
Node: The el-get function13535
Node: Distributed Setup14811
Node: Setup Customization16122
Node: User Init17268
Node: Before and After properties17955
Node: Initialization files19463
Node: Recipes20116
Node: Organizing recipes20591
Node: Getting more recipes22106
Node: Overriding package files22804
Node: Authoring Recipes23187
Node: Recipe format23618
Node: Dependencies24287
Node: Byte Compilation24633
Node: Autoloads25199
Node: Build26325

End Tag Table

View File

@ -585,6 +585,7 @@ Recipes are a list of properties, which are documented in the variable
@menu
* Organizing recipes::
* Getting more recipes::
* Overriding package files::
@end menu
@node Organizing recipes
@ -636,6 +637,14 @@ The command @code{el-get-elpa-build-local-recipes} downloads the list
of Emacs Lisp Packages from the ELPA archives you have setup, and make
them automatically available for El-Get.
@node Overriding package files
@section Overriding package files
El-Get manages the files associated with a package. You can browse
those files using the @code{el-get-cd} function. It's possible to hack
on those files, be aware that doing so might break your setup
capability to handle upgrades.
@node Authoring Recipes
@chapter Authoring Recipes