diff options
| author | Paul Eggert <eggert@cs.ucla.edu> | 2014-11-19 11:29:40 -0800 |
|---|---|---|
| committer | Paul Eggert <eggert@cs.ucla.edu> | 2014-11-19 11:37:56 -0800 |
| commit | cd2e816cd3ebf562c680ed15b53cf2a88a01f14f (patch) | |
| tree | 40bb4e3db8a0cc25ca29a80a984bcb6b37d49699 /etc | |
| parent | ff953bc93bb41ef573cd6962424ece340ad5a394 (diff) | |
| download | emacs-cd2e816cd3ebf562c680ed15b53cf2a88a01f14f.tar.gz | |
Lessen focus on ChangeLog files, as opposed to change log entries.
This is in preparation for generating the former automatically
from the latter.
* admin/notes/bugtracker, admin/notes/copyright, admin/notes/newfile:
ChangeLog -> change log
* admin/notes/changelogs: Remove, merging old contents to ...
* admin/notes/repo: ... here.
* doc/emacs/maintaining.texi (Change Log): Mention that ChangeLog files may
be copied to or from a version control system.
* doc/emacs/trouble.texi (Sending Patches): Point to the commit messages.
* doc/lispref/intro.texi (Acknowledgments): ChangeLog file -> change log entries.
* doc/lispref/tips.texi (Library Headers): Emacs uses a version control system.
* etc/CONTRIBUTE: Give advice about git commit messages and how
to generate proposed patches containing them.
Diffstat (limited to 'etc')
| -rw-r--r-- | etc/CONTRIBUTE | 16 | ||||
| -rw-r--r-- | etc/ChangeLog | 6 |
2 files changed, 19 insertions, 3 deletions
diff --git a/etc/CONTRIBUTE b/etc/CONTRIBUTE index d1ee9f4690c..b07b6c66afe 100644 --- a/etc/CONTRIBUTE +++ b/etc/CONTRIBUTE @@ -118,13 +118,23 @@ documentation, i.e. Texinfo files. Ref: "Change Log Concepts" node of the GNU Coding Standards Info Manual, for how to write good log entries. +When using git, commit messages should use ChangeLog format, with a +single short line explaining the change, then an empty line, then +unindented ChangeLog entries. (Essentially, a commit message should +be a duplicate of what the patch adds to the ChangeLog files. We are +planning to automate this better, to avoid the duplication.) + ** The patch itself. If you are accessing the Emacs repository, make sure your copy is -up-to-date (e.g. with `git pull'), then use +up-to-date (e.g. with 'git pull'). You can commit your changes +to a private branch and generate a patch from the master version +by using + git format-patch master +Or you can leave your changes uncommitted and use git diff -Else, use - diff -cp OLD NEW +With no repository, you can use + diff -u OLD NEW ** Mail format. diff --git a/etc/ChangeLog b/etc/ChangeLog index 851af7f2735..9f66788d282 100644 --- a/etc/ChangeLog +++ b/etc/ChangeLog @@ -1,3 +1,9 @@ +2014-11-19 Paul Eggert <eggert@cs.ucla.edu> + + Lessen focus on ChangeLog files, as opposed to change log entries. + * CONTRIBUTE: Give advice about git commit messages and how + to generate proposed patches containing them. + 2014-11-13 Paul Eggert <eggert@cs.ucla.edu> Backport fix for minor Bazaar leftovers. |