procyberian/emacs
2
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

Clarify in the Emacs manual that ChangeLog files are not used

Browse source 
* 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)
This commit is contained in:
Eli Zaretskii 2018-08-23 20:02:27 +03:00
parent 6e08019af7
commit 51ef6d5576
1 changed files with 5 additions and 5 deletions
Download patch file Download diff file Expand all files Collapse all files

10
doc/emacs/trouble.texi
View file

@ -1162,11 +1162,11 @@ name that indicates whether it is the old version or your new changed
one. one.
@item @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 the extra work of writing them, and to help explain your changes so we
can understand them. 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; changed. So you need to be specific about what functions you changed;
in large functions, it's often helpful to indicate where within the in large functions, it's often helpful to indicate where within the
function the change was. 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 feel that the purpose needs explaining, it probably does---but put the
explanation in comments in the code. It will be more useful there. 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 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, sorts of information to put in, and to learn the style that we use.
unlike some other projects, we do require change logs for Note that, unlike some other projects, we do require commit logs for
documentation, i.e., Texinfo files. documentation, i.e., Texinfo files.
@xref{Change Log}, @xref{Change Log},
@ifset WWW_GNU_ORG @ifset WWW_GNU_ORG