diff options
| author | Eli Zaretskii | 2014-10-31 11:32:11 +0200 |
|---|---|---|
| committer | Eli Zaretskii | 2014-10-31 11:32:11 +0200 |
| commit | b8ff3a9f989e50efdffa0548055f70fb872304ea (patch) | |
| tree | 0077e5c9152dd6c86c434f6d842c9da74edb91a6 /admin/notes | |
| parent | 15d0d8d11bb015f76e83f8d43da7622eff12ff95 (diff) | |
| download | emacs-b8ff3a9f989e50efdffa0548055f70fb872304ea.tar.gz 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')
| -rw-r--r-- | admin/notes/repo | 19 |
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 -*- | |||
| 5 | Commits should follow the conventions used in all modern distributed | 5 | Commits should follow the conventions used in all modern distributed |
| 6 | version-control systems. That is, they should consist of | 6 | version-control systems. That is, they should consist of |
| 7 | 7 | ||
| 8 | - A self-contained topic line no more than 75 chars long. | 8 | - A self-contained topic line, preferably no more than 75 chars long. |
| 9 | 9 | ||
| 10 | - If other content follows the topic line, there should be | 10 | - If other content follows the topic line, there should be a blank |
| 11 | a blank line separating the two. | 11 | line separating the two. |
| 12 | 12 | ||
| 13 | Try to keep your commits - and your commit comments - small. If | 13 | - Follow the blank line with ChangeLog-like entries for the specific |
| 14 | you feel an urge to put a bullet list in your commit comment, it's | 14 | changes you made, if any. (As long as Emacs maintains ChangeLog |
| 15 | doing too many things at once. | 15 | files, just copy the entries you made in them to the commit message |
| 16 | 16 | after the blank line.) | |
| 17 | Yes, these directins are a departure from historical Emacs practice, | ||
| 18 | but it helps modern log-viewing and summary tools work better so that | ||
| 19 | other people can comprehend your code. | ||
| 20 | 17 | ||
| 21 | * Commit to the right branch | 18 | * Commit to the right branch |
| 22 | 19 | ||
| @@ -184,7 +181,7 @@ the trunk at all, use `bzr resolve path/to/file --take-this' to keep the | |||
| 184 | trunk version. Prior to bzr 2.2.3, this may fail. You can just | 181 | trunk version. Prior to bzr 2.2.3, this may fail. You can just |
| 185 | delete the .OTHER etc files by hand and use bzr resolve path/to/file. | 182 | delete the .OTHER etc files by hand and use bzr resolve path/to/file. |
| 186 | 183 | ||
| 187 | * Sanity-checking branch merges | 184 | * Sanity-checking branch merges |
| 188 | 185 | ||
| 189 | Inspect the ChangeLog entries (e.g. in case too many entries have been | 186 | Inspect the ChangeLog entries (e.g. in case too many entries have been |
| 190 | included or whitespace between entries needs fixing). bzrmerge tries | 187 | included or whitespace between entries needs fixing). bzrmerge tries |