admin/FOR-RELEASE

   1 Tasks needed before the next release.
   2
   3 * TO BE DONE SHORTLY BEFORE RELEASE
   4
   5 ** Manuals
   6 Check for node names using problematic characters:
   7   find doc -name '*.texi' -exec grep '^@node[^,]*[:.()]' {} +
   8 Sadly makeinfo does not warn about such characters.
   9
  10 Check cross-references between the manuals (eg from emacs to elisp)
  11 are correct.  You can use something like the following in the info
  12 directory in the Emacs build tree:
  13
  14 emacs -Q --eval "(progn (require 'info) (setq Info-directory-list '(\".\")))" \
  15   -f info-xref-check-all
  16
  17 Setting Info-directory-list avoids having system info pages confuse
  18 things.  References to external manuals will be flagged as
  19 uncheckable.  You should still check these, and also that each
  20 external manual has an appropriate redirect in the file manual/.htaccess
  21 in the web pages repository.  E.g.:
  22 Redirect /software/emacs/manual/html_mono/automake.html /software/automake/manual/automake.html
  23 Redirect /software/emacs/manual/html_node/automake/ /software/automake/manual/html_node/
  24
  25 Another tool you can use to check links is gnu.org's linc.py:
  26 http://www.gnu.org/server/source/
  27
  28 You run this something like:
  29
  30 cd /path/to/cvs/emacs-www
  31 linc.py -o /path/to/output-dir --url http://www.gnu.org/software/emacs/ .
  32
  33 Be warned that it is really, really slow (as in, can take ~ a full day
  34 to check the manual/ directory).  It is probably best to run it on a
  35 single directory at a time from eg manual/html_node.  It is very
  36 inefficient, but may reveal a few things that info-xref does not.
  37
  38
  39 make emacs.dvi, elisp.dvi, and deal with any errors (undefined
  40 references etc) in the output.  Break any overfull lines.
  41 Underfull hboxes are not serious, but it can be nice to get rid of
  42 them if a simple rephrasing or rearrangement will work.
  43
  44 Update the master menu and detailed menu (eg the antinews version).
  45 The command texinfo-multiple-files-update can do this, but you
  46 probably want to apply the results selectively (eg the current master
  47 menu has better line-breaks than the automatic version).  It includes
  48 the menu-entry name (if there is one) as well as the node name - using
  49 only the latter looks better.  Also, it doesn't seem to handle nested
  50 includes, so will miss edebug.texi etc.
  51
  52 Check for widow and orphan lines in the printed manual; make sure all
  53 the pages really look ok in the manual as formatted.  Orphans/widows
  54 are cases where the first/last line of a paragraph is on its own at
  55 the end/start of a page, or where the last word in a paragraph is on
  56 its own at the start of a line.  It looks better if you reword/respace
  57 things to avoid these.  (AFAIK, there is no way to find these except
  58 paging through the whole manual.)  This should be the very last thing
  59 you do, since any change can alter the layout.
  60 (Actually, there is probably little point in trying to do this.
  61 It's only really relevant if printed versions of the manuals are going
  62 to be published.  End-users are not likely to print out all 1000+
  63 pages of the manuals, and even if they do, the resulting page breaks
  64 depend on what paper and font size they use.  This also means that if
  65 you _are_ going to do this, it should be done with the paper and font
  66 size that the GNU Press are going to use when they print the manuals.
  67 I think this is different to what you get if you just use eg `make
  68 emacs.pdf' (e.g., enable "smallbook").
  69
  70 ** Check the keybindings in the refcards are correct, and add any new ones.
  71 Regenerate the pdf versions in etc/refcards/.
  72 What paper size are the English versions supposed to be on?
  73 On Debian testing, the packages texlive-lang-czechslovak and
  74 texlive-lang-polish will let you generate the cs-* and sk-* pdfs.
  75 (You may need texlive-lang-cyrillic, texlive-lang-german for others.)
  76 The Makefile rules did not work for me, I had to use something like:
  77 csplain -output-format=pdf cs-refcard
  78
  79 ** Ask maintainers of refcard translations to update them.
  80
  81 Emacs 22 translators:
  82
  83 LANG    Translator            Status
  84 cs      Pavel Janík
  85 de      Sven Joachim
  86 fr      Eric Jacoboni
  87 pl      Włodek Bzyl
  88 pt-br   Rodrigo Real
  89 ru      Alex Ott
  90 sk      Miroslav Vaško
  91
  92 ** For a major release, add a "New in Emacs XX" section to faq.texi.
  93
  94 ** Remove temporary +++/--- lines in NEWS.
  95
  96 ** Try to reorder NEWS: most important things first, related items together.
  97
  98 ** Consider bumping customize-changed-options-previous-release.
  99
 100 ** cusver-check from admin.el can help find new defcustoms missing
 101 :version tags.
 102
 103 * BUGS
 104
 105 ** Check for modes which bind M-s that conflicts with a new global binding M-s
 106 and change key bindings where necessary.  The current list of modes:
 107
 108 1. Gnus binds `M-s' to `gnus-summary-search-article-forward'.
 109
 110 2. Minibuffer binds `M-s' to `next-matching-history-element'
 111    (not useful any more since C-s can now search in the history).
 112
 113 3. `center-line' in Text mode was already moved to the text formatting
 114    keymap as `M-o M-s' (thus this binding is not necessary any more
 115    in `nroff-mode-map' too and can be removed now from the nroff mode
 116    because it can now use the global key binding `M-o M-s' `center-line').
 117
 118 4. PCL-CVS binds `M-s' to `cvs-status', and log-edit-mode binds it to
 119    `log-edit-comment-search-forward'.  Perhaps search commands
 120    on the global key binding `M-s' are useless in these modes.
 121
 122 5. Rmail binds `\es' to `rmail-search'/`rmail-summary-search'.
 123
 124
 125 * DOCUMENTATION
 126
 127 ** Check the Emacs Tutorial.
 128
 129 The first line of every tutorial must begin with text ending in a
 130 period (".", ASCII 0x2E) saying "Emacs Tutorial" in the respective
 131 language. This should be followed by "See end for copying conditions",
 132 likewise in the respective language.
 133
 134 After each file name, on the same line or the following line, come the
 135 names of the people who have checked it.
 136
 137 SECTION                  READERS
 138 ----------------------------------
 139 TUTORIAL             cyd
 140 TUTORIAL.bg          ogi
 141 TUTORIAL.cn
 142 TUTORIAL.cs
 143 TUTORIAL.de          wl
 144 TUTORIAL.eo
 145 TUTORIAL.es
 146 TUTORIAL.fr
 147 TUTORIAL.he          eliz
 148 TUTORIAL.it
 149 TUTORIAL.ja
 150 TUTORIAL.ko
 151 TUTORIAL.nl          Pieter Schoenmakers
 152 TUTORIAL.pl
 153 TUTORIAL.pt_BR
 154 TUTORIAL.ro
 155 TUTORIAL.ru          Alex Ott
 156 TUTORIAL.sk
 157 TUTORIAL.sl          Primoz PETERLIN
 158 TUTORIAL.sv          Mats Lidell
 159 TUTORIAL.th
 160 TUTORIAL.zh
 161
 162 ** Check the manual.
 163
 164 abbrevs.texi      cyd
 165 ack.texi          rgm
 166 anti.texi         cyd
 167 arevert-xtra.texi cyd
 168 basic.texi        cyd
 169 buffers.texi      cyd
 170 building.texi     cyd
 171 calendar.texi     rgm
 172 cal-xtra.texi     rgm
 173 cmdargs.texi      cyd
 174 commands.texi     cyd
 175 custom.texi       cyd
 176 dired.texi        cyd
 177 dired-xtra.texi   rgm
 178 display.texi      cyd
 179 emacs.texi        rgm
 180 emacs-xtra.texi   rgm
 181 emerge-xtra.texi  rgm
 182 entering.texi     cyd
 183 files.texi        cyd
 184 fixit.texi        cyd
 185 fortran-xtra.texi rgm
 186 frames.texi       cyd
 187 glossary.texi     rgm
 188 help.texi         cyd
 189 indent.texi       cyd
 190 killing.texi      cyd
 191 kmacro.texi       cyd
 192 macos.texi        rgm  (can't actually test any of it though)
 193 maintaining.texi  cyd
 194 mark.texi         cyd
 195 mini.texi         rgm
 196 misc.texi         cyd
 197 modes.texi        cyd
 198 msdog.texi        rgm  (can't actually test any of it though)
 199 msdog-xtra.texi   rgm  (can't actually test any of it though)
 200 mule.texi         rgm  (not 100% sure about "Fontsets")
 201 m-x.texi          cyd
 202 package.texi      cyd
 203 picture-xtra.texi rgm
 204 programs.texi     cyd
 205 regs.texi         cyd
 206 rmail.texi        rgm
 207 screen.texi       cyd
 208 search.texi       cyd
 209 sending.texi      cyd
 210 text.texi         cyd
 211 trouble.texi      cyd
 212 vc-xtra.texi      cyd
 213 vc1-xtra.texi     cyd
 214 windows.texi      cyd
 215 xresources.texi   cyd
 216
 217 ** Check the Lisp manual.
 218
 219 abbrevs.texi      rgm
 220 advice.texi       cyd
 221 anti.texi         rgm
 222 back.texi         rgm
 223 backups.texi      cyd
 224 buffers.texi      cyd
 225 commands.texi     cyd
 226 compile.texi      cyd
 227 control.texi      cyd
 228 customize.texi    cyd
 229 debugging.texi    cyd
 230 display.texi      cyd
 231 edebug.texi       rgm
 232 elisp.texi
 233 errors.texi       rgm
 234 eval.texi         cyd
 235 files.texi        cyd
 236 frames.texi       cyd
 237 functions.texi    cyd
 238 hash.texi         cyd
 239 help.texi         cyd
 240 hooks.texi        rgm
 241 index.texi
 242 internals.texi    rgm  cyd
 243 intro.texi        cyd
 244 keymaps.texi      cyd
 245 lists.texi        cyd
 246 loading.texi      cyd
 247 macros.texi       cyd
 248 maps.texi         rgm
 249 markers.texi      rgm
 250 minibuf.texi      rgm
 251 modes.texi        cyd
 252 nonascii.texi     cyd
 253 numbers.texi      cyd
 254 objects.texi      cyd
 255 os.texi           cyd
 256 package.texi      rgm
 257 positions.texi    cyd
 258 processes.texi    rgm
 259 searching.texi    rgm
 260 sequences.texi    cyd
 261 streams.texi      cyd
 262 strings.texi      cyd
 263 symbols.texi      cyd
 264 syntax.texi       cyd
 265 text.texi         cyd
 266 tips.texi         rgm
 267 variables.texi    cyd
 268 windows.texi      rgm (skimmed)
 269
 270 \f
 271 Local variables:
 272 mode: outline
 273 coding: utf-8
 274 end: