* doc/lispref/package.texi (Simple Packages): Describe URL and Keywords headers
authorGlenn Morris <rgm@gnu.org>
Wed, 12 Feb 2014 01:43:35 +0000 (20:43 -0500)
committerGlenn Morris <rgm@gnu.org>
Wed, 12 Feb 2014 01:43:35 +0000 (20:43 -0500)
doc/lispref/ChangeLog
doc/lispref/package.texi

index cf4cef3..7de4018 100644 (file)
@@ -1,3 +1,7 @@
+2014-02-12  Glenn Morris  <rgm@gnu.org>
+
+       * package.texi (Simple Packages): Describe URL and Keywords headers.
+
 2014-02-10  Lars Ingebrigtsen  <larsi@gnus.org>
 
        * text.texi (User-Level Deletion): Document
index de8670f..4bc50b2 100644 (file)
@@ -141,7 +141,8 @@ the various headers, as illustrated by the following example:
 ;; Author: J. R. Hacker <jrh@@example.com>
 ;; Version: 1.3
 ;; Package-Requires: ((flange "1.0"))
-;; Keywords: frobnicate
+;; Keywords: multimedia, frobnicate
+;; URL: http://example.com/jrhacker/superfrobnicate
 
 @dots{}
 
@@ -177,6 +178,11 @@ on the @samp{flange} package, version 1.0 or higher.  @xref{Library
 Headers}, for a description of the @samp{Package-Requires} header.  If
 the header is omitted, the package has no dependencies.
 
+  The @samp{Keywords} and @samp{URL} headers are optional, but recommended.
+The command @code{describe-package} uses these to add links to its
+output.  The @samp{Keywords} header should contain at least one
+standard keyword from the @code{finder-known-keywords} list.
+
   The file ought to also contain one or more autoload magic comments,
 as explained in @ref{Packaging Basics}.  In the above example, a magic
 comment autoloads @code{superfrobnicator-mode}.