/[emacs]/emacs/lisp/emacs-lisp/lisp-mnt.el
ViewVC logotype

Diff of /emacs/lisp/emacs-lisp/lisp-mnt.el

Parent Directory Parent Directory | Revision Log Revision Log | View Patch Patch

revision 1.36 by fx, Tue Dec 18 16:30:26 2001 UTC revision 1.36.4.1 by miles, Fri Apr 4 06:20:16 2003 UTC
# Line 32  Line 32 
32  ;; First, it knows about the header conventions for library packages.  ;; First, it knows about the header conventions for library packages.
33  ;; One entry point supports generating synopses from a library directory.  ;; One entry point supports generating synopses from a library directory.
34  ;; Another can be used to check for missing headers in library files.  ;; Another can be used to check for missing headers in library files.
35  ;;  ;;
36  ;; Another entry point automatically addresses bug mail to a package's  ;; Another entry point automatically addresses bug mail to a package's
37  ;; maintainer or author.  ;; maintainer or author.
38    
# Line 40  Line 40 
40    
41  ;; This file is an example of the header conventions.  Note the following  ;; This file is an example of the header conventions.  Note the following
42  ;; features:  ;; features:
43  ;;  ;;
44  ;;    * Header line --- makes it possible to extract a one-line summary of  ;;    * Header line --- makes it possible to extract a one-line summary of
45  ;; the package's uses automatically for use in library synopses, KWIC  ;; the package's uses automatically for use in library synopses, KWIC
46  ;; indexes and the like.  ;; indexes and the like.
47  ;;  ;;
48  ;;    Format is three semicolons, followed by the filename, followed by  ;;    Format is three semicolons, followed by the filename, followed by
49  ;; three dashes, followed by the summary.  All fields space-separated.  ;; three dashes, followed by the summary.  All fields space-separated.
50  ;;  ;;
# Line 55  Line 55 
55  ;;       ;; Copyright (C) 1999, 2000, 2001 Free Software Foundation, Inc.  ;;       ;; Copyright (C) 1999, 2000, 2001 Free Software Foundation, Inc.
56  ;;  ;;
57  ;;    * A blank line  ;;    * A blank line
58  ;;  ;;
59  ;;    * Author line --- contains the name and net address of at least  ;;    * Author line --- contains the name and net address of at least
60  ;; the principal author.  ;; the principal author.
61  ;;  ;;
62  ;;    If there are multiple authors, they should be listed on continuation  ;;    If there are multiple authors, they should be listed on continuation
63  ;; lines led by ;;<TAB>, like this:  ;; lines led by ;;<TAB>, like this:
64  ;;  ;;
65  ;; ;; Author: Ashwin Ram <Ram-Ashwin@cs.yale.edu>  ;; ;; Author: Ashwin Ram <Ram-Ashwin@cs.yale.edu>
66  ;; ;;   Dave Sill <de5@ornl.gov>  ;; ;;   Dave Sill <de5@ornl.gov>
67  ;; ;;   David Lawrence <tale@pawl.rpi.edu>  ;; ;;   David Lawrence <tale@pawl.rpi.edu>
# Line 69  Line 69 
69  ;; ;;   Joe Wells <jbw@maverick.uswest.com>  ;; ;;   Joe Wells <jbw@maverick.uswest.com>
70  ;; ;;   Dave Brennan <brennan@hal.com>  ;; ;;   Dave Brennan <brennan@hal.com>
71  ;; ;;   Eric Raymond <esr@snark.thyrsus.com>  ;; ;;   Eric Raymond <esr@snark.thyrsus.com>
72  ;;  ;;
73  ;; This field may have some special values; notably "FSF", meaning  ;; This field may have some special values; notably "FSF", meaning
74  ;; "Free Software Foundation".  ;; "Free Software Foundation".
75  ;;  ;;
76  ;;    * Maintainer line --- should be a single name/address as in the Author  ;;    * Maintainer line --- should be a single name/address as in the Author
77  ;; line, or an address only, or the string "FSF".  If there is no maintainer  ;; line, or an address only, or the string "FSF".  If there is no maintainer
78  ;; line, the person(s) in the Author field are presumed to be it.  The example  ;; line, the person(s) in the Author field are presumed to be it.  The example
# Line 81  Line 81 
81  ;; that does "send mail to the author" without having to mine the name out by  ;; that does "send mail to the author" without having to mine the name out by
82  ;; hand. Please be careful about surrounding the network address with <> if  ;; hand. Please be careful about surrounding the network address with <> if
83  ;; there's also a name in the field.  ;; there's also a name in the field.
84  ;;  ;;
85  ;;    * Created line --- optional, gives the original creation date of the  ;;    * Created line --- optional, gives the original creation date of the
86  ;; file.  For historical interest, basically.  ;; file.  For historical interest, basically.
87  ;;  ;;
88  ;;    * Version line --- intended to give the reader a clue if they're looking  ;;    * Version line --- intended to give the reader a clue if they're looking
89  ;; at a different version of the file than the one they're accustomed to.  This  ;; at a different version of the file than the one they're accustomed to.  This
90  ;; may be an RCS or SCCS header.  ;; may be an RCS or SCCS header.
91  ;;  ;;
92  ;;    * Adapted-By line --- this is for FSF's internal use.  The person named  ;;    * Adapted-By line --- this is for FSF's internal use.  The person named
93  ;; in this field was the one responsible for installing and adapting the  ;; in this field was the one responsible for installing and adapting the
94  ;; package for the distribution.  (This file doesn't have one because the  ;; package for the distribution.  (This file doesn't have one because the
95  ;; author *is* one of the maintainers.)  ;; author *is* one of the maintainers.)
96  ;;  ;;
97  ;;    * Keywords line --- used by the finder code (now under construction)  ;;    * Keywords line --- used by the finder code (now under construction)
98  ;; for finding Emacs Lisp code related to a topic.  ;; for finding Emacs Lisp code related to a topic.
99  ;;  ;;
# Line 104  Line 104 
104  ;;  ;;
105  ;;    * Commentary line --- enables Lisp code to find the developer's and  ;;    * Commentary line --- enables Lisp code to find the developer's and
106  ;; maintainers' explanations of the package internals.  ;; maintainers' explanations of the package internals.
107  ;;  ;;
108  ;;    * Change log line --- optional, exists to terminate the commentary  ;;    * Change log line --- optional, exists to terminate the commentary
109  ;; section and start a change-log part, if one exists.  ;; section and start a change-log part, if one exists.
110  ;;  ;;
111  ;;    * Code line --- exists so Lisp can know where commentary and/or  ;;    * Code line --- exists so Lisp can know where commentary and/or
112  ;; change-log sections end.  ;; change-log sections end.
113  ;;  ;;
114  ;;    * Footer line --- marks end-of-file so it can be distinguished from  ;;    * Footer line --- marks end-of-file so it can be distinguished from
115  ;; an expanded formfeed or the results of truncation.  ;; an expanded formfeed or the results of truncation.
116    

Legend:
Removed from v.1.36  
changed lines
  Added in v.1.36.4.1

savannah-hackers-public@gnu.org
ViewVC Help
Powered by ViewVC 1.1.26