home *** CD-ROM | disk | FTP | other *** search
/ InfoMagic Source Code 1993 July / THE_SOURCE_CODE_CD_ROM.iso / languages / elisp / GUIDELINES < prev    next >
Encoding:
Text File  |  1993-06-14  |  3.3 KB  |  87 lines
  1.        Guidelines for Submitting Code to the GNU Elisp Archive
  2.  
  3. 1. Documentation.
  4.  
  5.     The preferred documentation is:
  6.  
  7.     o Description of intended purpose
  8.     o Installation instructions
  9.     o Usage instructions
  10.     o Known bugs
  11.     o LCD Archive Entry (see below)
  12.     o Copyright notice (optional)
  13.  
  14.     Scale the documentation as required; don't write a book for a five-line
  15.     function, don't submit 100k of code with no instructions.
  16.  
  17. 2. Copyright
  18.  
  19.     The inclusion of a copyright notice that specifically allows others to
  20.     copy, modify, and redistribute your code is recommended.  For an
  21.     example, see the GNU Emacs General Public License (in Emacs: C-h C-c).
  22.  
  23. 3. Packaging
  24.  
  25.     Original submissions should be submitted in their entirety;
  26.     modifications to parts of the standard Emacs distribution or previously
  27.     archived code may be submitted as "diffs."
  28.  
  29.     Multifile submissions should be packaged as a tar or shar archive.
  30.  
  31. 4. Submission
  32.  
  33.     Single file submissions to the archive should be mailed to
  34.     elisp-archive@cis.ohio-state.edu.  If you have a package that
  35.     consists of more than one file, you can send mail to this 
  36.     address to set up an ftp transfer of the tar'ed package.  Please
  37.     do not submit a shar file, as we do not have the time to unshar
  38.     and repackage submissions.  (Previously submissions were accepted
  39.     anonymously at Ohio State, but OSU has disabled anonymous writes.)
  40.     If you have any questions about what to do, drop us a line.
  41.  
  42. 5. Lisp Code Directory Record
  43.  
  44.     In order to make the Archives easier to use, and to lighten the
  45.     load of the maintainers, please include an LCD record with your
  46.     submission.  You can include the entry in your code in the
  47.     following format:
  48.  
  49.       ;; LCD Archive Entry:
  50.       ;; package name|author's name|email address|
  51.       ;; description|
  52.       ;; date|version|archive path|
  53.  
  54.     For example:
  55.  
  56.       ;; LCD Archive Entry:
  57.       ;; tex-complete|Sebastian Kremer|sk@thp.Uni-Koeln.DE|
  58.       ;; Minibuffer name completion for editing [La]TeX.|
  59.       ;; 12-Mar-93|$Revision: 1.12 $|~/packages/tex-complete.el.Z|
  60.  
  61.     The line on which the fields occur is flexible, and need not duplicate
  62.     the format above exactly, although fields should not be split over
  63.     lines.  The above format is recommended, and submissions will be recast
  64.     to this format before they are placed in the archive.  If you are
  65.     submitting a multi-file submission you should include a file named
  66.     "LCD-entry" which contains the archive entry, instead of placing it in
  67.     one or more of the individual files.
  68.  
  69.     There are no specific formatting requirements for any of the fields.
  70.     For example, if you use RCS you could use "$Date: $" and "$Revision: $"
  71.     for the date and revision fields.  The prefix is also not important,
  72.     but should be the same for all lines.  You should not provide an
  73.     archive path unless one has been assigned by the maintainers, or the
  74.     path is blatantly obvious.  If you have any questions or comments about
  75.     this format please send mail to brennan@hal.com.
  76.  
  77.     Special thanks to Sebastian Kremer for suggesting this format.
  78.     See the file pub/gnu/emacs/elisp-archive/lispdir.doc.Z for more
  79.     information about the LCD.
  80.  
  81.     
  82.  
  83. Dave Sill             Dave Brennan      
  84. de5@ornl.gov          brennan@hal.com
  85.  
  86. Elisp Archive Coordinators
  87.