summaryrefslogtreecommitdiff
path: root/admin/notes/repo
diff options
context:
space:
mode:
authorEli Zaretskii <eliz@gnu.org>2014-10-31 11:32:11 +0200
committerEli Zaretskii <eliz@gnu.org>2014-10-31 11:32:11 +0200
commitb8ff3a9f989e50efdffa0548055f70fb872304ea (patch)
tree0077e5c9152dd6c86c434f6d842c9da74edb91a6 /admin/notes/repo
parent15d0d8d11bb015f76e83f8d43da7622eff12ff95 (diff)
downloademacs-b8ff3a9f989e50efdffa0548055f70fb872304ea.tar.gz
emacs-b8ff3a9f989e50efdffa0548055f70fb872304ea.tar.bz2
emacs-b8ff3a9f989e50efdffa0548055f70fb872304ea.zip
Minor fixes in the changes in preparation for git migration.
src/Makefile.in (repo-update): Fix a typo and slightly reword commentary. admin/notes/repo (Notes): Reword the stylistic guidance for commit log messages so that they are in line with Emacs development practices and style guidance.
Diffstat (limited to 'admin/notes/repo')
-rw-r--r--admin/notes/repo19
1 files changed, 8 insertions, 11 deletions
diff --git a/admin/notes/repo b/admin/notes/repo
index 858674e6b87..9b5e6ca9417 100644
--- a/admin/notes/repo
+++ b/admin/notes/repo
@@ -5,18 +5,15 @@ NOTES ON COMMITTING TO EMACS'S REPOSITORY -*- outline -*-
Commits should follow the conventions used in all modern distributed
version-control systems. That is, they should consist of
-- A self-contained topic line no more than 75 chars long.
+- A self-contained topic line, preferably no more than 75 chars long.
-- If other content follows the topic line, there should be
- a blank line separating the two.
+- If other content follows the topic line, there should be a blank
+ line separating the two.
-Try to keep your commits - and your commit comments - small. If
-you feel an urge to put a bullet list in your commit comment, it's
-doing too many things at once.
-
-Yes, these directins are a departure from historical Emacs practice,
-but it helps modern log-viewing and summary tools work better so that
-other people can comprehend your code.
+- Follow the blank line with ChangeLog-like entries for the specific
+ changes you made, if any. (As long as Emacs maintains ChangeLog
+ files, just copy the entries you made in them to the commit message
+ after the blank line.)
* Commit to the right branch
@@ -184,7 +181,7 @@ the trunk at all, use `bzr resolve path/to/file --take-this' to keep the
trunk version. Prior to bzr 2.2.3, this may fail. You can just
delete the .OTHER etc files by hand and use bzr resolve path/to/file.
-* Sanity-checking branch merges
+* Sanity-checking branch merges
Inspect the ChangeLog entries (e.g. in case too many entries have been
included or whitespace between entries needs fixing). bzrmerge tries