Mercurial > hg > xemacs-beta
comparison 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 |
comparison
equal
deleted
inserted
replaced
1612:28ffd53a1d42 | 1613:138c42c84aec |
---|---|
746 distribution DISTRIBUTION ; "mule" if MULE is needed, | 746 distribution DISTRIBUTION ; "mule" if MULE is needed, |
747 ; else "xemacs" | 747 ; else "xemacs" |
748 priority high | 748 priority high |
749 category CATEGORY ; Makefile | 749 category CATEGORY ; Makefile |
750 dump nil | 750 dump nil |
751 description "description" ; a one-line description string | 751 description "DESCRIPTION" ; a one-line period-terminated string |
752 filename FILENAME ; obsolete | 752 filename FILENAME ; obsolete |
753 md5sum MD5SUM ; generated | 753 md5sum MD5SUM ; generated |
754 size SIZE ; generated | 754 size SIZE ; generated |
755 provides (FEATURE ...) ; one for every `provides' form | 755 provides (FEATURE ...) ; one for every `provides' form |
756 requires (REQUIRES) ; Makefile | 756 requires (REQUIRES) ; Makefile |
760 type regular | 760 type regular |
761 )) | 761 )) |
762 @end example | 762 @end example |
763 | 763 |
764 You should replace NAME, DISTRIBUTION, DESCRIPTION, and FEATURE ... with | 764 You should replace NAME, DISTRIBUTION, DESCRIPTION, and FEATURE ... with |
765 appropriate values, according to the comments. Fields marked as | 765 appropriate values, according to the comments. As a matter of style, |
766 @samp{obsolete} can be ignored. Fields marked as @samp{generated} are | 766 the first letter of the description should be capitalized, and the |
767 generated by the package construction process, and will be filled in | 767 string should end with a period. It need not be a complete sentence |
768 automatically. Fields marked as @samp{Makefile} should be set as | 768 grammatically. Fields marked as @samp{obsolete} can be ignored. Fields |
769 variables in the @file{Makefile}. | 769 marked as @samp{generated} are generated by the package construction |
770 process, and will be filled in automatically. Fields marked as | |
771 @samp{Makefile} should be set as variables in the @file{Makefile}. | |
770 | 772 |
771 The @samp{provides} can be done automatically, but currently aren't. It | 773 The @samp{provides} can be done automatically, but currently aren't. It |
772 would probably be a good idea to set them in the @file{Makefile} (they | 774 would probably be a good idea to set them in the @file{Makefile} (they |
773 do change, fairly often, but at present they aren't. | 775 do change, fairly often, but at present they aren't. |
774 | 776 |