aboutsummaryrefslogtreecommitdiffstats
path: root/admin/notes
diff options
context:
space:
mode:
authorPaul Eggert2014-11-19 11:29:40 -0800
committerPaul Eggert2014-11-19 11:37:56 -0800
commitcd2e816cd3ebf562c680ed15b53cf2a88a01f14f (patch)
tree40bb4e3db8a0cc25ca29a80a984bcb6b37d49699 /admin/notes
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 'admin/notes')
-rw-r--r--admin/notes/bugtracker6
-rw-r--r--admin/notes/changelogs23
-rw-r--r--admin/notes/copyright6
-rw-r--r--admin/notes/newfile2
-rw-r--r--admin/notes/repo33
5 files changed, 34 insertions, 36 deletions
diff --git a/admin/notes/bugtracker b/admin/notes/bugtracker
index 3d9df200f44..fd7bd08091a 100644
--- a/admin/notes/bugtracker
+++ b/admin/notes/bugtracker
@@ -463,10 +463,10 @@ time, rather than by increasing bug number
463 463
464"raw" = ? 464"raw" = ?
465 465
466** ChangeLog issues 466** Change log issues
467 467
468*** When you fix a bug, it can be helpful to put the bug number in the 468*** When you fix a bug, it can be helpful to put the bug number in the
469ChangeLog entry, for example: 469change log entry, for example:
470 470
471 * foo.el (foofunc): Fix the `foo' case. (Bug#123) 471 * foo.el (foofunc): Fix the `foo' case. (Bug#123)
472 472
@@ -475,7 +475,7 @@ obvious fix (e.g. a typo), there's no need to clutter the log with the
475bug number. 475bug number.
476 476
477Similarly, when you close a bug, it can be helpful to include the 477Similarly, when you close a bug, it can be helpful to include the
478relevant ChangeLog entry in the message to the bug tracker, so people 478relevant change log entry in the message to the bug tracker, so people
479can see exactly what the fix was. 479can see exactly what the fix was.
480 480
481*** bug-reference-mode 481*** bug-reference-mode
diff --git a/admin/notes/changelogs b/admin/notes/changelogs
deleted file mode 100644
index 1025cfc217f..00000000000
--- a/admin/notes/changelogs
+++ /dev/null
@@ -1,23 +0,0 @@
1If installing changes written by someone else, make the ChangeLog
2entry in their name, not yours.
3
4
5http://lists.gnu.org/archive/html/emacs-devel/2007-09/msg00793.html
6 There is no need to make change log entries for files such as NEWS,
7 MAINTAINERS, and FOR-RELEASE.
8"There is no need" means you don't have to, but you can if you want to.
9
10
11http://lists.gnu.org/archive/html/emacs-devel/2006-12/msg01135.html
12 There is no need to indicate regeneration of files such as configure
13 in ChangeLog.
14
15
16http://lists.gnu.org/archive/html/emacs-devel/2008-11/msg00940.html
17Preferred form for several entries with the same content:
18
19 * help.el (view-lossage):
20 * kmacro.el (kmacro-edit-lossage):
21 * edmacro.el (edit-kbd-macro): Fix docstring, lossage is now 300 keys.
22
23(Rather than anything involving "ditto" and suchlike.)
diff --git a/admin/notes/copyright b/admin/notes/copyright
index 74aa73b0394..c5452c38037 100644
--- a/admin/notes/copyright
+++ b/admin/notes/copyright
@@ -22,7 +22,7 @@ author to make a non-trivial total. If so, make sure they have an
22assignment. If adding a whole file adjust the copyright statements in 22assignment. If adding a whole file adjust the copyright statements in
23the file. 23the file.
24 24
252. When installing code written by someone else, the ChangeLog entry 252. When installing code written by someone else, the commit
26should be in the name of the author of the code, not the person who 26should be in the name of the author of the code, not the person who
27installs it. Also use commit's "--author" option. 27installs it. Also use commit's "--author" option.
28Do not install any of your own changes in the same commit. 28Do not install any of your own changes in the same commit.
@@ -115,8 +115,8 @@ else it is possible the file should not be in Emacs at all (please
115report!). 115report!).
116 116
117Note that it seems painfully clear that one cannot rely on commit logs, 117Note that it seems painfully clear that one cannot rely on commit logs,
118or even ChangeLogs, for older changes. People often installed changes 118or even change log entries, for older changes. People often installed
119from others, without recording the true authorship. 119changes from others, without recording the true authorship.
120 120
121[For reference, most of these points were established via email with 121[For reference, most of these points were established via email with
122rms, 2007/1, "Copyright years". 122rms, 2007/1, "Copyright years".
diff --git a/admin/notes/newfile b/admin/notes/newfile
index 0b66b8054bb..a682fec72d5 100644
--- a/admin/notes/newfile
+++ b/admin/notes/newfile
@@ -15,7 +15,7 @@ output under the headings "The following files are not valid DOS file
15names:" and "The following resolve to the same DOS file names:" should 15names:" and "The following resolve to the same DOS file names:" should
16not include any files that end up in the release tarball. 16not include any files that end up in the release tarball.
17 17
18** Make the ChangeLog entry in the name of the author(s), not your own name. 18** Commit in the name of the author(s), not your own name.
19 19
20** If appropriate, check that the file compiles OK and that Emacs 20** If appropriate, check that the file compiles OK and that Emacs
21builds fine with it. Address any compilation warnings. 21builds fine with it. Address any compilation warnings.
diff --git a/admin/notes/repo b/admin/notes/repo
index ded10324f63..46a9e08c698 100644
--- a/admin/notes/repo
+++ b/admin/notes/repo
@@ -1,9 +1,16 @@
1NOTES ON COMMITTING TO EMACS'S REPOSITORY -*- outline -*- 1NOTES ON COMMITTING TO EMACS'S REPOSITORY -*- outline -*-
2 2
3* Use DVCS commenting conventions 3* Commit metainformation
4 4
5Commits should follow the conventions used in all modern distributed 5** Commit in the author's name
6version-control systems. That is, they should consist of 6
7If installing changes written by someone else, commit them in their
8name, not yours.
9
10** Commit message format
11
12Commit messages should follow the conventions used in all modern
13distributed version-control systems. That is, they should consist of
7 14
8- A self-contained topic line, preferably no more than 75 chars long. 15- A self-contained topic line, preferably no more than 75 chars long.
9 16
@@ -15,6 +22,21 @@ version-control systems. That is, they should consist of
15 files, just copy the entries you made in them to the commit message 22 files, just copy the entries you made in them to the commit message
16 after the blank line.) 23 after the blank line.)
17 24
25- Preferred form for several entries with the same content:
26
27 * help.el (view-lossage):
28 * kmacro.el (kmacro-edit-lossage):
29 * edmacro.el (edit-kbd-macro): Fix docstring, lossage is now 300 keys.
30
31 (Rather than anything involving "ditto" and suchlike.)
32
33** Unnecessary metainformation
34
35There is no need to make separate change log entries for files such as
36NEWS, MAINTAINERS, and FOR-RELEASE, or to indicate regeneration of
37files such as 'configure'. "There is no need" means you don't have
38to, but you can if you want to.
39
18* Commit to the right branch 40* Commit to the right branch
19 41
20Development normally takes places on the trunk. 42Development normally takes places on the trunk.
@@ -112,9 +134,9 @@ http://lists.gnu.org/archive/html/emacs-devel/2010-05/msg00262.html
112 134
113[The section on git merge procedure has not yet been written] 135[The section on git merge procedure has not yet been written]
114 136
115Inspect the ChangeLog entries (e.g. in case too many entries have been 137Inspect the change log entries (e.g. in case too many entries have been
116included or whitespace between entries needs fixing). If someone made 138included or whitespace between entries needs fixing). If someone made
117multiple ChangeLog entries on different days in the branch, you may 139multiple change log entries on different days in the branch, you may
118wish to collapse them all to a single entry for that author in the 140wish to collapse them all to a single entry for that author in the
119trunk (because in the trunk they all appear under the same date). 141trunk (because in the trunk they all appear under the same date).
120Obviously, if there are multiple changes to the same file by different 142Obviously, if there are multiple changes to the same file by different
@@ -166,4 +188,3 @@ again.
166 188
167This is a semi-automated way to find the revision that introduced a bug. 189This is a semi-automated way to find the revision that introduced a bug.
168Browse `git help bisect' for technical instructions. 190Browse `git help bisect' for technical instructions.
169