emacs-diffs
[Top][All Lists]
Advanced

[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]

[Emacs-diffs] emacs-26 51ef6d5: Clarify in the Emacs manual that ChangeL


From: Eli Zaretskii
Subject: [Emacs-diffs] emacs-26 51ef6d5: Clarify in the Emacs manual that ChangeLog files are not used
Date: Thu, 23 Aug 2018 13:03:43 -0400 (EDT)

branch: emacs-26
commit 51ef6d5576ac5ae2315619e8c7972585d6526d9b
Author: Eli Zaretskii <address@hidden>
Commit: Eli Zaretskii <address@hidden>

    Clarify in the Emacs manual that ChangeLog files are not used
    
    * doc/emacs/trouble.texi (Sending Patches): Use "commit log"
    instead of "change log", to avoid the interpretation that we
    are talking about literal ChangeLog files.  (Bug#32359)
---
 doc/emacs/trouble.texi | 10 +++++-----
 1 file changed, 5 insertions(+), 5 deletions(-)

diff --git a/doc/emacs/trouble.texi b/doc/emacs/trouble.texi
index 37a7304..bb05378 100644
--- a/doc/emacs/trouble.texi
+++ b/doc/emacs/trouble.texi
@@ -1162,11 +1162,11 @@ name that indicates whether it is the old version or 
your new changed
 one.
 
 @item
-Write the change log entries for your changes.  This is both to save us
+Write the commit log entries for your changes.  This is both to save us
 the extra work of writing them, and to help explain your changes so we
 can understand them.
 
-The purpose of the change log is to show people where to find what was
+The purpose of the commit log is to show people where to find what was
 changed.  So you need to be specific about what functions you changed;
 in large functions, it's often helpful to indicate where within the
 function the change was.
@@ -1177,9 +1177,9 @@ new function, all you need to say about it is that it is 
new.  If you
 feel that the purpose needs explaining, it probably does---but put the
 explanation in comments in the code.  It will be more useful there.
 
-Please look at the change log entries of recent commits to see what
-sorts of information to put in, and to learn the style that we use.  Note that,
-unlike some other projects, we do require change logs for
+Please look at the commit log entries of recent commits to see what
+sorts of information to put in, and to learn the style that we use.
+Note that, unlike some other projects, we do require commit logs for
 documentation, i.e., Texinfo files.
 @xref{Change Log},
 @ifset WWW_GNU_ORG



reply via email to

[Prev in Thread] Current Thread [Next in Thread]