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