diff options
| author | Dmitry Gutov | 2015-04-16 17:48:32 +0300 |
|---|---|---|
| committer | Dmitry Gutov | 2015-04-16 17:48:32 +0300 |
| commit | 6f0b4d81b94ef392b2a7517db94398f20378f444 (patch) | |
| tree | 29a41874f1efbbd6049f7a1e70fb98d28d1cc180 /CONTRIBUTE | |
| parent | c6e93df20266fe9f8517f14f3b7c367281f988a5 (diff) | |
| download | emacs-6f0b4d81b94ef392b2a7517db94398f20378f444.tar.gz emacs-6f0b4d81b94ef392b2a7517db94398f20378f444.zip | |
; CONTRIBUTE: Further updates
* Better explanation of commit message vs ChangeLog distinction.
* Fix the name of the ChangeLog make task.
* Make instructions WRT NEWS, etc, ChangeLog entries clearer.
Fixes: debbugs:20328
Diffstat (limited to 'CONTRIBUTE')
| -rw-r--r-- | CONTRIBUTE | 20 |
1 files changed, 11 insertions, 9 deletions
diff --git a/CONTRIBUTE b/CONTRIBUTE index e89cfd6f6c7..476b3610cd5 100644 --- a/CONTRIBUTE +++ b/CONTRIBUTE | |||
| @@ -34,9 +34,10 @@ specify the actual author; the committer defaults to you. | |||
| 34 | 34 | ||
| 35 | ** Commit messages | 35 | ** Commit messages |
| 36 | 36 | ||
| 37 | Typically, a patch creates ChangeLog entries by putting them into its | 37 | When a release is prepared, the commit messages are used to generate |
| 38 | commit message, not by changing a ChangeLog file. Here is an example | 38 | the ChangeLog file. So a typical patch does not touch any of the |
| 39 | commit message (indented): | 39 | ChangeLog files in the repository, but contains the ChangeLog entries |
| 40 | in its message. Here is an example commit message (indented): | ||
| 40 | 41 | ||
| 41 | Deactivate shifted region | 42 | Deactivate shifted region |
| 42 | 43 | ||
| @@ -127,15 +128,16 @@ The general format is as follows. | |||
| 127 | "2014-01-16T05:43:35Z!esr@thyrsus.com". Often, "my previous commit" | 128 | "2014-01-16T05:43:35Z!esr@thyrsus.com". Often, "my previous commit" |
| 128 | will suffice. | 129 | will suffice. |
| 129 | 130 | ||
| 130 | - There is no need to make separate ChangeLog entries for files such | 131 | - There is no need to mention files such as NEWS, MAINTAINERS, and |
| 131 | as NEWS, MAINTAINERS, and FOR-RELEASE, or to indicate regeneration | 132 | FOR-RELEASE, or to indicate regeneration of files such as |
| 132 | of files such as 'configure'. "There is no need" means you don't | 133 | 'configure', in the ChangeLog entry. "There is no need" means you |
| 133 | have to, but you can if you want to. | 134 | don't have to, but you can if you want to. |
| 134 | 135 | ||
| 135 | - If a commit message's first line starts with "; ", the message is | 136 | - If a commit message's first line starts with "; ", the message is |
| 136 | ignored when generating ChangeLog history files via 'make changelog' | 137 | ignored when generating ChangeLog history files via 'make ChangeLog' |
| 137 | or via 'make change-history'. You can use "; " for minor commits | 138 | or via 'make change-history'. You can use "; " for minor commits |
| 138 | that do not need separate ChangeLog entries. | 139 | that do not need separate ChangeLog entries, as well as commits that |
| 140 | only modify files that don't need these entries at all. | ||
| 139 | 141 | ||
| 140 | ** Generating ChangeLog entries | 142 | ** Generating ChangeLog entries |
| 141 | 143 | ||