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 What paper size are the English versions supposed to be on?
  72 On Debian testing, the packages texlive-lang-czechslovak and
  73 texlive-lang-polish will let you generate the cs-* and sk-* pdfs.
  74 (You may need texlive-lang-cyrillic, texlive-lang-german for others.)
  75 The Makefile rules did not work for me, I had to use something like:
  76 csplain -output-format=pdf cs-refcard
  77
  78 ** Ask maintainers of refcard translations to update them.
  79
  80 Emacs 22 translators:
  81
  82 LANG    Translator            Status
  83 cs      Pavel Janík
  84 de      Sven Joachim
  85 fr      Eric Jacoboni
  86 pl      Włodek Bzyl
  87 pt-br   Rodrigo Real
  88 ru      Alex Ott
  89 sk      Miroslav Vaško
  90
  91 ** For a major release, add a "New in Emacs XX" section to faq.texi.
  92
  93 ** Remove temporary +++/--- lines in NEWS.
  94
  95 ** Try to reorder NEWS: most important things first, related items together.
  96
  97 ** Consider bumping customize-changed-options-previous-release.
  98
  99 ** cusver-check from admin.el can help find new defcustoms missing
 100 :version tags.
 101
 102 * BUGS
 103
 104 ** Check for modes which bind M-s that conflicts with a new global binding M-s
 105 and change key bindings where necessary.  The current list of modes:
 106
 107 1. Gnus binds `M-s' to `gnus-summary-search-article-forward'.
 108
 109 2. Minibuffer binds `M-s' to `next-matching-history-element'
 110    (not useful any more since C-s can now search in the history).
 111
 112 3. `center-line' in Text mode was already moved to the text formatting
 113    keymap as `M-o M-s' (thus this binding is not necessary any more
 114    in `nroff-mode-map' too and can be removed now from the nroff mode
 115    because it can now use the global key binding `M-o M-s' `center-line').
 116
 117 4. PCL-CVS binds `M-s' to `cvs-status', and log-edit-mode binds it to
 118    `log-edit-comment-search-forward'.  Perhaps search commands
 119    on the global key binding `M-s' are useless in these modes.
 120
 121 5. Rmail binds `\es' to `rmail-search'/`rmail-summary-search'.
 122
 123
 124 * DOCUMENTATION
 125
 126 ** Check the Emacs Tutorial.
 127
 128 The first line of every tutorial must begin with text ending in a
 129 period (".", ASCII 0x2E) saying "Emacs Tutorial" in the respective
 130 language. This should be followed by "See end for copying conditions",
 131 likewise in the respective language.
 132
 133 After each file name, on the same line or the following line, come the
 134 names of the people who have checked it.
 135
 136 SECTION                  READERS
 137 ----------------------------------
 138 TUTORIAL             cyd
 139 TUTORIAL.bg          ogi
 140 TUTORIAL.cn          xfq
 141 TUTORIAL.cs
 142 TUTORIAL.de          wl
 143 TUTORIAL.eo
 144 TUTORIAL.es
 145 TUTORIAL.fr
 146 TUTORIAL.he          eliz
 147 TUTORIAL.it
 148 TUTORIAL.ja
 149 TUTORIAL.ko
 150 TUTORIAL.nl          Pieter Schoenmakers
 151 TUTORIAL.pl
 152 TUTORIAL.pt_BR
 153 TUTORIAL.ro
 154 TUTORIAL.ru          Alex Ott
 155 TUTORIAL.sk
 156 TUTORIAL.sl          Primoz PETERLIN
 157 TUTORIAL.sv          Mats Lidell
 158 TUTORIAL.th
 159 TUTORIAL.zh
 160
 161 ** Check the manual.
 162
 163 abbrevs.texi      cyd
 164 ack.texi          rgm
 165 anti.texi         cyd
 166 arevert-xtra.texi cyd
 167 basic.texi        cyd
 168 buffers.texi      cyd
 169 building.texi     cyd
 170 calendar.texi     rgm
 171 cal-xtra.texi     rgm
 172 cmdargs.texi      cyd
 173 commands.texi     cyd
 174 custom.texi       cyd
 175 dired.texi        cyd
 176 dired-xtra.texi   rgm
 177 display.texi      cyd
 178 emacs.texi        rgm
 179 emacs-xtra.texi   rgm
 180 emerge-xtra.texi  rgm
 181 entering.texi     cyd
 182 files.texi        cyd
 183 fixit.texi        cyd
 184 fortran-xtra.texi rgm
 185 frames.texi       cyd
 186 glossary.texi     rgm
 187 help.texi         cyd
 188 indent.texi       cyd
 189 killing.texi      cyd
 190 kmacro.texi       cyd
 191 macos.texi        rgm  (can't actually test any of it though)
 192 maintaining.texi  cyd
 193 mark.texi         cyd
 194 mini.texi         rgm
 195 misc.texi         cyd
 196 modes.texi        cyd
 197 msdog.texi        rgm  (can't actually test any of it though)
 198 msdog-xtra.texi   rgm  (can't actually test any of it though)
 199 mule.texi         rgm  (not 100% sure about "Fontsets")
 200 m-x.texi          cyd
 201 package.texi      cyd
 202 picture-xtra.texi rgm
 203 programs.texi     cyd
 204 regs.texi         cyd
 205 rmail.texi        rgm
 206 screen.texi       cyd
 207 search.texi       cyd
 208 sending.texi      cyd
 209 text.texi         cyd
 210 trouble.texi      cyd
 211 vc-xtra.texi      cyd
 212 vc1-xtra.texi     cyd
 213 windows.texi      cyd
 214 xresources.texi   cyd
 215
 216 ** Check the Lisp manual.
 217
 218 abbrevs.texi      rgm
 219 advice.texi       cyd
 220 anti.texi         rgm
 221 back.texi         rgm
 222 backups.texi      cyd
 223 buffers.texi      cyd
 224 commands.texi     cyd
 225 compile.texi      cyd
 226 control.texi      cyd
 227 customize.texi    cyd
 228 debugging.texi    cyd
 229 display.texi      cyd
 230 edebug.texi       rgm
 231 elisp.texi
 232 errors.texi       rgm
 233 eval.texi         cyd
 234 files.texi        cyd
 235 frames.texi       cyd
 236 functions.texi    cyd
 237 hash.texi         cyd
 238 help.texi         cyd
 239 hooks.texi        rgm
 240 index.texi
 241 internals.texi    rgm  cyd
 242 intro.texi        cyd
 243 keymaps.texi      cyd
 244 lists.texi        cyd
 245 loading.texi      cyd
 246 macros.texi       cyd
 247 maps.texi         rgm
 248 markers.texi      rgm
 249 minibuf.texi      rgm
 250 modes.texi        cyd
 251 nonascii.texi     cyd
 252 numbers.texi      cyd
 253 objects.texi      cyd
 254 os.texi           cyd
 255 package.texi      rgm
 256 positions.texi    cyd
 257 processes.texi    rgm
 258 searching.texi    rgm
 259 sequences.texi    cyd
 260 streams.texi      cyd
 261 strings.texi      cyd
 262 symbols.texi      cyd
 263 syntax.texi       cyd
 264 text.texi         cyd
 265 tips.texi         rgm
 266 variables.texi    cyd
 267 windows.texi      rgm (skimmed)
 268
 269 \f
 270 Local variables:
 271 mode: outline
 272 coding: utf-8
 273 end: