Last remaining doc additions required by 23.3.
[emacs.git] / admin / FOR-RELEASE
blob45330262041889cf43c51eda1154a2c92138b93c
1 Tasks needed before the next release.
3 * TO BE DONE SHORTLY BEFORE RELEASE
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:
10 emacs -Q --eval "(setq Info-default-directory-list '(\".\"))" \
11   -f info-xref-check-all
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.
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.
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.
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
43 ** Ask maintainers of refcard translations to update them.
45 Emacs 22 translators:
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        
56 ** Remove temporary +++/--- lines in NEWS.
58 ** Try to reorder NEWS: most important things first, related items together.
60 ** Consider bumping customize-changed-options-previous-release.
62 * BUGS
64 ** Does deleting frames run Lisp code?  If so, can we get rid of that?
65 It is a dangerous design.
66 http://lists.gnu.org/archive/html/emacs-devel/2007-09/msg01330.html
68 ** Why were the calls to x_fully_uncatch_errors commented out in eval.c?
69 http://lists.gnu.org/archive/html/emacs-devel/2007-09/msg01987.html
71 ** rms: gnus-dired.el is a mistake.  Those features should not
72 be part of Gnus.  They should be moved to some other part of Emacs.
73 rsteib: Gnus dependencies in `gnus-dired.el' (and `mailcap.el') have been
74 minimized.  I don't know what is left to do here.
76 ** Check for modes which bind M-s that conflicts with a new global binding M-s
77 and change key bindings where necessary.  The current list of modes:
79 1. Gnus binds `M-s' to `gnus-summary-search-article-forward'.
81 2. Minibuffer binds `M-s' to `next-matching-history-element'
82    (not useful any more since C-s can now search in the history).
84 3. `center-line' in Text mode was already moved to the text formatting
85    keymap as `M-o M-s' (thus this binding is not necessary any more
86    in `nroff-mode-map' too and can be removed now from the nroff mode
87    because it can now use the global key binding `M-o M-s' `center-line').
89 4. PCL-CVS binds `M-s' to `cvs-status', and log-edit-mode binds it to
90    `log-edit-comment-search-forward'.  Perhaps search commands
91    on the global key binding `M-s' are useless in these modes.
93 ** sdl.web@gmail.com, 30 Oct: ps-lpr-switches has no effect
94 http://lists.gnu.org/archive/html/emacs-devel/2007-10/msg02091.html
96 Fixed by this change?
98 2007-11-09  Vinicius Jose Latorre  <viniciusjl@ig.com.br>
100         * ps-print.el: [...]
101         (ps-do-despool): If ps-lpr-switches is not a list, force it to be one.
103 ** In C, use EMACS_INT for variables and structure members
104 for buffer/string positions.  E.g. struct it, struct text_pos.
106 * DOCUMENTATION
108 ** Clean up Emacs.app references in code and documentation.
110 ** Document new font backend
112 ** Document XEmbed support
114 ** Check the Emacs Tutorial.
116 The first line of every tutorial must begin with text ending in a
117 period (".", ASCII 0x2E) saying "Emacs Tutorial" in the respective
118 language. This should be followed by "See end for copying conditions",
119 likewise in the respective language.
121 After each file name, on the same line or the following line, come the
122 names of the people who have checked it.
124 SECTION                  READERS
125 ----------------------------------
126 etc/TUTORIAL             rgm (but see Bug#3783)
127 etc/TUTORIAL.bg          
128 etc/TUTORIAL.cn
129 etc/TUTORIAL.cs          
130 etc/TUTORIAL.de          Werner Lemberg
131 etc/TUTORIAL.eo
132 etc/TUTORIAL.es          
133 etc/TUTORIAL.fr          
134 etc/TUTORIAL.it          
135 etc/TUTORIAL.ja          
136 etc/TUTORIAL.ko
137 etc/TUTORIAL.nl          
138 etc/TUTORIAL.pl          
139 etc/TUTORIAL.pt_BR       
140 etc/TUTORIAL.ro
141 etc/TUTORIAL.ru          
142 etc/TUTORIAL.sk          
143 etc/TUTORIAL.sl          
144 etc/TUTORIAL.sv          
145 etc/TUTORIAL.th          
146 etc/TUTORIAL.zh
148 ** Check the manual.
150 abbrevs.texi      -- cyd
151 ack.texi          -- rgm
152 anti.texi
153 arevert-xtra.texi
154 basic.texi        -- cyd
155 buffers.texi      -- cyd
156 building.texi     -- cyd
157 calendar.texi     -- rgm
158 cal-xtra.texi     -- rgm
159 cmdargs.texi      -- cyd
160 commands.texi     -- cyd
161 custom.texi       -- cyd
162 dired.texi        -- cyd
163 dired-xtra.texi
164 display.texi      -- cyd
165 emacs.texi        -- cyd
166 emacs-xtra.texi
167 emerge-xtra.texi
168 entering.texi     -- cyd
169 files.texi        -- cyd
170 fixit.texi        -- cyd
171 fortran-xtra.texi -- rgm
172 frames.texi       -- cyd
173 glossary.texi
174 help.texi         -- cyd
175 indent.texi       -- cyd
176 killing.texi      -- cyd
177 kmacro.texi       -- cyd
178 macos.texi     -- davidswelt
179 maintaining.texi  -- cyd
180 major.texi        -- cyd
181 mark.texi         -- cyd
182 mini.texi         -- cyd
183 misc.texi         -- cyd
184 msdog.texi        -- eliz
185 msdog-xtra.texi   -- eliz
186 mule.texi         -- cyd
187 m-x.texi          -- cyd
188 programs.texi     -- cyd
189 regs.texi         -- cyd
190 rmail.texi        -- rgm
191 screen.texi       -- cyd
192 search.texi       -- cyd
193 sending.texi      -- rgm (maybe needs some brief mailclient.el details in
194                           "Mail Sending" section?)
195 text.texi         -- cyd
196 trouble.texi      -- cyd
197 windows.texi      -- rudalics
198 xresources.texi   -- cyd
200 ** Check the Lisp manual.
202 abbrevs.texi      -- cyd
203 advice.texi       -- cyd
204 anti.texi         -- cyd
205 back.texi
206 backups.texi      -- cyd
207 buffers.texi      -- cyd
208 commands.texi     -- cyd
209 compile.texi      -- cyd
210 control.texi      -- cyd
211 customize.texi    -- cyd
212 debugging.texi    -- cyd
213 display.texi      -- cyd
214 edebug.texi
215 elisp.texi
216 errors.texi       -- cyd
217 eval.texi         -- cyd
218 files.texi        -- cyd
219 frames.texi       -- cyd
220 functions.texi    -- cyd
221 hash.texi         -- cyd
222 help.texi         -- cyd
223 hooks.texi        -- cyd
224 index.texi
225 internals.texi    -- cyd
226 intro.texi        -- cyd
227 keymaps.texi      -- cyd
228 lists.texi        -- cyd
229 loading.texi      -- cyd
230 locals.texi       -- cyd
231 macros.texi       -- cyd
232 maps.texi         -- cyd
233 markers.texi      -- cyd
234 minibuf.texi      -- cyd
235 modes.texi        -- cyd
236 nonascii.texi     -- cyd
237 numbers.texi      -- cyd
238 objects.texi      -- cyd
239 os.texi           -- cyd
240 positions.texi    -- cyd
241 processes.texi
242 searching.texi    -- cyd
243 sequences.texi    -- cyd
244 streams.texi      -- cyd
245 strings.texi      -- cyd
246 symbols.texi      -- cyd
247 syntax.texi       -- cyd
248 text.texi         -- cyd
249 tips.texi         -- cyd
250 variables.texi    -- cyd
251 windows.texi      -- rudalics
253 * PLANNED ADDITIONS
255 ** pov-mode (probably not for Emacs-23: waiting for a Free POV-Ray).
256 ** gas-mode ?
259 Local variables:
260 mode: outline
261 coding: utf-8
262 end: