Spelling fixes.
[bpt/emacs.git] / admin / FOR-RELEASE
index 74a7588..8b6bddb 100644 (file)
@@ -2,14 +2,42 @@ Tasks needed before the next release.
 
 * TO BE DONE SHORTLY BEFORE RELEASE
 
+** Either update, test, and support the old w32 build method, or remove it.
+
 ** Manuals
+Check for node names using problematic characters:
+  find doc -name '*.texi' -exec grep '^@node[^,]*[:.()]' {} +
+Sadly makeinfo does not warn about such characters.
+
 Check cross-references between the manuals (eg from emacs to elisp)
 are correct.  You can use something like the following in the info
 directory in the Emacs build tree:
 
-emacs -Q --eval "(setq Info-default-directory-list '(\".\"))" \
+emacs -Q --eval "(progn (require 'info) (setq Info-directory-list '(\".\")))" \
   -f info-xref-check-all
 
+Setting Info-directory-list avoids having system info pages confuse
+things.  References to external manuals will be flagged as
+uncheckable.  You should still check these, and also that each
+external manual has an appropriate redirect in the file manual/.htaccess
+in the web pages repository.  E.g.:
+Redirect /software/emacs/manual/html_mono/automake.html /software/automake/manual/automake.html
+Redirect /software/emacs/manual/html_node/automake/ /software/automake/manual/html_node/
+
+Another tool you can use to check links is gnu.org's linc.py:
+http://www.gnu.org/server/source/
+
+You run this something like:
+
+cd /path/to/cvs/emacs-www
+linc.py -o /path/to/output-dir --url http://www.gnu.org/software/emacs/ .
+
+Be warned that it is really, really slow (as in, can take ~ a full day
+to check the manual/ directory).  It is probably best to run it on a
+single directory at a time from eg manual/html_node.  It is very
+inefficient, but may reveal a few things that info-xref does not.
+
+
 make emacs.dvi, elisp.dvi, and deal with any errors (undefined
 references etc) in the output.  Break any overfull lines.
 Underfull hboxes are not serious, but it can be nice to get rid of
@@ -31,12 +59,21 @@ its own at the start of a line.  It looks better if you reword/respace
 things to avoid these.  (AFAIK, there is no way to find these except
 paging through the whole manual.)  This should be the very last thing
 you do, since any change can alter the layout.
+(Actually, there is probably little point in trying to do this.
+It's only really relevant if printed versions of the manuals are going
+to be published.  End-users are not likely to print out all 1000+
+pages of the manuals, and even if they do, the resulting page breaks
+depend on what paper and font size they use.  This also means that if
+you _are_ going to do this, it should be done with the paper and font
+size that the GNU Press are going to use when they print the manuals.
+I think this is different to what you get if you just use eg `make
+emacs.pdf' (e.g., enable "smallbook").
 
 ** Check the keybindings in the refcards are correct, and add any new ones.
-Regenerate the pdf versions in etc/refcards/.
 What paper size are the English versions supposed to be on?
 On Debian testing, the packages texlive-lang-czechslovak and
 texlive-lang-polish will let you generate the cs-* and sk-* pdfs.
+(You may need texlive-lang-cyrillic, texlive-lang-german for others.)
 The Makefile rules did not work for me, I had to use something like:
 csplain -output-format=pdf cs-refcard
 
@@ -53,18 +90,18 @@ pt-br       Rodrigo Real
 ru     Alex Ott              
 sk     Miroslav Vaško        
 
+** For a major release, add a "New in Emacs XX" section to faq.texi.
+
 ** Remove temporary +++/--- lines in NEWS.
 
 ** Try to reorder NEWS: most important things first, related items together.
 
 ** Consider bumping customize-changed-options-previous-release.
 
-* BUGS
+** cusver-check from admin.el can help find new defcustoms missing
+:version tags.
 
-** rms: gnus-dired.el is a mistake.  Those features should not
-be part of Gnus.  They should be moved to some other part of Emacs.
-rsteib: Gnus dependencies in `gnus-dired.el' (and `mailcap.el') have been
-minimized.  I don't know what is left to do here.
+* BUGS
 
 ** Check for modes which bind M-s that conflicts with a new global binding M-s
 and change key bindings where necessary.  The current list of modes:
@@ -83,9 +120,10 @@ and change key bindings where necessary.  The current list of modes:
    `log-edit-comment-search-forward'.  Perhaps search commands
    on the global key binding `M-s' are useless in these modes.
 
-* DOCUMENTATION
+5. Rmail binds `\es' to `rmail-search'/`rmail-summary-search'.
 
-** Document XEmbed support
+
+* DOCUMENTATION
 
 ** Check the Emacs Tutorial.
 
@@ -101,7 +139,7 @@ SECTION                  READERS
 ----------------------------------
 TUTORIAL             cyd
 TUTORIAL.bg          ogi
-TUTORIAL.cn
+TUTORIAL.cn          xfq
 TUTORIAL.cs          
 TUTORIAL.de          wl
 TUTORIAL.eo
