procyberian/emacs
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

* doc/lispref/package.texi (Simple Packages): Describe URL and Keywords headers

Browse source
This commit is contained in:
Glenn Morris 2014-02-11 20:43:35 -05:00
parent a215930cfe
commit fa79297982
2 changed files with 11 additions and 1 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

4
doc/lispref/ChangeLog
View 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

8
doc/lispref/package.texi
View 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}.