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