aboutsummaryrefslogtreecommitdiffstats
path: root/admin
diff options
context:
space:
mode:
authorGlenn Morris2016-05-24 08:59:09 -0700
committerGlenn Morris2016-05-24 08:59:09 -0700
commitbdfbe6deff52bbf820b0fa1a5ea78b89963e5738 (patch)
tree729c987fa43bb33e0252a2ba05ff77bc5fb0e546 /admin
parent44a6aed33fdde11d4a0a2eb4aa5e91b6b5a23347 (diff)
downloademacs-bdfbe6deff52bbf820b0fa1a5ea78b89963e5738.tar.gz
emacs-bdfbe6deff52bbf820b0fa1a5ea78b89963e5738.zip
; * admin/release-process: Copyedits.
Diffstat (limited to 'admin')
-rw-r--r--admin/release-process69
1 files changed, 37 insertions, 32 deletions
diff --git a/admin/release-process b/admin/release-process
index 3f75ff52ca4..410116becb4 100644
--- a/admin/release-process
+++ b/admin/release-process
@@ -7,7 +7,7 @@ Each release cycle will be split into two periods.
7** Phase one: development 7** Phase one: development
8 8
9The first phase of the release schedule is the "heads-down" working 9The first phase of the release schedule is the "heads-down" working
10period for new features, on the 'master' branch and several feature 10period for new features, on the 'master' branch and any needed feature
11branches. 11branches.
12 12
13** Phase two: fixing and stabilizing the release branch 13** Phase two: fixing and stabilizing the release branch
@@ -29,46 +29,61 @@ command to do that, then commit the changes it made and push to
29'master'. For major releases, also update the value of 29'master'. For major releases, also update the value of
30'customize-changed-options-previous-release'. 30'customize-changed-options-previous-release'.
31 31
32The 2 main manuals, the User Manual and the Emacs Lisp Manual, need to 32Each chapter of the two main manuals, the User Manual and the Emacs
33be proofread, preferably by at least 2 different persons, and any 33Lisp Manual, should be proofread, preferably by at least two people.
34uncovered problems fixed. This is a lot of work, so it is advisable 34This job is so big that it should be considered a collective
35to divide the job between several people (see the checklist near the 35responsibility, not fobbed off on just a few people. After each
36end of this file). 36chapter is checked, mark off the name(s) of those who checked it in
37the checklist near the end of this file.
37 38
38In parallel to this phase, 'master' can receive new features, to be 39In parallel to this phase, 'master' can receive new features, to be
39released in the next release cycle. From time to time, the master 40released in the next release cycle. From time to time, the master
40branches merges bugfix commits from the "emacs-NN" branch. 41branches merges bugfix commits from the "emacs-NN" branch.
42See admin/gitmerge.el.
41 43
42* RELEASE-CRITICAL BUGS 44* RELEASE-CRITICAL BUGS
43 45
44Emacs uses the "blocking bug(s)" feature of Debbugs for bugs need to 46Emacs uses the "blocking" feature of Debbugs for bugs that need to be
45be addressed in the next release. 47addressed in the next release.
46 48
47Currently, bug#19759 is the tracking bug for release of 25.1. Say 49Currently, bug#19759 is the tracking bug for release of 25.1 and
48bug#123 needs to be fixed for Emacs 25.1. Send a message to 50bug#21966 is the tracking bug for the next release. Say bug#123 needs
49control@debbugs.gnu.org that says: 51to be fixed for Emacs 25.1. Send a message to control@debbugs.gnu.org
52that says:
50 53
51 block 19759 by 123 54 block 19759 by 123
52 55
53Change "block" to "unblock" to unblock the bug. 56Change "block" to "unblock" to remove a bug from the list. Closed
57bugs are not listed as blockers, so you do not need to explicitly
58unblock one that has been closed. You may need to force an update of
59the tracking bug with ctrl-f5/shift-reload to see the latest version.
60
54 61
55* TO BE DONE SHORTLY BEFORE RELEASE 62* TO BE DONE SHORTLY BEFORE RELEASE
56 63
57** Make sure the Copyright date reflects the current year in the source 64See 'admin/make-tarball.txt' for the details of making a release or pretest.
58files. See 'admin/notes/years' for information about maintaining 65
59copyright years for GNU Emacs. 66** Make sure the Copyright date reflects the current year in all source files.
67(This should be done each January anyway, regardless of releases.)
68See admin/update-copyright and admin.el's set-copyright.
69For more details, see 'admin/notes/years'.
60 70
61** Make sure the necessary sources and scripts for any generated files 71** Make sure the necessary sources and scripts for any generated files
62are included in the source tarball. (They don't need to be installed, 72are included in the source tarball. (They don't need to be installed,
63so e.g. admin/ is fine.) 73so e.g. admin/ is fine.) This is important for legal compliance.
64
65** Regenerate AUTHORS by using admin/authors.el
66(The instructions are at the beginning of that file.)
67 74
68** Remove temporary +++/--- lines in NEWS. 75** Remove temporary +++/--- lines in NEWS.
69But first make sure there are no unmarked entries, and update the 76But first make sure there are no unmarked entries, and update the
70documentation (or decide no updates are necessary) for those that 77documentation (or decide no updates are necessary) for those that aren't.
71aren't. 78
79** Try to reorder NEWS: most important things first, related items together.
80
81** For a major release, add a "New in Emacs XX" section to faq.texi.
82
83** cusver-check from admin.el can help find new defcustoms missing
84:version tags.
85
86** Add a line to etc/HISTORY for the release version number and date.
72 87
73** Manuals 88** Manuals
74Check for node names using problematic characters: 89Check for node names using problematic characters:
@@ -84,8 +99,7 @@ For major releases, rewrite the "Antinews" appendix of the User Manual
84previous version. The way to do that is read NEWS, pick up the more 99previous version. The way to do that is read NEWS, pick up the more
85significant changes and new features in the upcoming release, then 100significant changes and new features in the upcoming release, then
86describe the "benefits" from losing those features. Be funny, use 101describe the "benefits" from losing those features. Be funny, use
87humor. The text written for the previous major release can serve as 102humor. The text written for the previous releases can serve as an example.
88good example.
89 103
90Check cross-references between the manuals (e.g. from emacs to elisp) 104Check cross-references between the manuals (e.g. from emacs to elisp)
91are correct. You can use something like the following in the info 105are correct. You can use something like the following in the info
@@ -146,10 +160,6 @@ size that the GNU Press are going to use when they print the manuals.
146I think this is different to what you get if you just use e.g. 'make 160I think this is different to what you get if you just use e.g. 'make
147emacs.pdf' (e.g., enable "smallbook"). 161emacs.pdf' (e.g., enable "smallbook").
148 162
149** Try to reorder NEWS: most important things first, related items together.
150
151** For a major release, add a "New in Emacs XX" section to faq.texi.
152
153** Check the keybindings in the refcards are correct, and add any new ones. 163** Check the keybindings in the refcards are correct, and add any new ones.
154What paper size are the English versions supposed to be on? 164What paper size are the English versions supposed to be on?
155On Debian testing, the packages texlive-lang-czechslovak and 165On Debian testing, the packages texlive-lang-czechslovak and
@@ -171,11 +181,6 @@ pt-br Rodrigo Real
171ru Alex Ott 181ru Alex Ott
172sk Miroslav Vaško 182sk Miroslav Vaško
173 183
174** cusver-check from admin.el can help find new defcustoms missing
175:version tags.
176
177** Add a line to etc/HISTORY for the release version number and date.
178
179* BUGS 184* BUGS
180 185
181** Check for modes which bind M-s that conflicts with a new global binding M-s 186** Check for modes which bind M-s that conflicts with a new global binding M-s