aboutsummaryrefslogtreecommitdiffstats
path: root/admin/notes/repo
diff options
context:
space:
mode:
Diffstat (limited to 'admin/notes/repo')
-rw-r--r--admin/notes/repo33
1 files changed, 27 insertions, 6 deletions
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