aboutsummaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorEli Zaretskii2015-11-18 21:33:12 +0200
committerEli Zaretskii2015-11-18 21:33:12 +0200
commit9328e3d0ea374ab2d99a311cbf6f9db75cf718bf (patch)
tree952b1024f1d9c392337bdb5edf0388ada86ff107
parent955e25dbcd0519d115f58b275923a71c04579e83 (diff)
downloademacs-9328e3d0ea374ab2d99a311cbf6f9db75cf718bf.tar.gz
emacs-9328e3d0ea374ab2d99a311cbf6f9db75cf718bf.zip
; * admin/release-process: Minor copyedits and additions.
-rw-r--r--admin/release-process71
1 files changed, 46 insertions, 25 deletions
diff --git a/admin/release-process b/admin/release-process
index c403698079d..d0b55badab0 100644
--- a/admin/release-process
+++ b/admin/release-process
@@ -10,21 +10,31 @@ The 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 several feature
11branches. 11branches.
12 12
13** Phase two: bugfixes 13** Phase two: fixing and stabilizing the release branch
14 14
15Shortly before this phase, Emacs developers will be devoted to 15Shortly before this phase, Emacs developers will be devoted to
16figuring out what features to include in the next release and what 16figuring out what features to include in the next release and what
17features to defer to a later release. 17features to defer to a later release.
18 18
19At the beginning of this phase, a release branch called "emacs-NN" 19This phase is mostly spent fixing bugs and documenting new features
20("NN" represents the major version number of the new Emacs release) 20and changes on the "emacs-NN" branch. Actually, the default branch
21will be cut from `master'.
22
23This phase is mostly spent fixing bugs and eliminating undocumented
24new features on the "emacs-NN" branch. Actually, the default branch
25for pushing any work in this phase should be "emacs-NN", except for 21for pushing any work in this phase should be "emacs-NN", except for
26new features. 22new features.
27 23
24At the beginning of this phase, a release branch called "emacs-NN"
25("NN" represents the major version number of the new Emacs release)
26will be cut from `master'. When that happens, the version number on
27`master' should be incremented; use admin/admin.el's `set-version'
28command to do that, then commit the changes it made and push to
29`master'. For major releases, also update the value of
30`customize-changed-options-previous-release'.
31
32The 2 main manuals, the User Manual and the Emacs Lisp Manual, need to
33be proofread, preferably by at least 2 different persons, and any
34uncovered problems fixed. This is a lot of work, so it is advisable
35to divide the job between several people (see the checklist near the
36end of this file).
37
28In parallel to this phase, `master' can receive new features, to be 38In parallel to this phase, `master' can receive new features, to be
29released in the next release cycle. From time to time, the master 39released in the next release cycle. From time to time, the master
30branches merges bugfix commits from the "emacs-NN" branch. 40branches merges bugfix commits from the "emacs-NN" branch.
@@ -49,8 +59,16 @@ files. See `admin/notes/years' for information about maintaining
49copyright years for GNU Emacs. 59copyright years for GNU Emacs.
50 60
51** Make sure the necessary sources and scripts for any generated files 61** Make sure the necessary sources and scripts for any generated files
52are included in the source tarfile. (They don't need to be installed, 62are included in the source tarball. (They don't need to be installed,
53so eg admin/ is fine.) 63so e.g. admin/ is fine.)
64
65** Regenerate AUTHORS by using admin/authors.el
66(The instructions are at the beginning of that file.)
67
68** Remove temporary +++/--- lines in NEWS.
69But first make sure there are no unmarked entries, and update the
70documentation (or decide no updates are necessary) for those that
71aren't.
54 72
55** Manuals 73** Manuals
56Check for node names using problematic characters: 74Check for node names using problematic characters:
@@ -61,7 +79,15 @@ Check for major new features added since the last release (e.g. new
61lisp files), and add the relevant authors to the Acknowledgments in 79lisp files), and add the relevant authors to the Acknowledgments in
62doc/emacs/ack.texi and emacs.texi. 80doc/emacs/ack.texi and emacs.texi.
63 81
64Check cross-references between the manuals (eg from emacs to elisp) 82For major releases, rewrite the "Antinews" appendix of the User Manual
83(doc/emacs/anti.texi) to describe features lost by downgrading to the
84previous version. The way to do that is read NEWS, pick up the more
85significant changes and new features in the upcoming release, then
86describe the "benefits" from losing those features. Be funny, use
87humor. The text written for the previous major release can serve as
88good example.
89
90Check cross-references between the manuals (e.g. from emacs to elisp)
65are correct. You can use something like the following in the info 91are correct. You can use something like the following in the info
66directory in the Emacs build tree: 92directory in the Emacs build tree:
67 93
@@ -79,32 +105,31 @@ Redirect /software/emacs/manual/html_node/automake/ /software/automake/manual/ht
79Another tool you can use to check links is gnu.org's linc.py: 105Another tool you can use to check links is gnu.org's linc.py:
80http://www.gnu.org/server/source/ 106http://www.gnu.org/server/source/
81 107
82You run this something like: 108You run this with something like:
83 109
84cd /path/to/cvs/emacs-www 110cd /path/to/cvs/emacs-www
85linc.py -o /path/to/output-dir --url http://www.gnu.org/software/emacs/ . 111linc.py -o /path/to/output-dir --url http://www.gnu.org/software/emacs/ .
86 112
87Be warned that it is really, really slow (as in, can take ~ a full day 113Be warned that it is really, really slow (as in, can take ~ a full day
88to check the manual/ directory). It is probably best to run it on a 114to check the manual/ directory). It is probably best to run it on a
89single directory at a time from eg manual/html_node. It is very 115single directory at a time from e.g. manual/html_node. It is very
90inefficient, but may reveal a few things that info-xref does not. 116inefficient, but may reveal a few things that info-xref does not.
91 117
92
93make emacs.dvi, elisp.dvi, and deal with any errors (undefined 118make emacs.dvi, elisp.dvi, and deal with any errors (undefined
94references etc) in the output. Break any overfull lines. 119references etc) in the output. Break any overfull lines.
95Underfull hboxes are not serious, but it can be nice to get rid of 120Underfull hboxes are not serious, but it can be nice to get rid of
96them if a simple rephrasing or rearrangement will work. 121them if a simple rephrasing or rearrangement will work.
97 122
98Update the master menu and detailed menu (eg the antinews version). 123Update the master menu and detailed menu (e.g. the antinews version).
99The command texinfo-multiple-files-update can do this, but you 124The command texinfo-multiple-files-update can do this, but you
100probably want to apply the results selectively (eg the current master 125probably want to apply the results selectively (e.g. the current master
101menu has better line-breaks than the automatic version). It includes 126menu has better line-breaks than the automatic version). It includes
102the menu-entry name (if there is one) as well as the node name - using 127the menu-entry name (if there is one) as well as the node name - using
103only the latter looks better. Also, it doesn't seem to handle nested 128only the latter looks better. Also, it doesn't seem to handle nested
104includes, so will miss edebug.texi etc. 129includes, so will miss edebug.texi etc.
105 130
106Check for widow and orphan lines in the printed manual; make sure all 131Check for widow and orphan lines in the printed manual; make sure all
107the pages really look ok in the manual as formatted. Orphans/widows 132the pages really look OK in the manual as formatted. Orphans/widows
108are cases where the first/last line of a paragraph is on its own at 133are cases where the first/last line of a paragraph is on its own at
109the end/start of a page, or where the last word in a paragraph is on 134the end/start of a page, or where the last word in a paragraph is on
110its own at the start of a line. It looks better if you reword/respace 135its own at the start of a line. It looks better if you reword/respace
@@ -118,9 +143,13 @@ pages of the manuals, and even if they do, the resulting page breaks
118depend on what paper and font size they use. This also means that if 143depend on what paper and font size they use. This also means that if
119you _are_ going to do this, it should be done with the paper and font 144you _are_ going to do this, it should be done with the paper and font
120size that the GNU Press are going to use when they print the manuals. 145size that the GNU Press are going to use when they print the manuals.
121I think this is different to what you get if you just use eg 'make 146I think this is different to what you get if you just use e.g. 'make
122emacs.pdf' (e.g., enable "smallbook"). 147emacs.pdf' (e.g., enable "smallbook").
123 148
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
124** Check the keybindings in the refcards are correct, and add any new ones. 153** Check the keybindings in the refcards are correct, and add any new ones.
125What paper size are the English versions supposed to be on? 154What paper size are the English versions supposed to be on?
126On Debian testing, the packages texlive-lang-czechslovak and 155On Debian testing, the packages texlive-lang-czechslovak and
@@ -142,14 +171,6 @@ pt-br Rodrigo Real
142ru Alex Ott 171ru Alex Ott
143sk Miroslav Vaško 172sk Miroslav Vaško
144 173
145** For a major release, add a "New in Emacs XX" section to faq.texi.
146
147** Remove temporary +++/--- lines in NEWS.
148
149** Try to reorder NEWS: most important things first, related items together.
150
151** Consider bumping customize-changed-options-previous-release.
152
153** cusver-check from admin.el can help find new defcustoms missing 174** cusver-check from admin.el can help find new defcustoms missing
154:version tags. 175:version tags.
155 176