aboutsummaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorStefan Kangas2024-07-05 13:58:07 +0200
committerStefan Kangas2024-07-05 15:02:23 +0200
commitcefec59df7b24887496dafc32eae69083dfa60f2 (patch)
tree94f48a3ef754c9ee981fa84bff7af7d824e376ce
parentd190cb0e886f3d748ddbb8bf915c19149d00c0c4 (diff)
downloademacs-cefec59df7b24887496dafc32eae69083dfa60f2.tar.gz
emacs-cefec59df7b24887496dafc32eae69083dfa60f2.zip
Document adding package dependency on Emacs version
* doc/lispref/package.texi (Simple Packages, Multi-file Packages): Document how to make a package depend on a specific version of Emacs.
-rw-r--r--doc/lispref/package.texi16
1 files changed, 9 insertions, 7 deletions
diff --git a/doc/lispref/package.texi b/doc/lispref/package.texi
index 421e64dd5d1..40c550b56b4 100644
--- a/doc/lispref/package.texi
+++ b/doc/lispref/package.texi
@@ -192,10 +192,11 @@ used as the long description. (When displaying the description, Emacs
192omits the @samp{;;; Commentary:} line, as well as the leading comment 192omits the @samp{;;; Commentary:} line, as well as the leading comment
193characters in the commentary itself.) 193characters in the commentary itself.)
194 194
195 If the file has a @samp{Package-Requires} header, that is used as 195 If the file has a @samp{Package-Requires} header, that is used as the
196the package dependencies. In the above example, the package depends 196package dependencies. In the above example, the package depends on the
197on the @samp{flange} package, version 1.0 or higher. @xref{Library 197@samp{flange} package, version 1.0 or higher. @xref{Library Headers},
198Headers}, for a description of the @samp{Package-Requires} header. If 198for a description of the @samp{Package-Requires} header. To depend on a
199specific version of Emacs, specify @samp{emacs} as the package name. If
199the header is omitted, the package has no dependencies. 200the header is omitted, the package has no dependencies.
200 201
201 The @samp{Keywords} and @samp{URL} headers are optional, but recommended. 202 The @samp{Keywords} and @samp{URL} headers are optional, but recommended.
@@ -247,9 +248,10 @@ is the brief description.
247 248
248@var{requirements} is a list of required packages and their versions. 249@var{requirements} is a list of required packages and their versions.
249Each element in this list should have the form @code{(@var{dep-name} 250Each element in this list should have the form @code{(@var{dep-name}
250@var{dep-version})}, where @var{dep-name} is a symbol whose name is 251@var{dep-version})}, where @var{dep-name} is a symbol whose name is the
251the dependency's package name, and @var{dep-version} is the 252dependency's package name, and @var{dep-version} is the dependency's
252dependency's version (a string). 253version (a string). The spacial value @samp{emacs} means that the
254package depends on the given version of Emacs.
253@end defun 255@end defun
254 256
255 If the content directory contains a file named @file{README}, this 257 If the content directory contains a file named @file{README}, this