From fa79297982fe051950dcae94b34e0e8c2aa72055 Mon Sep 17 00:00:00 2001 From: Glenn Morris Date: Tue, 11 Feb 2014 20:43:35 -0500 Subject: [PATCH] * doc/lispref/package.texi (Simple Packages): Describe URL and Keywords headers --- doc/lispref/ChangeLog | 4 ++++ doc/lispref/package.texi | 8 +++++++- 2 files changed, 11 insertions(+), 1 deletion(-) 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 @@ +2014-02-12 Glenn Morris + + * package.texi (Simple Packages): Describe URL and Keywords headers. + 2014-02-10 Lars Ingebrigtsen * 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: ;; Author: J. R. Hacker ;; 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}. -- 2.39.2