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