@@ -109,13 +147,13 @@ TUTORIAL.es
 TUTORIAL.fr          
 TUTORIAL.he          eliz
 TUTORIAL.it          
-TUTORIAL.ja             
+TUTORIAL.ja          
 TUTORIAL.ko
 TUTORIAL.nl         Pieter Schoenmakers
 TUTORIAL.pl          
 TUTORIAL.pt_BR       
 TUTORIAL.ro
-TUTORIAL.ru          
+TUTORIAL.ru          Alex Ott
 TUTORIAL.sk          
 TUTORIAL.sl          Primoz PETERLIN
 TUTORIAL.sv          Mats Lidell
@@ -125,48 +163,48 @@ TUTORIAL.zh
 ** Check the manual.
 
 abbrevs.texi      cyd
-ack.texi          
+ack.texi          rgm
 anti.texi         cyd
 arevert-xtra.texi cyd
 basic.texi        cyd
 buffers.texi      cyd
 building.texi     cyd
-calendar.texi     
-cal-xtra.texi     
+calendar.texi     rgm
+cal-xtra.texi     rgm
 cmdargs.texi      cyd
 commands.texi     cyd
 custom.texi       cyd
 dired.texi        cyd
-dired-xtra.texi
+dired-xtra.texi   rgm
 display.texi      cyd
-emacs.texi        
-emacs-xtra.texi
-emerge-xtra.texi
+emacs.texi        rgm
+emacs-xtra.texi   rgm
+emerge-xtra.texi  rgm
 entering.texi     cyd
 files.texi        cyd
 fixit.texi        cyd
-fortran-xtra.texi 
+fortran-xtra.texi rgm
 frames.texi       cyd
-glossary.texi
+glossary.texi     rgm
 help.texi         cyd
 indent.texi       cyd
 killing.texi      cyd
 kmacro.texi       cyd
-macos.texi        
+macos.texi        rgm  (can't actually test any of it though)
 maintaining.texi  cyd
 mark.texi         cyd
-mini.texi         
+mini.texi         rgm
 misc.texi         cyd
 modes.texi        cyd
-msdog.texi        
-msdog-xtra.texi   
-mule.texi         
+msdog.texi        rgm  (can't actually test any of it though)
+msdog-xtra.texi   rgm  (can't actually test any of it though)
+mule.texi         rgm  (not 100% sure about "Fontsets")
 m-x.texi          cyd
 package.texi      cyd
-picture-xtra.texi
+picture-xtra.texi rgm
 programs.texi     cyd
 regs.texi         cyd
-rmail.texi        
+rmail.texi        rgm
 screen.texi       cyd
 search.texi       cyd
 sending.texi      cyd
@@ -179,61 +217,55 @@ xresources.texi   cyd
 
 ** Check the Lisp manual.
 
-abbrevs.texi      
-advice.texi       
-anti.texi         
-back.texi
-backups.texi      
-buffers.texi      
-commands.texi     
-compile.texi      
+abbrevs.texi      rgm
+anti.texi         rgm
+back.texi         rgm
+backups.texi      cyd
+buffers.texi      cyd
+commands.texi     cyd
+compile.texi      cyd
 control.texi      cyd
-customize.texi    
-debugging.texi    
-display.texi      
-edebug.texi
+customize.texi    cyd
+debugging.texi    cyd
+display.texi      cyd
+edebug.texi       rgm
 elisp.texi
-errors.texi       
+errors.texi       rgm
 eval.texi         cyd
-files.texi        
-frames.texi       
+files.texi        cyd
+frames.texi       cyd
 functions.texi    cyd
 hash.texi         cyd
-help.texi         
-hooks.texi        
+help.texi         cyd
+hooks.texi        rgm
 index.texi
-internals.texi    
+internals.texi    rgm  cyd
 intro.texi        cyd
-keymaps.texi      
+keymaps.texi      cyd
 lists.texi        cyd
-loading.texi      
-locals.texi       
+loading.texi      cyd
 macros.texi       cyd
-maps.texi         
-markers.texi      
-minibuf.texi      
-modes.texi        
-nonascii.texi     
+maps.texi         rgm
+markers.texi      rgm
+minibuf.texi      rgm
+modes.texi        cyd
+nonascii.texi     cyd
 numbers.texi      cyd
 objects.texi      cyd
-os.texi           
-package.texi
-positions.texi    
-processes.texi
-searching.texi    
+os.texi           cyd
+package.texi      rgm
+positions.texi    cyd
+processes.texi    rgm
+searching.texi    rgm
 sequences.texi    cyd
-streams.texi      
+streams.texi      cyd
 strings.texi      cyd
 symbols.texi      cyd
-syntax.texi       
-text.texi         
-tips.texi         
+syntax.texi       cyd
+text.texi         cyd
+tips.texi         rgm
 variables.texi    cyd
-windows.texi      
-
-* PLANNED ADDITIONS
-* pov-mode (probably not for Emacs-23: waiting for a Free POV-Ray).
-** gas-mode ?
+windows.texi      rgm (skimmed)
 
 \f
 Local variables: