aboutsummaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorGlenn Morris2014-02-11 20:43:35 -0500
committerGlenn Morris2014-02-11 20:43:35 -0500
commitfa79297982fe051950dcae94b34e0e8c2aa72055 (patch)
tree14a18c2344704a8b92cd0eec00a25281d0544f40
parenta215930cfe3c4f5ee7c4a9cde6486c41bcc0b45e (diff)
downloademacs-fa79297982fe051950dcae94b34e0e8c2aa72055.tar.gz
emacs-fa79297982fe051950dcae94b34e0e8c2aa72055.zip
* doc/lispref/package.texi (Simple Packages): Describe URL and Keywords headers
-rw-r--r--doc/lispref/ChangeLog4
-rw-r--r--doc/lispref/package.texi8
2 files changed, 11 insertions, 1 deletions
diff --git a/doc/lispref/ChangeLog b/doc/lispref/ChangeLog
index cf4cef30e0e..7de401889a3 100644
--- a/doc/lispref/ChangeLog
+++ b/doc/lispref/ChangeLog
@@ -1,3 +1,7 @@
12014-02-12 Glenn Morris <rgm@gnu.org>
2
3 * package.texi (Simple Packages): Describe URL and Keywords headers.
4
12014-02-10 Lars Ingebrigtsen <larsi@gnus.org> 52014-02-10 Lars Ingebrigtsen <larsi@gnus.org>
2 6
3 * text.texi (User-Level Deletion): Document 7 * text.texi (User-Level Deletion): Document
diff --git a/doc/lispref/package.texi b/doc/lispref/package.texi
index de8670fdc4b..4bc50b2358f 100644
--- a/doc/lispref/package.texi
+++ b/doc/lispref/package.texi
@@ -141,7 +141,8 @@ the various headers, as illustrated by the following example:
141;; Author: J. R. Hacker <jrh@@example.com> 141;; Author: J. R. Hacker <jrh@@example.com>
142;; Version: 1.3 142;; Version: 1.3
143;; Package-Requires: ((flange "1.0")) 143;; Package-Requires: ((flange "1.0"))
144;; Keywords: frobnicate 144;; Keywords: multimedia, frobnicate
145;; URL: http://example.com/jrhacker/superfrobnicate
145 146
146@dots{} 147@dots{}
147 148
@@ -177,6 +178,11 @@ on the @samp{flange} package, version 1.0 or higher. @xref{Library
177Headers}, for a description of the @samp{Package-Requires} header. If 178Headers}, for a description of the @samp{Package-Requires} header. If
178the header is omitted, the package has no dependencies. 179the header is omitted, the package has no dependencies.
179 180
181 The @samp{Keywords} and @samp{URL} headers are optional, but recommended.
182The command @code{describe-package} uses these to add links to its
183output. The @samp{Keywords} header should contain at least one
184standard keyword from the @code{finder-known-keywords} list.
185
180 The file ought to also contain one or more autoload magic comments, 186 The file ought to also contain one or more autoload magic comments,
181as explained in @ref{Packaging Basics}. In the above example, a magic 187as explained in @ref{Packaging Basics}. In the above example, a magic
182comment autoloads @code{superfrobnicator-mode}. 188comment autoloads @code{superfrobnicator-mode}.