diff options
| author | Noam Postavsky <npostavs@gmail.com> | 2017-03-25 00:58:44 -0400 |
|---|---|---|
| committer | Noam Postavsky <npostavs@gmail.com> | 2017-03-30 20:46:51 -0400 |
| commit | ee1bd94dd0ce427fcdfea33af38a4eaf47f911f0 (patch) | |
| tree | c7a0369a50e12c7e97240191c2c724592f056484 /doc/lispref/package.texi | |
| parent | fb18bff91f01a3051253319e766ca276e5b756bd (diff) | |
| download | emacs-ee1bd94dd0ce427fcdfea33af38a4eaf47f911f0.tar.gz | |
Improve packaging documentation
* doc/lispref/package.texi (Packaging Basics):
* doc/lispref/tips.texi (Library Headers): Clarify some header
formats, relation between file headers and package
attributes (Bug#13281).
Diffstat (limited to 'doc/lispref/package.texi')
| -rw-r--r-- | doc/lispref/package.texi | 12 |
1 files changed, 7 insertions, 5 deletions
diff --git a/doc/lispref/package.texi b/doc/lispref/package.texi index 6066ea9a936..b0dbe4d0a64 100644 --- a/doc/lispref/package.texi +++ b/doc/lispref/package.texi @@ -54,7 +54,8 @@ prefix used in the program (@pxref{Coding Conventions}). @item Version A version number, in a form that the function @code{version-to-list} understands (e.g., @samp{11.86}). Each release of a package should be -accompanied by an increase in the version number. +accompanied by an increase in the version number so that it will be +recognized as an upgrade by users querying the package archive. @item Brief description This is shown when the package is listed in the Package Menu. It @@ -71,8 +72,9 @@ once it is installed. A list of other packages (possibly including minimal acceptable version numbers) on which this package depends. The list may be empty, meaning this package has no dependencies. Otherwise, -installing this package also automatically installs its dependencies; -if any dependency cannot be found, the package cannot be installed. +installing this package also automatically installs its dependencies, +recursively; if any dependency cannot be found, the package cannot be +installed. @end table @cindex content directory, package @@ -212,8 +214,8 @@ subdirectories of the content directory. One of the files in the content directory must be named @file{@var{name}-pkg.el}. It must contain a single Lisp form, consisting of a call to the function @code{define-package}, described -below. This defines the package's version, brief description, and -requirements. +below. This defines the package's attributes: version, brief +description, and requirements. For example, if we distribute version 1.3 of the superfrobnicator as a multi-file package, the tar file would be |