GNU bug report logs - #19490
Unclear info about libraries/packaging in manual

Previous Next

To add a comment to this bug, you must first unarchive it, by sending
a message to control AT debbugs.gnu.org, with unarchive 19490 in the body.
You can then email your comments to 19490 AT debbugs.gnu.org in the normal way.

Toggle the display of automated, internal messages from the tracker.

Message #5 received at submit <at> debbugs.gnu.org (full text, mbox):

From: Kelly Dean <kelly <at> prtime.org>
To: bug-gnu-emacs <at> gnu.org
Subject: Unclear info about libraries/packaging in manual
Date: Fri, 02 Jan 2015 06:59:46 +0000

«(elisp) Library Headers» says:
⌜`Keywords'
     This line lists keywords for the `finder-by-keyword' help command.
     Please use that command to see a list of the meaningful keywords.
     ...
     The name of this field is unfortunate, since people often assume
     it is the place to write arbitrary keywords that describe their
     package, rather than just the relevant Finder keywords.⌝

«(elisp) Simple Packages» says:
⌜A simple package consists of a single Emacs Lisp source file.  The file
must conform to the Emacs Lisp library header conventions (*note
Library Headers)⌝

but it shows a contradicting example package with:
⌜;; Keywords: multimedia, frobnicate⌝

Also, «(elisp) Library Headers» says to use a ⌜Homepage⌝ header, but «(elisp) Simple Packages» says to use a ⌜URL⌝ header.

Message #8 received at 19490 <at> debbugs.gnu.org (full text, mbox):

From: Lars Ingebrigtsen <larsi <at> gnus.org>
To: Kelly Dean <kelly <at> prtime.org>
Cc: 19490 <at> debbugs.gnu.org
Subject: Re: bug#19490: Unclear info about libraries/packaging in manual
Date: Fri, 02 Aug 2019 22:37:00 +0200

Kelly Dean <kelly <at> prtime.org> writes:

> «(elisp) Library Headers» says:
> ⌜`Keywords'
>      This line lists keywords for the `finder-by-keyword' help command.
>      Please use that command to see a list of the meaningful keywords.
>      ...
>      The name of this field is unfortunate, since people often assume
>      it is the place to write arbitrary keywords that describe their
>      package, rather than just the relevant Finder keywords.⌝
>
> «(elisp) Simple Packages» says:
> ⌜A simple package consists of a single Emacs Lisp source file.  The file
> must conform to the Emacs Lisp library header conventions (*note
> Library Headers)⌝
>
> but it shows a contradicting example package with:
> ⌜;; Keywords: multimedia, frobnicate⌝
>
> Also, «(elisp) Library Headers» says to use a ⌜Homepage⌝ header, but
> «(elisp) Simple Packages» says to use a ⌜URL⌝ header.

I've now fixed these inconsistencies in Emacs 27. 

-- 
(domestic pets only, the antidote for overdose, milk.)
   bloggy blog: http://lars.ingebrigtsen.no

Previous Next

GNU bug tracking system
Copyright (C) 1999 Darren O. Benham, 1997,2003 nCipher Corporation Ltd, 1994-97 Ian Jackson.