Mercurial > hg > xemacs-beta
diff man/lispref/packaging.texi @ 1613:138c42c84aec
[xemacs-hg @ 2003-08-11 10:07:09 by stephent]
package style guide <874r0oh5lo.fsf@tleepslib.sk.tsukuba.ac.jp>
author | stephent |
---|---|
date | Mon, 11 Aug 2003 10:07:12 +0000 |
parents | 37e56e920ac5 |
children | 712931b4b71d |
line wrap: on
line diff
--- a/man/lispref/packaging.texi Mon Aug 11 10:03:36 2003 +0000 +++ b/man/lispref/packaging.texi Mon Aug 11 10:07:12 2003 +0000 @@ -748,7 +748,7 @@ priority high category CATEGORY ; Makefile dump nil - description "description" ; a one-line description string + description "DESCRIPTION" ; a one-line period-terminated string filename FILENAME ; obsolete md5sum MD5SUM ; generated size SIZE ; generated @@ -762,11 +762,13 @@ @end example You should replace NAME, DISTRIBUTION, DESCRIPTION, and FEATURE ... with -appropriate values, according to the comments. Fields marked as -@samp{obsolete} can be ignored. Fields marked as @samp{generated} are -generated by the package construction process, and will be filled in -automatically. Fields marked as @samp{Makefile} should be set as -variables in the @file{Makefile}. +appropriate values, according to the comments. As a matter of style, +the first letter of the description should be capitalized, and the +string should end with a period. It need not be a complete sentence +grammatically. Fields marked as @samp{obsolete} can be ignored. Fields +marked as @samp{generated} are generated by the package construction +process, and will be filled in automatically. Fields marked as +@samp{Makefile} should be set as variables in the @file{Makefile}. The @samp{provides} can be done automatically, but currently aren't. It would probably be a good idea to set them in the @file{Makefile} (they