diff options
| author | Stephen Leake | 2014-12-06 02:28:38 -0600 |
|---|---|---|
| committer | Stephen Leake | 2014-12-06 02:38:35 -0600 |
| commit | 952c6c8f00b481cf27aa4d24d86d7a17613cb984 (patch) | |
| tree | fa72caeb9a6569375279c511d77f61be6b8aa543 | |
| parent | 06264b3d247b21be627d1bcd7d928cd3140d249a (diff) | |
| download | emacs-952c6c8f00b481cf27aa4d24d86d7a17613cb984.tar.gz emacs-952c6c8f00b481cf27aa4d24d86d7a17613cb984.zip | |
* CONTRIBUTE: minor improvements
* ChangeLog: cleanup entries for my recent commits
| -rw-r--r-- | CONTRIBUTE | 45 | ||||
| -rw-r--r-- | ChangeLog | 11 |
2 files changed, 33 insertions, 23 deletions
diff --git a/CONTRIBUTE b/CONTRIBUTE index 9c904a798e5..dc6fd71624a 100644 --- a/CONTRIBUTE +++ b/CONTRIBUTE | |||
| @@ -12,7 +12,8 @@ new features to add, please suggest them too -- we might like your | |||
| 12 | idea. Porting to new platforms is also useful, when there is a new | 12 | idea. Porting to new platforms is also useful, when there is a new |
| 13 | platform, but that is not common nowadays. | 13 | platform, but that is not common nowadays. |
| 14 | 14 | ||
| 15 | For documentation on Emacs (to understand how to implement your desired change), refer to: | 15 | For documentation on Emacs (to understand how to implement your |
| 16 | desired change), refer to: | ||
| 16 | 17 | ||
| 17 | - the Emacs Manual | 18 | - the Emacs Manual |
| 18 | http://www.gnu.org/software/emacs/manual/emacs.html | 19 | http://www.gnu.org/software/emacs/manual/emacs.html |
| @@ -42,7 +43,8 @@ There are many ways to contribute to Emacs: | |||
| 42 | - check if existing bug reports are fixed in newer versions of Emacs | 43 | - check if existing bug reports are fixed in newer versions of Emacs |
| 43 | http://debbugs.gnu.org/cgi/pkgreport.cgi?which=pkg&data=emacs | 44 | http://debbugs.gnu.org/cgi/pkgreport.cgi?which=pkg&data=emacs |
| 44 | 45 | ||
| 45 | - develop a package that works with Emacs, and publish it on your own or in Gnu ELPA. | 46 | - develop a package that works with Emacs, and publish it on your own |
| 47 | or in Gnu ELPA (see admin/notes/elpa). | ||
| 46 | 48 | ||
| 47 | Here are some style and legal conventions for contributors to Emacs: | 49 | Here are some style and legal conventions for contributors to Emacs: |
| 48 | 50 | ||
| @@ -67,7 +69,7 @@ Emacs has additional style and coding conventions: | |||
| 67 | 69 | ||
| 68 | - Remove all trailing whitespace in all source and text files. | 70 | - Remove all trailing whitespace in all source and text files. |
| 69 | 71 | ||
| 70 | - Emacs has no convention on whether to use tabs in source code, but | 72 | - Emacs has no convention on whether to use tabs in source code; |
| 71 | please don't change whitespace in the files you edit. | 73 | please don't change whitespace in the files you edit. |
| 72 | 74 | ||
| 73 | - Use ?\s instead of ? in Lisp code for a space character. | 75 | - Use ?\s instead of ? in Lisp code for a space character. |
| @@ -151,7 +153,9 @@ When using git, commit messages should use ChangeLog format, with a | |||
| 151 | single short line explaining the change, then an empty line, then | 153 | single short line explaining the change, then an empty line, then |
| 152 | unindented ChangeLog entries. (Essentially, a commit message should | 154 | unindented ChangeLog entries. (Essentially, a commit message should |
| 153 | be a duplicate of what the patch adds to the ChangeLog files. We are | 155 | be a duplicate of what the patch adds to the ChangeLog files. We are |
| 154 | planning to automate this better, to avoid the duplication.) | 156 | planning to automate this better, to avoid the duplication.) You can |
| 157 | use the Emacs functions log-edit-add-to-changelog or | ||
| 158 | log-edit-insert-changelog to ease this process. | ||
| 155 | 159 | ||
| 156 | ** The patch itself. | 160 | ** The patch itself. |
| 157 | 161 | ||
| @@ -211,14 +215,6 @@ specify the actual author; the committer defaults to you. | |||
| 211 | 215 | ||
| 212 | ** Changelog notes | 216 | ** Changelog notes |
| 213 | 217 | ||
| 214 | - Preferred form for several entries with the same content: | ||
| 215 | |||
| 216 | * help.el (view-lossage): | ||
| 217 | * kmacro.el (kmacro-edit-lossage): | ||
| 218 | * edmacro.el (edit-kbd-macro): Fix docstring, lossage is now 300 keys. | ||
| 219 | |||
| 220 | (Rather than anything involving "ditto" and suchlike.) | ||
| 221 | |||
| 222 | - Emacs generally follows the GNU coding standards when it comes to | 218 | - Emacs generally follows the GNU coding standards when it comes to |
| 223 | ChangeLogs: | 219 | ChangeLogs: |
| 224 | http://www.gnu.org/prep/standards/html_node/Change-Logs.html . One | 220 | http://www.gnu.org/prep/standards/html_node/Change-Logs.html . One |
| @@ -231,6 +227,14 @@ specify the actual author; the committer defaults to you. | |||
| 231 | lowest ChangeLog that is higher than or at the same level as any file | 227 | lowest ChangeLog that is higher than or at the same level as any file |
| 232 | changed by the commit. | 228 | changed by the commit. |
| 233 | 229 | ||
| 230 | - Preferred form for several entries with the same content: | ||
| 231 | |||
| 232 | * help.el (view-lossage): | ||
| 233 | * kmacro.el (kmacro-edit-lossage): | ||
| 234 | * edmacro.el (edit-kbd-macro): Fix docstring, lossage is now 300 keys. | ||
| 235 | |||
| 236 | (Rather than anything involving "ditto" and suchlike.) | ||
| 237 | |||
| 234 | - In ChangeLog files, there is no standard or recommended way to | 238 | - In ChangeLog files, there is no standard or recommended way to |
| 235 | identify revisions. | 239 | identify revisions. |
| 236 | 240 | ||
| @@ -259,8 +263,8 @@ branch. No new features may be added to the trunk after this point, | |||
| 259 | until the release branch is created. This freeze is announced on the | 263 | until the release branch is created. This freeze is announced on the |
| 260 | emacs-devel mailing list, and not anywhere else. | 264 | emacs-devel mailing list, and not anywhere else. |
| 261 | 265 | ||
| 262 | For example, "emacs-23" for Emacs 23.2 and later, "EMACS_23_1_RC" for | 266 | The trunk branch is named "master" in git; release branches are named |
| 263 | 23.1, "EMACS_22_BASE" for 22.x, and "EMACS_21_1_RC" for 21.x. | 267 | "emacs-nn" where "nn" is the major version. |
| 264 | 268 | ||
| 265 | You must follow emacs-devel to know exactly what kinds of changes are | 269 | You must follow emacs-devel to know exactly what kinds of changes are |
| 266 | allowed on what branch at any time. Announcements about the freeze | 270 | allowed on what branch at any time. Announcements about the freeze |
| @@ -270,13 +274,12 @@ If you are fixing a bug that exists in the current release, be sure to | |||
| 270 | commit it to the release branch; it will be merged to the master | 274 | commit it to the release branch; it will be merged to the master |
| 271 | branch later. | 275 | branch later. |
| 272 | 276 | ||
| 273 | The exception is, if you know that the change will be difficult to | 277 | However, if you know that the change will be difficult to merge to the |
| 274 | merge to the trunk (eg because the trunk code has changed a lot). In | 278 | trunk (eg because the trunk code has changed a lot), you can apply the |
| 275 | that case, it's helpful if you can apply the change to both trunk and | 279 | change to both trunk and branch yourself. Indicate in the release |
| 276 | branch yourself. Indicate in the release branch commit log that there | 280 | branch commit log that there is no need to merge the commit to the |
| 277 | is no need to merge the commit to the trunk; start the commit message | 281 | trunk; start the commit message with "Backport:". gitmerge.el will |
| 278 | with "Backport:". This is helpful for the person merging the release | 282 | then exclude that commit from the merge to trunk. |
| 279 | branch to the trunk (it is handled automatically by gitmerge.el). | ||
| 280 | 283 | ||
| 281 | 284 | ||
| 282 | ** Other process information | 285 | ** Other process information |
| @@ -1,6 +1,13 @@ | |||
| 1 | 2014-12-05 Stephen Leake <stephen_leake@stephe-leake.org> | 1 | 2014-12-06 Stephen Leake <stephen_leake@stephe-leake.org> |
| 2 | |||
| 3 | * CONTRIBUTE: improve; add explicit web references, move some info | ||
| 4 | from admin/notes/* here. | ||
| 5 | |||
| 6 | * INSTALL.REPO: You can't "just run make" after a clean checkout. | ||
| 7 | |||
| 8 | * admin/notes/commits: deleted; merged into ./CONTRIBUTE | ||
| 2 | 9 | ||
| 3 | * CONTRIBUTE: improve, move some info from admin/notes/* here. | 10 | * admin/notes/repo: move commit, branch info into ./CONTRIBUTE |
| 4 | 11 | ||
| 5 | 2014-12-05 Stephen Leake <stephen_leake@stephe-leake.org> | 12 | 2014-12-05 Stephen Leake <stephen_leake@stephe-leake.org> |
| 6 | 13 | ||