1 Tasks needed before the next release.
3 * TO BE DONE SHORTLY BEFORE RELEASE
5 ** Either update, test, and support the old w32 build method, or remove it.
8 Check for node names using problematic characters:
9 find doc -name '*.texi' -exec grep '^@node[^,]*[:.()]' {} +
10 Sadly makeinfo does not warn about such characters.
12 Check cross-references between the manuals (eg from emacs to elisp)
13 are correct. You can use something like the following in the info
14 directory in the Emacs build tree:
16 emacs -Q --eval "(progn (require 'info) (setq Info-directory-list '(\".\")))" \
17 -f info-xref-check-all
19 Setting Info-directory-list avoids having system info pages confuse
20 things. References to external manuals will be flagged as
21 uncheckable. You should still check these, and also that each
22 external manual has an appropriate redirect in the file manual/.htaccess
23 in the web pages repository. E.g.:
24 Redirect /software/emacs/manual/html_mono/automake.html /software/automake/manual/automake.html
25 Redirect /software/emacs/manual/html_node/automake/ /software/automake/manual/html_node/
27 Another tool you can use to check links is gnu.org's linc.py:
28 http://www.gnu.org/server/source/
30 You run this something like:
32 cd /path/to/cvs/emacs-www
33 linc.py -o /path/to/output-dir --url http://www.gnu.org/software/emacs/ .
35 Be warned that it is really, really slow (as in, can take ~ a full day
36 to check the manual/ directory). It is probably best to run it on a
37 single directory at a time from eg manual/html_node. It is very
38 inefficient, but may reveal a few things that info-xref does not.
41 make emacs.dvi, elisp.dvi, and deal with any errors (undefined
42 references etc) in the output. Break any overfull lines.
43 Underfull hboxes are not serious, but it can be nice to get rid of
44 them if a simple rephrasing or rearrangement will work.
46 Update the master menu and detailed menu (eg the antinews version).
47 The command texinfo-multiple-files-update can do this, but you
48 probably want to apply the results selectively (eg the current master
49 menu has better line-breaks than the automatic version). It includes
50 the menu-entry name (if there is one) as well as the node name - using
51 only the latter looks better. Also, it doesn't seem to handle nested
52 includes, so will miss edebug.texi etc.
54 Check for widow and orphan lines in the printed manual; make sure all
55 the pages really look ok in the manual as formatted. Orphans/widows
56 are cases where the first/last line of a paragraph is on its own at
57 the end/start of a page, or where the last word in a paragraph is on
58 its own at the start of a line. It looks better if you reword/respace
59 things to avoid these. (AFAIK, there is no way to find these except
60 paging through the whole manual.) This should be the very last thing
61 you do, since any change can alter the layout.
62 (Actually, there is probably little point in trying to do this.
63 It's only really relevant if printed versions of the manuals are going
64 to be published. End-users are not likely to print out all 1000+
65 pages of the manuals, and even if they do, the resulting page breaks
66 depend on what paper and font size they use. This also means that if
67 you _are_ going to do this, it should be done with the paper and font
68 size that the GNU Press are going to use when they print the manuals.
69 I think this is different to what you get if you just use eg `make
70 emacs.pdf' (e.g., enable "smallbook").
72 ** Check the keybindings in the refcards are correct, and add any new ones.
73 What paper size are the English versions supposed to be on?
74 On Debian testing, the packages texlive-lang-czechslovak and
75 texlive-lang-polish will let you generate the cs-* and sk-* pdfs.
76 (You may need texlive-lang-cyrillic, texlive-lang-german for others.)
77 The Makefile rules did not work for me, I had to use something like:
78 csplain -output-format=pdf cs-refcard
80 ** Ask maintainers of refcard translations to update them.
84 LANG Translator Status
93 ** For a major release, add a "New in Emacs XX" section to faq.texi.
95 ** Remove temporary +++/--- lines in NEWS.
97 ** Try to reorder NEWS: most important things first, related items together.
99 ** Consider bumping customize-changed-options-previous-release.
101 ** cusver-check from admin.el can help find new defcustoms missing
106 ** Check for modes which bind M-s that conflicts with a new global binding M-s
107 and change key bindings where necessary. The current list of modes:
109 1. Gnus binds `M-s' to `gnus-summary-search-article-forward'.
111 2. Minibuffer binds `M-s' to `next-matching-history-element'
112 (not useful any more since C-s can now search in the history).
114 3. `center-line' in Text mode was already moved to the text formatting
115 keymap as `M-o M-s' (thus this binding is not necessary any more
116 in `nroff-mode-map' too and can be removed now from the nroff mode
117 because it can now use the global key binding `M-o M-s' `center-line').
119 4. PCL-CVS binds `M-s' to `cvs-status', and log-edit-mode binds it to
120 `log-edit-comment-search-forward'. Perhaps search commands
121 on the global key binding `M-s' are useless in these modes.
123 5. Rmail binds `\es' to `rmail-search'/`rmail-summary-search'.
128 ** Check the Emacs Tutorial.
130 The first line of every tutorial must begin with text ending in a
131 period (".", ASCII 0x2E) saying "Emacs Tutorial" in the respective
132 language. This should be followed by "See end for copying conditions",
133 likewise in the respective language.
135 After each file name, on the same line or the following line, come the
136 names of the people who have checked it.
139 ----------------------------------
152 TUTORIAL.nl Pieter Schoenmakers
158 TUTORIAL.sl Primoz PETERLIN
159 TUTORIAL.sv Mats Lidell
218 ** Check the Lisp manual.
253 numbers.texi Paul Eggert (24.4)
HCoop / bpt / emacs.git / blob