Updates to misc.texi in Emacs manual.
[bpt/emacs.git] / admin / FOR-RELEASE
1 Tasks needed before the next release.
2
3 * TO BE DONE SHORTLY BEFORE RELEASE
4
5 ** Manuals
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:
9
10 emacs -Q --eval "(setq Info-default-directory-list '(\".\"))" \
11 -f info-xref-check-all
12
13 make emacs.dvi, elisp.dvi, and deal with any errors (undefined
14 references etc) in the output. Break any overfull lines.
15 Underfull hboxes are not serious, but it can be nice to get rid of
16 them if a simple rephrasing or rearrangement will work.
17
18 Update the master menu and detailed menu (eg the antinews version).
19 The command texinfo-multiple-files-update can do this, but you
20 probably want to apply the results selectively (eg the current master
21 menu has better line-breaks than the automatic version). It includes
22 the menu-entry name (if there is one) as well as the node name - using
23 only the latter looks better. Also, it doesn't seem to handle nested
24 includes, so will miss edebug.texi etc.
25
26 Check for widow and orphan lines in the printed manual; make sure all
27 the pages really look ok in the manual as formatted. Orphans/widows
28 are cases where the first/last line of a paragraph is on its own at
29 the end/start of a page, or where the last word in a paragraph is on
30 its own at the start of a line. It looks better if you reword/respace
31 things to avoid these. (AFAIK, there is no way to find these except
32 paging through the whole manual.) This should be the very last thing
33 you do, since any change can alter the layout.
34
35 ** Check the keybindings in the refcards are correct, and add any new ones.
36 Regenerate the pdf versions in etc/refcards/.
37 What paper size are the English versions supposed to be on?
38 On Debian testing, the packages texlive-lang-czechslovak and
39 texlive-lang-polish will let you generate the cs-* and sk-* pdfs.
40 The Makefile rules did not work for me, I had to use something like:
41 csplain -output-format=pdf cs-refcard
42
43 ** Ask maintainers of refcard translations to update them.
44
45 Emacs 22 translators:
46
47 LANG Translator Status
48 cs Pavel Janík
49 de Sven Joachim
50 fr Eric Jacoboni
51 pl Włodek Bzyl
52 pt-br Rodrigo Real
53 ru Alex Ott
54 sk Miroslav Vaško
55
56 ** Remove temporary +++/--- lines in NEWS.
57
58 ** Try to reorder NEWS: most important things first, related items together.
59
60 ** Consider bumping customize-changed-options-previous-release.
61
62 * BUGS
63
64 ** rms: gnus-dired.el is a mistake. Those features should not
65 be part of Gnus. They should be moved to some other part of Emacs.
66 rsteib: Gnus dependencies in `gnus-dired.el' (and `mailcap.el') have been
67 minimized. I don't know what is left to do here.
68
69 ** Check for modes which bind M-s that conflicts with a new global binding M-s
70 and change key bindings where necessary. The current list of modes:
71
72 1. Gnus binds `M-s' to `gnus-summary-search-article-forward'.
73
74 2. Minibuffer binds `M-s' to `next-matching-history-element'
75 (not useful any more since C-s can now search in the history).
76
77 3. `center-line' in Text mode was already moved to the text formatting
78 keymap as `M-o M-s' (thus this binding is not necessary any more
79 in `nroff-mode-map' too and can be removed now from the nroff mode
80 because it can now use the global key binding `M-o M-s' `center-line').
81
82 4. PCL-CVS binds `M-s' to `cvs-status', and log-edit-mode binds it to
83 `log-edit-comment-search-forward'. Perhaps search commands
84 on the global key binding `M-s' are useless in these modes.
85
86 * DOCUMENTATION
87
88 ** Document XEmbed support
89
90 ** Check the Emacs Tutorial.
91
92 The first line of every tutorial must begin with text ending in a
93 period (".", ASCII 0x2E) saying "Emacs Tutorial" in the respective
94 language. This should be followed by "See end for copying conditions",
95 likewise in the respective language.
96
97 After each file name, on the same line or the following line, come the
98 names of the people who have checked it.
99
100 SECTION READERS
101 ----------------------------------
102 TUTORIAL
103 TUTORIAL.bg
104 TUTORIAL.cn
105 TUTORIAL.cs
106 TUTORIAL.de
107 TUTORIAL.eo
108 TUTORIAL.es
109 TUTORIAL.fr
110 TUTORIAL.he
111 TUTORIAL.it
112 TUTORIAL.ja
113 TUTORIAL.ko
114 TUTORIAL.nl
115 TUTORIAL.pl
116 TUTORIAL.pt_BR
117 TUTORIAL.ro
118 TUTORIAL.ru
119 TUTORIAL.sk
120 TUTORIAL.sl
121 TUTORIAL.sv
122 TUTORIAL.th
123 TUTORIAL.zh
124
125 ** Check the manual.
126
127 abbrevs.texi cyd
128 ack.texi
129 anti.texi
130 arevert-xtra.texi cyd
131 basic.texi cyd
132 buffers.texi cyd
133 building.texi cyd
134 calendar.texi
135 cal-xtra.texi
136 cmdargs.texi
137 commands.texi cyd
138 custom.texi
139 dired.texi cyd
140 dired-xtra.texi
141 display.texi cyd
142 emacs.texi
143 emacs-xtra.texi
144 emerge-xtra.texi
145 entering.texi cyd
146 files.texi cyd
147 fixit.texi
148 fortran-xtra.texi
149 frames.texi cyd
150 glossary.texi
151 help.texi cyd
152 indent.texi cyd
153 killing.texi cyd
154 kmacro.texi cyd
155 macos.texi
156 maintaining.texi cyd
157 mark.texi cyd
158 mini.texi
159 misc.texi
160 modes.texi cyd
161 msdog.texi
162 msdog-xtra.texi
163 mule.texi
164 m-x.texi cyd
165 picture-xtra.texi
166 programs.texi cyd
167 regs.texi cyd
168 rmail.texi
169 screen.texi cyd
170 search.texi cyd
171 sending.texi cyd
172 text.texi cyd
173 trouble.texi
174 vc-xtra.texi cyd
175 vc1-xtra.texi cyd
176 windows.texi cyd
177 xresources.texi
178
179 ** Check the Lisp manual.
180
181 abbrevs.texi
182 advice.texi
183 anti.texi
184 back.texi
185 backups.texi
186 buffers.texi
187 commands.texi
188 compile.texi
189 control.texi
190 customize.texi
191 debugging.texi
192 display.texi
193 edebug.texi
194 elisp.texi
195 errors.texi
196 eval.texi
197 files.texi
198 frames.texi
199 functions.texi
200 hash.texi
201 help.texi
202 hooks.texi
203 index.texi
204 internals.texi
205 intro.texi
206 keymaps.texi
207 lists.texi
208 loading.texi
209 locals.texi
210 macros.texi
211 maps.texi
212 markers.texi
213 minibuf.texi
214 modes.texi
215 nonascii.texi
216 numbers.texi
217 objects.texi
218 os.texi
219 package.texi
220 positions.texi
221 processes.texi
222 searching.texi
223 sequences.texi
224 streams.texi
225 strings.texi
226 symbols.texi
227 syntax.texi
228 text.texi
229 tips.texi
230 variables.texi
231 windows.texi
232
233 * PLANNED ADDITIONS
234
235 ** pov-mode (probably not for Emacs-23: waiting for a Free POV-Ray).
236 ** gas-mode ?
237
238 \f
239 Local variables:
240 mode: outline
241 coding: utf-8
242 end: