diff options
Diffstat (limited to 'admin/notes')
| -rw-r--r-- | admin/notes/bugtracker | 26 | ||||
| -rw-r--r-- | admin/notes/git-workflow | 24 | ||||
| -rw-r--r-- | admin/notes/spelling | 11 | ||||
| -rw-r--r-- | admin/notes/unicode | 4 |
4 files changed, 36 insertions, 29 deletions
diff --git a/admin/notes/bugtracker b/admin/notes/bugtracker index c39458184f6..f3bc3045542 100644 --- a/admin/notes/bugtracker +++ b/admin/notes/bugtracker @@ -8,7 +8,7 @@ This is 95% of all you will ever need to know. ** How do I report a bug? Use M-x report-emacs-bug, or send mail to bug-gnu-emacs@gnu.org. -If you want to Cc someone, use an "X-Debbugs-CC" header (or +If you want to Cc someone, use an "X-Debbugs-Cc" header (or pseudo-header, see below) instead. ** How do I comment on a bug? @@ -53,7 +53,7 @@ i) Your report will be assigned a number and generate an automatic reply. ii) Optionally, you can set some database parameters when you first report a bug (see "Setting bug parameters" below). -iii) If you want to CC: someone, use X-Debbugs-CC: (note this only +iii) If you want to Cc someone, use X-Debbugs-Cc: (note this only applies to _new_ reports, not followups). Once your report is filed and assigned a number, it is sent out to the @@ -64,8 +64,8 @@ quiet@debbugs.gnu.org. ** How do I reply to an existing bug report? Reply to 123@debbugs.gnu.org, replacing 123 with the number of the bug you are interested in. NB this only sends mail to the -bug-list, it does NOT send a CC to the original bug submitter. -So you need to explicitly CC him/her (and anyone else you like). +bug-list, it does NOT send a Cc to the original bug submitter. +So you need to explicitly Cc him/her (and anyone else you like). (This works the same way as all the Emacs mailing lists. We generally don't assume anyone who posts to a list is subscribed to it, so we cc everyone on replies.) @@ -95,23 +95,23 @@ normal bug reporting.) ** When reporting a new bug, to send a Cc to another address (e.g. bug-cc-mode@gnu.org), do NOT just use a Cc: header. -Instead, use "X-Debbugs-CC:". This ensures the Cc address(es) will get a +Instead, use "X-Debbugs-Cc:". This ensures the Cc address(es) will get a mail with the bug report number in. If you do not do this, each reply in the subsequent discussion might end up creating a new bug. This is annoying. (So annoying that a form of message-id tracking has been implemented to hopefully stop this happening, but it is still -better to use X-Debbugs-CC.) +better to use X-Debbugs-Cc.) If you want to send copies to more than one address, add them -comma-separated in only one X-Debbugs-CC line. +comma-separated in only one X-Debbugs-Cc line. Like any X-Debbugs- header, this one can also be specified in the pseudo-header (see below), if your mail client does not let you add "X-" headers. -If a new report contains X-Debbugs-CC in the input, this is +If a new report contains X-Debbugs-Cc in the input, this is converted to a real Cc header in the output. (See Bug#1780,5384) -It is also merged into the Resent-CC header (see below). +It is also merged into the Resent-Cc header (see below). ** How does Debbugs send out mails? @@ -120,15 +120,15 @@ header is unchanged. In new reports only (at present), the To: address is altered as follows. Any "bug-gnu-emacs", "emacs-pretest-bug", or "submit@debbugs" address is replaced by 123@debbugs in the mail that gets sent out. (This also applies to any -Cc: header, though you should be using X-Debbugs-CC instead in new +Cc: header, though you should be using X-Debbugs-Cc instead in new reports). The original header is stored as X-Debbugs-Original-To, if -it was changed. Any X-Debbugs-CC is merged into the Cc. +it was changed. Any X-Debbugs-Cc is merged into the Cc. Mails arriving at the bug list have the following Resent-* headers: Resent-From: person who submitted the bug Resent-To: owner@debbugs.gnu.org -Resent-CC: maintainer email address, plus any X-Debbugs-CC: entries +Resent-Cc: maintainer email address, plus any X-Debbugs-Cc: entries The "maintainer email address" is "bug-gnu-emacs@gnu.org" in most cases. @@ -239,7 +239,7 @@ The control server ignores anything after the last line above. So you can place control commands at the beginning of a reply to a bug report, and Bcc: the control server (note the commands have no effect if you just send them to the bug-report number). Bcc: is better than Cc: -in case people use Reply-to-All in response. +in case people use Reply-To-All in response. Some useful control commands: diff --git a/admin/notes/git-workflow b/admin/notes/git-workflow index 83e81c68ef0..54657866ef5 100644 --- a/admin/notes/git-workflow +++ b/admin/notes/git-workflow @@ -19,15 +19,15 @@ Initial setup ============= Then we want to clone the repository. We normally want to have both -the current master and the emacs-25 branch. +the current master and the emacs-26 branch. mkdir ~/emacs cd ~/emacs git clone <membername>@git.sv.gnu.org:/srv/git/emacs.git master (cd master; git config push.default current) -./master/admin/git-new-workdir master emacs-25 -cd emacs-25 -git checkout emacs-25 +./master/admin/git-new-workdir master emacs-26 +cd emacs-26 +git checkout emacs-26 You now have both branches conveniently accessible, and you can do "git pull" in them once in a while to keep updated. @@ -57,11 +57,11 @@ you commit your change locally and then send a patch file as a bug report as described in ../../CONTRIBUTE. -Backporting to emacs-25 +Backporting to emacs-26 ======================= If you have applied a fix to the master, but then decide that it should -be applied to the emacs-25 branch, too, then +be applied to the emacs-26 branch, too, then cd ~/emacs/master git log @@ -71,7 +71,7 @@ which will look like commit 958b768a6534ae6e77a8547a56fc31b46b63710b -cd ~/emacs/emacs-25 +cd ~/emacs/emacs-26 git cherry-pick -xe 958b768a6534ae6e77a8547a56fc31b46b63710b and add "Backport:" to the commit string. Then @@ -79,17 +79,17 @@ and add "Backport:" to the commit string. Then git push -Merging emacs-25 to the master +Merging emacs-26 to the master ============================== It is recommended to use the file gitmerge.el in the admin directory -for merging 'emacs-25' into 'master'. It will take care of many +for merging 'emacs-26' into 'master'. It will take care of many things which would otherwise have to be done manually, like ignoring commits that should not land in master, fixing up ChangeLogs and automatically dealing with certain types of conflicts. If you really want to, you can do the merge manually, but then you're on your own. If you still choose to do that, make absolutely sure that you *always* -use the 'merge' command to transport commits from 'emacs-25' to +use the 'merge' command to transport commits from 'emacs-26' to 'master'. *Never* use 'cherry-pick'! If you don't know why, then you shouldn't manually do the merge in the first place; just use gitmerge.el instead. @@ -102,11 +102,11 @@ up-to-date by doing a pull. Then start Emacs with emacs -l admin/gitmerge.el -f gitmerge You'll be asked for the branch to merge, which will default to -'origin/emacs-25', which you should accept. Merging a local tracking +'origin/emacs-26', which you should accept. Merging a local tracking branch is discouraged, since it might not be up-to-date, or worse, contain commits from you which are not yet pushed upstream. -You will now see the list of commits from 'emacs-25' which are not yet +You will now see the list of commits from 'emacs-26' which are not yet merged to 'master'. You might also see commits that are already marked for "skipping", which means that they will be merged with a different merge strategy ('ours'), which will effectively ignore the diff --git a/admin/notes/spelling b/admin/notes/spelling new file mode 100644 index 00000000000..a63d4bba849 --- /dev/null +++ b/admin/notes/spelling @@ -0,0 +1,11 @@ +Re "behavior" vs "behaviour", etc. + +- GNU Emacs originated in the US. + +- If there is a choice between US vs UK spelling for a word + for new text (code, docs), choose the US variant. + +- It's probably (IMHO --ttn, 2017-10-13) not a high priority to + change existing text; use your best judgement (ask if unsure). + +- http://lists.gnu.org/archive/html/emacs-devel/2005-06/msg00489.html diff --git a/admin/notes/unicode b/admin/notes/unicode index 4240ac1e76d..40f93fc216f 100644 --- a/admin/notes/unicode +++ b/admin/notes/unicode @@ -232,10 +232,6 @@ nontrivial changes to the build process. * iso-2022-7bit - This file switches between CJK charsets, which is not encoded in UTF-8. - - etc/HELLO - Each of these files contains just one CJK charset, but Emacs currently has no easy way to specify set-charset-priority on a per-file basis, so converting any of these files to UTF-8 might |