gnustandards ChangeLog standards.texi

[karl]

CVSROOT:        /sources/gnustandards
Module name:    gnustandards
Changes by:     karl <karl>     12/10/27 18:59:59

Modified files:
        .              : ChangeLog standards.texi 

Log message:
        put README items in a list

CVSWeb URLs:
http://cvs.savannah.gnu.org/viewcvs/gnustandards/ChangeLog?cvsroot=gnustandards&r1=1.169&r2=1.170
http://cvs.savannah.gnu.org/viewcvs/gnustandards/standards.texi?cvsroot=gnustandards&r1=1.218&r2=1.219

Patches:
Index: ChangeLog
===================================================================
RCS file: /sources/gnustandards/gnustandards/ChangeLog,v
retrieving revision 1.169
retrieving revision 1.170
diff -u -b -r1.169 -r1.170
--- ChangeLog   27 Oct 2012 18:44:47 -0000      1.169
+++ ChangeLog   27 Oct 2012 18:59:59 -0000      1.170
@@ -1,5 +1,8 @@
 2012-10-27  Karl Berry  <address@hidden>
 
+       * standards.texi (Releases): make the items that should be in the
+       README into a list, since there are quite a few of them.
+
        * maintain.texi (Manuals on Web Pages): no point in PostScript
        output specifically these days, given PDF.
 

Index: standards.texi
===================================================================
RCS file: /sources/gnustandards/gnustandards/standards.texi,v
retrieving revision 1.218
retrieving revision 1.219
diff -u -b -r1.218 -r1.219
--- standards.texi      30 Jun 2012 15:35:01 -0000      1.218
+++ standards.texi      27 Oct 2012 18:59:59 -0000      1.219
@@ -3,7 +3,7 @@
 @setfilename standards.info
 @settitle GNU Coding Standards
 @c This date is automagically updated when you save this file:
address@hidden lastupdate June 30, 2012
address@hidden lastupdate October 27, 2012
 @c %**end of header
 
 @dircategory GNU organization
@@ -4063,6 +4063,7 @@
 @section Making Releases
 @cindex packaging
 
address@hidden version numbers, for releases
 You should identify each release with a pair of version numbers, a
 major version and a minor.  We have no objection to using more than
 two numbers, but it is very unlikely that you really need them.
@@ -4079,20 +4080,28 @@
 source files by programs under the control of the Makefile.
 
 @cindex @file{README} file
-The distribution should contain a file named @file{README} which gives
-the name of the package, and a general description of what it does.  It
-is also good to explain the purpose of each of the first-level
-subdirectories in the package, if there are any.  The @file{README} file
-should either state the version number of the package, or refer to where
-in the package it can be found.
-
-The @file{README} file should refer to the file @file{INSTALL}, which
-should contain an explanation of the installation procedure.
-
-The @file{README} file should also refer to the file which contains the
-copying conditions.  The GNU GPL, if used, should be in a file called
address@hidden  If the GNU LGPL is used, it should be in a file called
+The distribution should contain a file named @file{README} with a
+general overview of the package:
+
address@hidden
address@hidden the name of the package;
+
address@hidden the version number of the package, or refer to where in the
+package the version can be found;
+
address@hidden a general description of what the package does;
+
address@hidden a reference to the the file @file{INSTALL}, which
+should in turn contain an explanation of the installation procedure;
+
address@hidden a brief explanation of any unusual top-level directories or
+files, or other hints for readers to find their way around the source;
+
address@hidden a reference to the file which contains the copying conditions.
+The GNU GPL, if used, should be in a file called @file{COPYING}.  If
+the GNU LGPL is used, it should be in a file called
 @file{COPYING.LESSER}.
address@hidden itemize
 
 Naturally, all the source files must be in the distribution.  It is
 okay to include non-source files in the distribution along with the
@@ -4100,9 +4109,10 @@
 with the source they are made from, and machine-independent, so that
 normal building of the distribution will never modify them.  We
 commonly include non-source files produced by Autoconf, Automake,
-Bison, @code{lex}, @TeX{}, and @code{makeinfo}; this helps avoid
+Bison, @code{flex}, @TeX{}, and @code{makeinfo}; this helps avoid
 unnecessary dependencies between our distributions, so that users can
-install whichever packages they want to install.
+install whichever versions of whichever packages they like.  Do not
+induce new dependencies on other software lightly.
 
 Non-source files that might actually be modified by building and
 installing the program should @strong{never} be included in the