aboutsummaryrefslogtreecommitdiffstats
path: root/admin/release-process
diff options
context:
space:
mode:
authorXue Fuqiao2015-11-15 09:32:12 +0800
committerXue Fuqiao2015-11-18 08:41:15 +0800
commit20b043f97cdbde072b04469bd8f56b57301be34b (patch)
treecebc179379deb3dbb6a9b8e0b67645d5f8aa87d3 /admin/release-process
parentcfedd5582093457d4fd3d2545e3c6f9c1d8933db (diff)
downloademacs-20b043f97cdbde072b04469bd8f56b57301be34b.tar.gz
emacs-20b043f97cdbde072b04469bd8f56b57301be34b.zip
Backport: * admin/release-process: Rename from admin/FOR-RELEASE.
(cherry picked from commit f8cc14b59700e51a4e31139c0a65c8154995e055)
Diffstat (limited to 'admin/release-process')
-rw-r--r--admin/release-process282
1 files changed, 282 insertions, 0 deletions
diff --git a/admin/release-process b/admin/release-process
new file mode 100644
index 00000000000..286b90ea528
--- /dev/null
+++ b/admin/release-process
@@ -0,0 +1,282 @@
1Tasks needed before the next release.
2
3* TO BE DONE SHORTLY BEFORE RELEASE
4
5** Make sure the necessary sources and scripts for any generated files
6are included in the source tarfile. (They don't need to be installed,
7so eg admin/ is fine.)
8
9** Manuals
10Check for node names using problematic characters:
11 find doc -name '*.texi' -exec grep '^@node[^,]*[:.()]' {} +
12Sadly makeinfo does not warn about such characters.
13
14Check for major new features added since the last release (e.g. new
15lisp files), and add the relevant authors to the Acknowledgments in
16doc/emacs/ack.texi and emacs.texi.
17
18Check cross-references between the manuals (eg from emacs to elisp)
19are correct. You can use something like the following in the info
20directory in the Emacs build tree:
21
22emacs -Q --eval "(progn (require 'info) (setq Info-directory-list '(\".\")))" \
23 -f info-xref-check-all
24
25Setting Info-directory-list avoids having system info pages confuse
26things. References to external manuals will be flagged as
27uncheckable. You should still check these, and also that each
28external manual has an appropriate redirect in the file manual/.htaccess
29in the web pages repository. E.g.:
30Redirect /software/emacs/manual/html_mono/automake.html /software/automake/manual/automake.html
31Redirect /software/emacs/manual/html_node/automake/ /software/automake/manual/html_node/
32
33Another tool you can use to check links is gnu.org's linc.py:
34http://www.gnu.org/server/source/
35
36You run this something like:
37
38cd /path/to/cvs/emacs-www
39linc.py -o /path/to/output-dir --url http://www.gnu.org/software/emacs/ .
40
41Be warned that it is really, really slow (as in, can take ~ a full day
42to check the manual/ directory). It is probably best to run it on a
43single directory at a time from eg manual/html_node. It is very
44inefficient, but may reveal a few things that info-xref does not.
45
46
47make emacs.dvi, elisp.dvi, and deal with any errors (undefined
48references etc) in the output. Break any overfull lines.
49Underfull hboxes are not serious, but it can be nice to get rid of
50them if a simple rephrasing or rearrangement will work.
51
52Update the master menu and detailed menu (eg the antinews version).
53The command texinfo-multiple-files-update can do this, but you
54probably want to apply the results selectively (eg the current master
55menu has better line-breaks than the automatic version). It includes
56the menu-entry name (if there is one) as well as the node name - using
57only the latter looks better. Also, it doesn't seem to handle nested
58includes, so will miss edebug.texi etc.
59
60Check for widow and orphan lines in the printed manual; make sure all
61the pages really look ok in the manual as formatted. Orphans/widows
62are cases where the first/last line of a paragraph is on its own at
63the end/start of a page, or where the last word in a paragraph is on
64its own at the start of a line. It looks better if you reword/respace
65things to avoid these. (AFAIK, there is no way to find these except
66paging through the whole manual.) This should be the very last thing
67you do, since any change can alter the layout.
68(Actually, there is probably little point in trying to do this.
69It's only really relevant if printed versions of the manuals are going
70to be published. End-users are not likely to print out all 1000+
71pages of the manuals, and even if they do, the resulting page breaks
72depend on what paper and font size they use. This also means that if
73you _are_ going to do this, it should be done with the paper and font
74size that the GNU Press are going to use when they print the manuals.
75I think this is different to what you get if you just use eg 'make
76emacs.pdf' (e.g., enable "smallbook").
77
78** Check the keybindings in the refcards are correct, and add any new ones.
79What paper size are the English versions supposed to be on?
80On Debian testing, the packages texlive-lang-czechslovak and
81texlive-lang-polish will let you generate the cs-* and sk-* pdfs.
82(You may need texlive-lang-cyrillic, texlive-lang-german for others.)
83The Makefile rules did not work for me, I had to use something like:
84csplain -output-format=pdf cs-refcard
85
86** Ask maintainers of refcard translations to update them.
87
88Emacs 22 translators:
89
90LANG Translator Status
91cs Pavel Janík
92de Sven Joachim
93fr Eric Jacoboni
94pl Włodek Bzyl
95pt-br Rodrigo Real
96ru Alex Ott
97sk Miroslav Vaško
98
99** For a major release, add a "New in Emacs XX" section to faq.texi.
100
101** Remove temporary +++/--- lines in NEWS.
102
103** Try to reorder NEWS: most important things first, related items together.
104
105** Consider bumping customize-changed-options-previous-release.
106
107** cusver-check from admin.el can help find new defcustoms missing
108:version tags.
109
110** Add a line to etc/HISTORY for the release version number and date.
111
112* BUGS
113
114** Check for modes which bind M-s that conflicts with a new global binding M-s
115and change key bindings where necessary. The current list of modes:
116
1171. Gnus binds 'M-s' to 'gnus-summary-search-article-forward'.
118
1192. Minibuffer binds 'M-s' to 'next-matching-history-element'
120 (not useful any more since C-s can now search in the history).
121
1223. 'center-line' in Text mode was already moved to the text formatting
123 keymap as 'M-o M-s' (thus this binding is not necessary any more
124 in 'nroff-mode-map' too and can be removed now from the nroff mode
125 because it can now use the global key binding 'M-o M-s' 'center-line').
126
1274. PCL-CVS binds 'M-s' to 'cvs-status', and log-edit-mode binds it to
128 'log-edit-comment-search-forward'. Perhaps search commands
129 on the global key binding 'M-s' are useless in these modes.
130
1315. Rmail binds '\es' to 'rmail-search'/'rmail-summary-search'.
132
133
134* DOCUMENTATION
135
136** Check the Emacs Tutorial.
137
138The first line of every tutorial must begin with text ending in a
139period (".", ASCII 0x2E) saying "Emacs Tutorial" in the respective
140language. This should be followed by "See end for copying conditions",
141likewise in the respective language.
142
143After each file name, on the same line or the following line, come the
144names of the people who have checked it.
145
146SECTION READERS
147----------------------------------
148TUTORIAL cyd
149TUTORIAL.bg ogi
150TUTORIAL.cn xfq
151TUTORIAL.cs
152TUTORIAL.de wl
153TUTORIAL.eo
154TUTORIAL.es
155TUTORIAL.fr
156TUTORIAL.he eliz
157TUTORIAL.it
158TUTORIAL.ja
159TUTORIAL.ko
160TUTORIAL.nl Pieter Schoenmakers
161TUTORIAL.pl
162TUTORIAL.pt_BR
163TUTORIAL.ro
164TUTORIAL.ru Alex Ott
165TUTORIAL.sk
166TUTORIAL.sl Primoz PETERLIN
167TUTORIAL.sv Mats Lidell
168TUTORIAL.th
169TUTORIAL.zh
170
171** Check the manual.
172
173abbrevs.texi
174ack.texi
175anti.texi
176arevert-xtra.texi
177basic.texi
178buffers.texi
179building.texi
180calendar.texi
181cal-xtra.texi
182cmdargs.texi
183commands.texi
184custom.texi
185dired.texi
186dired-xtra.texi
187display.texi
188emacs.texi
189emacs-xtra.texi
190emerge-xtra.texi
191entering.texi
192files.texi
193fixit.texi
194fortran-xtra.texi
195frames.texi
196glossary.texi
197help.texi
198indent.texi
199killing.texi
200kmacro.texi
201macos.texi
202maintaining.texi
203mark.texi
204mini.texi
205misc.texi
206modes.texi
207msdos.texi
208msdos-xtra.texi
209mule.texi
210m-x.texi
211package.texi
212picture-xtra.texi
213programs.texi
214regs.texi
215rmail.texi
216screen.texi
217search.texi
218sending.texi
219text.texi
220trouble.texi
221vc-xtra.texi
222vc1-xtra.texi
223windows.texi
224xresources.texi
225
226** Check the Lisp manual.
227
228abbrevs.texi
229anti.texi
230back.texi
231backups.texi
232buffers.texi
233commands.texi
234compile.texi
235control.texi
236customize.texi
237debugging.texi
238display.texi
239edebug.texi
240elisp.texi
241errors.texi
242eval.texi
243files.texi
244frames.texi
245functions.texi
246hash.texi
247help.texi
248hooks.texi
249index.texi
250internals.texi
251intro.texi
252keymaps.texi
253lists.texi
254loading.texi
255macros.texi
256maps.texi
257markers.texi
258minibuf.texi
259modes.texi
260nonascii.texi
261numbers.texi Paul Eggert (24.4)
262objects.texi
263os.texi
264package.texi
265positions.texi
266processes.texi
267searching.texi
268sequences.texi
269streams.texi
270strings.texi
271symbols.texi
272syntax.texi
273text.texi
274tips.texi
275variables.texi
276windows.texi
277
278
279Local variables:
280mode: outline
281coding: utf-8
282end: