/[cmucl]/src/contrib/READ-ME.TXT
ViewVC logotype

Contents of /src/contrib/READ-ME.TXT

Parent Directory Parent Directory | Revision Log Revision Log


Revision 1.1 - (show annotations)
Thu Feb 20 18:25:05 1992 UTC (22 years, 2 months ago) by ram
Branch: MAIN
CVS Tags: sparc-tramp-assem-base, double-double-array-base, post-merge-intl-branch, release-19b-pre1, release-19b-pre2, merged-unicode-utf16-extfmt-2009-06-11, double-double-init-sparc-2, unicode-utf16-extfmt-2009-03-27, double-double-base, snapshot-2007-09, snapshot-2007-08, snapshot-2008-08, snapshot-2008-09, ppc_gencgc_snap_2006-01-06, sse2-packed-2008-11-12, snapshot-2008-05, snapshot-2008-06, snapshot-2008-07, snapshot-2007-05, snapshot-2008-01, snapshot-2008-02, snapshot-2008-03, intl-branch-working-2010-02-19-1000, snapshot-2006-11, snapshot-2006-10, double-double-init-sparc, snapshot-2006-12, unicode-string-buffer-impl-base, sse2-base, release-20b-pre1, release-20b-pre2, unicode-string-buffer-base, RELEASE_18d, sse2-packed-base, sparc-tramp-assem-2010-07-19, amd64-dd-start, snapshot-2003-10, snapshot-2004-10, release-18e-base, release-19f-pre1, snapshot-2008-12, snapshot-2008-11, intl-2-branch-base, snapshot-2004-08, snapshot-2004-09, remove_negative_zero_not_zero, snapshot-2007-01, snapshot-2007-02, snapshot-2004-05, snapshot-2004-06, snapshot-2004-07, release-19e, release-19d, GIT-CONVERSION, double-double-init-ppc, release-19c, dynamic-extent-base, unicode-utf16-sync-2008-12, LINKAGE_TABLE, release-19c-base, cross-sol-x86-merged, label-2009-03-16, release-19f-base, PRE_LINKAGE_TABLE, merge-sse2-packed, mod-arith-base, sparc_gencgc_merge, merge-with-19f, snapshot-2004-12, snapshot-2004-11, intl-branch-working-2010-02-11-1000, RELEASE_18a, RELEASE_18b, RELEASE_18c, unicode-snapshot-2009-05, unicode-snapshot-2009-06, amd64-merge-start, ppc_gencgc_snap_2005-12-17, double-double-init-%make-sparc, unicode-utf16-sync-2008-07, release-18e-pre2, unicode-utf16-sync-2008-09, unicode-utf16-extfmts-sync-2008-12, prm-before-macosx-merge-tag, cold-pcl-base, RELEASE_20b, snapshot-2008-04, snapshot-2003-11, snapshot-2005-07, unicode-utf16-sync-label-2009-03-16, RELEASE_19f, snapshot-2007-03, release-20a-base, cross-sol-x86-base, unicode-utf16-char-support-2009-03-26, unicode-utf16-char-support-2009-03-25, release-19a-base, unicode-utf16-extfmts-pre-sync-2008-11, snapshot-2008-10, sparc_gencgc, snapshot-2007-04, snapshot-2010-12, snapshot-2010-11, unicode-utf16-sync-2008-11, snapshot-2007-07, snapshot-2011-09, snapshot-2011-06, snapshot-2011-07, snapshot-2011-04, snapshot-2007-06, snapshot-2011-02, snapshot-2011-03, snapshot-2011-01, snapshot-2003-12, release-19a-pre1, release-19a-pre3, release-19a-pre2, pre-merge-intl-branch, release-19a, UNICODE-BASE, double-double-array-checkpoint, double-double-reader-checkpoint-1, release-19d-base, release-19e-pre1, double-double-irrat-end, release-19e-pre2, snapshot-2010-05, snapshot-2010-04, snapshot-2010-07, snapshot-2010-06, snapshot-2010-01, snapshot-2010-03, snapshot-2010-02, release-19d-pre2, release-19d-pre1, snapshot-2010-08, release-18e, double-double-init-checkpoint-1, double-double-reader-base, label-2009-03-25, snapshot-2005-03, release-19b-base, cross-sol-x86-2010-12-20, double-double-init-x86, sse2-checkpoint-2008-10-01, intl-branch-2010-03-18-1300, snapshot-2005-11, double-double-sparc-checkpoint-1, snapshot-2004-04, sse2-merge-with-2008-11, sse2-merge-with-2008-10, snapshot-2005-10, RELEASE_20a, snapshot-2005-12, release-20a-pre1, snapshot-2005-01, snapshot-2009-11, snapshot-2009-12, unicode-utf16-extfmt-2009-06-11, portable-clx-import-2009-06-16, unicode-utf16-string-support, release-19c-pre1, cross-sparc-branch-base, release-19e-base, intl-branch-base, double-double-irrat-start, snapshot-2005-06, snapshot-2005-05, snapshot-2005-04, ppc_gencgc_snap_2005-05-14, snapshot-2005-02, unicode-utf16-base, portable-clx-base, snapshot-2005-09, snapshot-2005-08, lisp-executable-base, snapshot-2009-08, snapshot-2007-12, snapshot-2007-10, snapshot-2007-11, snapshot-2009-02, snapshot-2009-01, snapshot-2009-07, snapshot-2009-05, snapshot-2009-04, snapshot-2006-02, snapshot-2006-03, release-18e-pre1, snapshot-2006-01, snapshot-2006-06, snapshot-2006-07, snapshot-2006-04, snapshot-2006-05, pre-telent-clx, snapshot-2006-08, snapshot-2006-09, HEAD
Branch point for: release-19b-branch, double-double-reader-branch, double-double-array-branch, mod-arith-branch, RELEASE-19F-BRANCH, portable-clx-branch, sparc_gencgc_branch, cross-sparc-branch, RELEASE-20B-BRANCH, RELENG_18, unicode-string-buffer-branch, sparc-tramp-assem-branch, dynamic-extent, UNICODE-BRANCH, release-19d-branch, ppc_gencgc_branch, sse2-packed-branch, lisp-executable, RELEASE-20A-BRANCH, amd64-dd-branch, double-double-branch, unicode-string-buffer-impl-branch, intl-branch, release-18e-branch, cold-pcl, unicode-utf16-branch, cross-sol-x86-branch, release-19e-branch, sse2-branch, release-19a-branch, release-19c-branch, intl-2-branch, unicode-utf16-extfmt-branch
File MIME type: text/plain
Initial revision
1 DESCRIPTION OF THE CMU COMMON LISP LIBRARY AND CATALOG ENTRY FORMAT.
2
3 The CMU Common Lisp library contains a variety of useful or interesting
4 software packages written by users of CMU Common Lisp. Each entry is contained
5 in its own subdirectory. The CATALOG.TXT describes every entry in the library.
6 Two subdirectories are for library maintainers, library-broken and
7 library-maintenance.
8
9 To submit a program for inclusion in the library, send mail to Gripe
10 pointing to the relevant files and providing the information for the
11 catalog entry in the format described below. The library maintainers will
12 verify that the program runs as documented in the current Lisp, has no
13 crippling bugs, and that the functionality is not duplicated in some other
14 program; then we will add the program to the library. Programs that are
15 made obsolete by later submissions may be dropped from the library, after
16 due notice is given to the user community. Some programs may be deemed so
17 useful that they will be included in the standard CMU Common Lisp system.
18
19 All source files must be included for each software package in the library.
20 Whenever possible, a program should be submitted as a single large file
21 rather than as a collection of smaller files; this will help to minimize
22 version-control problems.
23
24 Note: We plan to distribute this software freely over the Arpanet and we
25 may set up some mechanism to provide non-arpanet users with tapes. We can
26 in general accept only public-domain code (anything with no copyright
27 notice in the source will be assumed to be in the public domain) and code
28 for which Carnegie-Mellon University holds the copyright. If you have any
29 code of commercial value, the copyright system provides little real
30 protection in any case.
31
32 Bugs in library programs not listed in the "bugs" section of the program's
33 description should be reported to the maintainer listed below (or to the
34 author if there is no maintainer), with CC to Gripe.
35
36 Send any questions or comments to Gripe.
37
38
39 CATALOG ENTRY FORMAT FOR CATALOG.TXT.
40
41 Each entry is on a separate page, separated by the page mark Control-L.
42
43 Each entry consists of fields. Each new field begins on a fresh line with a
44 field name terminated by a colon. Then on a new line, indented at least one
45 space, is an arbitrary amount of text. This somewhat rigid format is designed
46 to make it easy to build various sorts of software to automatically manipulate
47 catalogs, but the indentation is simply a convenience for paragraph
48 manipulation and filling commands in the editor. The field names are sensitive
49 to spelling, but insensitive to case and extra whitespace.
50
51 The following is a specification of the possible fields in the catalog format:
52
53 Name: or
54 Module Name:
55 This specifies the name of the program or set of programs. If the supplier
56 of the entry does not specify a Package Name, then this is the package in which
57 the code lives.
58
59 Package Name:
60 If the programs are loaded into a package of their own, this is the name of
61 that package. If the supplier of the entry does not specify a Name or Module
62 Name, the package name will be used as the name for everything.
63
64 Description:
65 This is a brief description of what the program does.
66
67 Author:
68 This is the name of the author, or "anonymous".
69
70 Maintainer:
71 This is the name of the current maintainer, if different from the author.
72 If a program is not being maintained by anyone, the Maintainer is "none".
73
74 Address: or
75 Address of Author: or
76 Address of Maintainer:
77 This is the physical mailing address of the author or maintainer. If the
78 field is just "address", it is assumed to be the maintainer if one is
79 specified, and the author otherwise.
80
81 Net Address: or
82 Net Address of Author: or
83 Net Address of Maintainer:
84 This is a network address that can be reached from the arpanet.
85
86 Copyright Status:
87 This is "Public domain.", or some sort of copyright notice.
88
89 Files:
90 This is a list of the files that constitute this facility. For example, a
91 system named "Foo" may be distributed as files "foo.lisp", "foo.fasl", and
92 (optionally) "foo.doc" or "foo.PS" for documentation. In order to minimize
93 maintenance headaches and encourage people to build on the work of others, we
94 want all programs in the library to include complete sources.
95
96 How to Get:
97 This can either be a shell command using such programs as lcp or cp, or
98 there may be a .cmd file that will copy all the sources, binaries, catalog, and
99 log files to the user's current directory. This .cmd file will try to preserve
100 write date (such as using -p with cp).
101
102 Portability:
103 If the program will run in any legal Common Lisp, say so. If there are
104 known dependencies on CMU Common Lisp specific or Mach/RT specific features,
105 describe them here. Programs relying on CLX, CLOS, etc. should be considered
106 to have a high expectation of portability.
107
108 Dependencies:
109 If the program requires other library packages not built into the standard
110 CMU Common Lisp core image, list those other packages here.
111
112 Instructions:
113 Place here any instructions for use that are too lengthy to be mere
114 documentation strings, but that are not lengthy enough to deserve a separate
115 document.
116
117 Recent Changes:
118 What is different between this version and the one that preceded it, if any.
119 (May go back several versions at the author's discretion.)
120
121 Bugs:
122 Describe here any known bugs or treacherous features.
123
124 Future Plans:
125 Describe here any improvements planned by the author.
126
127 Wish List:
128 Describe here any desirable features that the author does not plan to work
129 on in the near future.
130
131 Notes:
132 This is anything else that users or potential users ought to know about.

  ViewVC Help
Powered by ViewVC 1.1.5