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