Commit | Line | Data |
---|---|---|
e47ac727 RS |
1 | Tasks needed before the next release. |
2 | ||
c8de0427 | 3 | * TO BE DONE SHORTLY BEFORE RELEASE |
1f912e99 | 4 | |
408b936e GM |
5 | ** Either update, test, and support the old w32 build method, or remove it. |
6 | ||
10a99e0d | 7 | ** Manuals |
16bcc96d GM |
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. | |
11 | ||
10a99e0d | 12 | Check cross-references between the manuals (eg from emacs to elisp) |
332eb5f1 GM |
13 | are correct. You can use something like the following in the info |
14 | directory in the Emacs build tree: | |
15 | ||
bcc65704 | 16 | emacs -Q --eval "(progn (require 'info) (setq Info-directory-list '(\".\")))" \ |
332eb5f1 | 17 | -f info-xref-check-all |
10a99e0d | 18 | |
7e3a3bb3 GM |
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/ | |
26 | ||
8b09455e GM |
27 | Another tool you can use to check links is gnu.org's linc.py: |
28 | http://www.gnu.org/server/source/ | |
29 | ||
30 | You run this something like: | |
31 | ||
32 | cd /path/to/cvs/emacs-www | |
33 | linc.py -o /path/to/output-dir --url http://www.gnu.org/software/emacs/ . | |
34 | ||
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. | |
39 | ||
40 | ||
10a99e0d GM |
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. | |
45 | ||
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. | |
53 | ||
64adbcf6 GM |
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. | |
e2866686 GM |
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"). | |
059cbcd5 | 71 | |
6ad032d2 | 72 | ** Check the keybindings in the refcards are correct, and add any new ones. |
6ad032d2 | 73 | What paper size are the English versions supposed to be on? |
accc7588 GM |
74 | On Debian testing, the packages texlive-lang-czechslovak and |
75 | texlive-lang-polish will let you generate the cs-* and sk-* pdfs. | |
a017d05f | 76 | (You may need texlive-lang-cyrillic, texlive-lang-german for others.) |
accc7588 GM |
77 | The Makefile rules did not work for me, I had to use something like: |
78 | csplain -output-format=pdf cs-refcard | |
f199f76c | 79 | |
b713c813 RS |
80 | ** Ask maintainers of refcard translations to update them. |
81 | ||
590394eb | 82 | Emacs 22 translators: |
49561a36 RS |
83 | |
84 | LANG Translator Status | |
590394eb GM |
85 | cs Pavel Janík |
86 | de Sven Joachim | |
87 | fr Eric Jacoboni | |
88 | pl Włodek Bzyl | |
89 | pt-br Rodrigo Real | |
90 | ru Alex Ott | |
91 | sk Miroslav Vaško | |
49561a36 | 92 | |
5db6195f GM |
93 | ** For a major release, add a "New in Emacs XX" section to faq.texi. |
94 | ||
0fd352a5 GM |
95 | ** Remove temporary +++/--- lines in NEWS. |
96 | ||
97 | ** Try to reorder NEWS: most important things first, related items together. | |
98 | ||
10a99e0d GM |
99 | ** Consider bumping customize-changed-options-previous-release. |
100 | ||
8cee47b8 | 101 | ** cusver-check from admin.el can help find new defcustoms missing |
5db6195f GM |
102 | :version tags. |
103 | ||
f9de7738 RS |
104 | * BUGS |
105 | ||
caf857eb JL |
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: | |
108 | ||
109 | 1. Gnus binds `M-s' to `gnus-summary-search-article-forward'. | |
110 | ||
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). | |
113 | ||
1f9689eb | 114 | 3. `center-line' in Text mode was already moved to the text formatting |
caf857eb JL |
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'). | |
118 | ||
1f9689eb | 119 | 4. PCL-CVS binds `M-s' to `cvs-status', and log-edit-mode binds it to |
caf857eb JL |
120 | `log-edit-comment-search-forward'. Perhaps search commands |
121 | on the global key binding `M-s' are useless in these modes. | |
122 | ||
8f4fb15f GM |
123 | 5. Rmail binds `\es' to `rmail-search'/`rmail-summary-search'. |
124 | ||
125 | ||
3026f1b4 | 126 | * DOCUMENTATION |
58340fa7 | 127 | |
0b048d52 MT |
128 | ** Check the Emacs Tutorial. |
129 | ||
29121f81 RS |
130 | The first line of every tutorial must begin with text ending in a |
131 | period (".", ASCII 0x2E) saying "Emacs Tutorial" in the respective | |
41999d0f GM |
132 | language. This should be followed by "See end for copying conditions", |
133 | likewise in the respective language. | |
b75122e4 RS |
134 | |
135 | After each file name, on the same line or the following line, come the | |
136 | names of the people who have checked it. | |
137 | ||
0b048d52 MT |
138 | SECTION READERS |
139 | ---------------------------------- | |
107ddb97 | 140 | TUTORIAL cyd |
7a22e700 | 141 | TUTORIAL.bg ogi |
2fd3a9f7 | 142 | TUTORIAL.cn xfq |
fd99fde6 | 143 | TUTORIAL.cs |
7a22e700 | 144 | TUTORIAL.de wl |
fd99fde6 GM |
145 | TUTORIAL.eo |
146 | TUTORIAL.es | |
147 | TUTORIAL.fr | |
0dc18ae0 | 148 | TUTORIAL.he eliz |
fd99fde6 | 149 | TUTORIAL.it |
2fd3a9f7 | 150 | TUTORIAL.ja |
fd99fde6 | 151 | TUTORIAL.ko |
735cc5ca | 152 | TUTORIAL.nl Pieter Schoenmakers |
fd99fde6 GM |
153 | TUTORIAL.pl |
154 | TUTORIAL.pt_BR | |
155 | TUTORIAL.ro | |
5eb7536f | 156 | TUTORIAL.ru Alex Ott |
fd99fde6 | 157 | TUTORIAL.sk |
6d0bd9ba | 158 | TUTORIAL.sl Primoz PETERLIN |
21f50183 | 159 | TUTORIAL.sv Mats Lidell |
fd99fde6 GM |
160 | TUTORIAL.th |
161 | TUTORIAL.zh | |
0b048d52 | 162 | |
01c29e98 CY |
163 | ** Check the manual. |
164 | ||
c40a7de7 | 165 | abbrevs.texi cyd |
41f1e868 | 166 | ack.texi rgm |
0b21c100 | 167 | anti.texi cyd |
bfd779dd | 168 | arevert-xtra.texi cyd |
21100e7d | 169 | basic.texi cyd |
da97a9e6 | 170 | buffers.texi cyd |
bc859d5f | 171 | building.texi cyd |
112d1241 | 172 | calendar.texi rgm |
a5987767 | 173 | cal-xtra.texi rgm |
a73a3461 | 174 | cmdargs.texi cyd |
de0bde62 | 175 | commands.texi cyd |
89bd9ccd | 176 | custom.texi cyd |
c40a7de7 | 177 | dired.texi cyd |
3b19a30d | 178 | dired-xtra.texi rgm |
939db9ac | 179 | display.texi cyd |
2d2f6581 | 180 | emacs.texi rgm |
2e03845d | 181 | emacs-xtra.texi rgm |
68af8d4f | 182 | emerge-xtra.texi rgm |
de0bde62 | 183 | entering.texi cyd |
bfd779dd | 184 | files.texi cyd |
06848b82 | 185 | fixit.texi cyd |
d400b295 | 186 | fortran-xtra.texi rgm |
dc95a8b0 | 187 | frames.texi cyd |
a0706406 | 188 | glossary.texi rgm |
21100e7d | 189 | help.texi cyd |
6d262977 | 190 | indent.texi cyd |
21100e7d | 191 | killing.texi cyd |
bfd779dd | 192 | kmacro.texi cyd |
40ace058 | 193 | macos.texi rgm (can't actually test any of it though) |
3d992aa0 | 194 | maintaining.texi cyd |
21100e7d | 195 | mark.texi cyd |
49fe4321 | 196 | mini.texi rgm |
88c5c7c8 | 197 | misc.texi cyd |
dc95a8b0 | 198 | modes.texi cyd |
8f4042d2 | 199 | msdog.texi rgm (can't actually test any of it though) |
371fb833 | 200 | msdog-xtra.texi rgm (can't actually test any of it though) |
05806f43 | 201 | mule.texi rgm (not 100% sure about "Fontsets") |
21100e7d | 202 | m-x.texi cyd |
b0d7d8af | 203 | package.texi cyd |
5f8dc2ca | 204 | picture-xtra.texi rgm |
bc859d5f | 205 | programs.texi cyd |
21100e7d | 206 | regs.texi cyd |
b474519e | 207 | rmail.texi rgm |
de0bde62 | 208 | screen.texi cyd |
5abc31ef | 209 | search.texi cyd |
b30941db | 210 | sending.texi cyd |
bc859d5f | 211 | text.texi cyd |
c61ab18c | 212 | trouble.texi cyd |
3d992aa0 CY |
213 | vc-xtra.texi cyd |
214 | vc1-xtra.texi cyd | |
dc95a8b0 | 215 | windows.texi cyd |
06848b82 | 216 | xresources.texi cyd |
01c29e98 CY |
217 | |
218 | ** Check the Lisp manual. | |
219 | ||
ea16568d | 220 | abbrevs.texi rgm |
25dec365 | 221 | advice.texi cyd |
764a3017 | 222 | anti.texi rgm |
0b021094 | 223 | back.texi rgm |
d268b4fe | 224 | backups.texi cyd |
431ee44b | 225 | buffers.texi cyd |
faccede1 | 226 | commands.texi cyd |
25dec365 | 227 | compile.texi cyd |
31cbea1d | 228 | control.texi cyd |
e1161b06 | 229 | customize.texi cyd |
faccede1 | 230 | debugging.texi cyd |
5319014e | 231 | display.texi cyd |
0b021094 | 232 | edebug.texi rgm |
01c29e98 | 233 | elisp.texi |
7e05b1ec | 234 | errors.texi rgm |
31cbea1d | 235 | eval.texi cyd |
a59225b1 | 236 | files.texi cyd |
a08a07e3 | 237 | frames.texi cyd |
735cc5ca | 238 | functions.texi cyd |
31cbea1d | 239 | hash.texi cyd |
8376d7c2 | 240 | help.texi cyd |
2064cc6a | 241 | hooks.texi rgm |
01c29e98 | 242 | index.texi |
d15aac68 | 243 | internals.texi rgm cyd |
6d0bd9ba | 244 | intro.texi cyd |
3d8badf4 | 245 | keymaps.texi cyd |
31cbea1d | 246 | lists.texi cyd |
6c1e4b46 | 247 | loading.texi cyd |
03988c98 | 248 | macros.texi cyd |
53a1239b | 249 | maps.texi rgm |
3266b56f | 250 | markers.texi rgm |
5db6195f | 251 | minibuf.texi rgm |
8376d7c2 | 252 | modes.texi cyd |
83ef8187 | 253 | nonascii.texi cyd |
31cbea1d | 254 | numbers.texi cyd |
7a22e700 | 255 | objects.texi cyd |
d15aac68 | 256 | os.texi cyd |
763d4948 | 257 | package.texi rgm |
ef959d3a | 258 | positions.texi cyd |
4373fd43 | 259 | processes.texi rgm |
fee88ca0 | 260 | searching.texi rgm |
31cbea1d | 261 | sequences.texi cyd |
faccede1 | 262 | streams.texi cyd |
31cbea1d CY |
263 | strings.texi cyd |
264 | symbols.texi cyd | |
4230351b | 265 | syntax.texi cyd |
83ef8187 | 266 | text.texi cyd |
b3134b95 | 267 | tips.texi rgm |
735cc5ca | 268 | variables.texi cyd |
09ebefe1 | 269 | windows.texi rgm (skimmed) |
01c29e98 | 270 | |
c0a070c1 KS |
271 | \f |
272 | Local variables: | |
273 | mode: outline | |
49561a36 | 274 | coding: utf-8 |
c0a070c1 | 275 | end: |