gnustandards standards.texi

[Richard M. Stallman]

CVSROOT:        /sources/gnustandards
Module name:    gnustandards
Changes by:     Richard M. Stallman <rms>       18/10/23 23:59:50

Modified files:
        .              : standards.texi 

Log message:
        (Change Log Concepts): Clariftcation.

CVSWeb URLs:
http://cvs.savannah.gnu.org/viewcvs/gnustandards/standards.texi?cvsroot=gnustandards&r1=1.256&r2=1.257

Patches:
Index: standards.texi
===================================================================
RCS file: /sources/gnustandards/gnustandards/standards.texi,v
retrieving revision 1.256
retrieving revision 1.257
diff -u -b -r1.256 -r1.257
--- standards.texi      7 Mar 2018 19:43:34 -0000       1.256
+++ standards.texi      24 Oct 2018 03:59:50 -0000      1.257
@@ -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 March 7, 2018
address@hidden lastupdate August 3, 2018
 @c %**end of header
 
 @dircategory GNU organization
@@ -3584,12 +3584,16 @@
 is in comments in the code, not in the change log.
 
 If you think that a change calls for explanation of @emph{why} the
-change was needed (what problem the old code had), you're probably
-right.  Please put the explanation in comments in the code, where
-people will see it whenever they see the code.  An example of such an
-explanation is, ``This function used to be iterative, but that failed
-when MUMBLE was a tree.''  (Though such a simple reason would not need
-this kind of explanation.)
+change was needed---that is, what problem the old code had such that
+it required this change---you're probably right.  Please put the
+explanation in comments in the code, where people will see it whenever
+they see the code.  An example of such an explanation is, ``This
+function used to be iterative, but that failed when MUMBLE was a
+tree.''  (Though such a simple reason would not need this kind of
+explanation.)
+
+The best place for other kinds of explanation of the change is in the
+change log entry.
 
 The easiest way to add an entry to @file{ChangeLog} is with the Emacs
 command @kbd{M-x add-change-log-entry}.  An individual change should