aboutsummaryrefslogtreecommitdiffstats
path: root/etc
diff options
context:
space:
mode:
authorPaul Eggert2014-11-19 11:29:40 -0800
committerPaul Eggert2014-11-19 11:37:56 -0800
commitcd2e816cd3ebf562c680ed15b53cf2a88a01f14f (patch)
tree40bb4e3db8a0cc25ca29a80a984bcb6b37d49699 /etc
parentff953bc93bb41ef573cd6962424ece340ad5a394 (diff)
downloademacs-cd2e816cd3ebf562c680ed15b53cf2a88a01f14f.tar.gz
emacs-cd2e816cd3ebf562c680ed15b53cf2a88a01f14f.zip
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/CONTRIBUTE16
-rw-r--r--etc/ChangeLog6
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.
118Ref: "Change Log Concepts" node of the GNU Coding Standards Info 118Ref: "Change Log Concepts" node of the GNU Coding Standards Info
119Manual, for how to write good log entries. 119Manual, for how to write good log entries.
120 120
121When using git, commit messages should use ChangeLog format, with a
122single short line explaining the change, then an empty line, then
123unindented ChangeLog entries. (Essentially, a commit message should
124be a duplicate of what the patch adds to the ChangeLog files. We are
125planning to automate this better, to avoid the duplication.)
126
121** The patch itself. 127** The patch itself.
122 128
123If you are accessing the Emacs repository, make sure your copy is 129If you are accessing the Emacs repository, make sure your copy is
124up-to-date (e.g. with `git pull'), then use 130up-to-date (e.g. with 'git pull'). You can commit your changes
131to a private branch and generate a patch from the master version
132by using
133 git format-patch master
134Or you can leave your changes uncommitted and use
125 git diff 135 git diff
126Else, use 136With no repository, you can use
127 diff -cp OLD NEW 137 diff -u OLD NEW
128 138
129** Mail format. 139** Mail format.
130 140
diff --git a/etc/ChangeLog b/etc/ChangeLog
index 851af7f2735..9f66788d282 100644
--- a/etc/ChangeLog
+++ b/etc/ChangeLog
@@ -1,3 +1,9 @@
12014-11-19 Paul Eggert <eggert@cs.ucla.edu>
2
3 Lessen focus on ChangeLog files, as opposed to change log entries.
4 * CONTRIBUTE: Give advice about git commit messages and how
5 to generate proposed patches containing them.
6
12014-11-13 Paul Eggert <eggert@cs.ucla.edu> 72014-11-13 Paul Eggert <eggert@cs.ucla.edu>
2 8
3 Backport fix for minor Bazaar leftovers. 9 Backport fix for minor Bazaar leftovers.