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