Copyedits and updates for Emacs manual's first few chapters.
[bpt/emacs.git] / admin / FOR-RELEASE
index 8b868c1..4481d8c 100644 (file)
@@ -2,10 +2,43 @@ Tasks needed before the next release.
 
 * TO BE DONE SHORTLY BEFORE RELEASE
 
-** Check for widow and orphan lines in manuals;
-make sure all the pages really look ok in the manual as formatted.
-
-** Regenerate the pdf versions of the reference cards in etc/refcards/.
+** Manuals
+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 '(\".\"))" \
+  -f info-xref-check-all
+
+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
+them if a simple rephrasing or rearrangement will work.
+
+Update the master menu and detailed menu (eg the antinews version).
+The command texinfo-multiple-files-update can do this, but you
+probably want to apply the results selectively (eg the current master
+menu has better line-breaks than the automatic version).  It includes
+the menu-entry name (if there is one) as well as the node name - using
+only the latter looks better.  Also, it doesn't seem to handle nested
+includes, so will miss edebug.texi etc.
+
+Check for widow and orphan lines in the printed manual; make sure all
+the pages really look ok in the manual as formatted.  Orphans/widows
+are cases where the first/last line of a paragraph is on its own at
+the end/start of a page, or where the last word in a paragraph is on
+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.
+
+** 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.
+The Makefile rules did not work for me, I had to use something like:
+csplain -output-format=pdf cs-refcard
 
 ** Ask maintainers of refcard translations to update them.
 
@@ -24,6 +57,8 @@ sk    Miroslav Vaško
 
 ** Try to reorder NEWS: most important things first, related items together.
 
+** Consider bumping customize-changed-options-previous-release.
+
 * BUGS
 
 ** Does deleting frames run Lisp code?  If so, can we get rid of that?
@@ -46,16 +81,12 @@ and change key bindings where necessary.  The current list of modes:
 2. Minibuffer binds `M-s' to `next-matching-history-element'
    (not useful any more since C-s can now search in the history).
 
-3. Shell mode binds `M-s' to `comint-next-matching-input'.
-   This key binding can be changed later when we will implement
-   incremental search through the shell history.
-
-4. `center-line' in Text mode was already moved to the text formatting
+3. `center-line' in Text mode was already moved to the text formatting
    keymap as `M-o M-s' (thus this binding is not necessary any more
    in `nroff-mode-map' too and can be removed now from the nroff mode
    because it can now use the global key binding `M-o M-s' `center-line').
 
-5. PCL-CVS binds `M-s' to `cvs-status', and log-edit-mode binds it to
+4. PCL-CVS binds `M-s' to `cvs-status', and log-edit-mode binds it to
    `log-edit-comment-search-forward'.  Perhaps search commands
    on the global key binding `M-s' are useless in these modes.
 
@@ -92,137 +123,139 @@ names of the people who have checked it.
 
 SECTION                  READERS
 ----------------------------------
-etc/TUTORIAL             
-etc/TUTORIAL.bg          
-etc/TUTORIAL.cn
-etc/TUTORIAL.cs          
-etc/TUTORIAL.de          
-etc/TUTORIAL.eo
-etc/TUTORIAL.es          
-etc/TUTORIAL.fr          
-etc/TUTORIAL.it          
-etc/TUTORIAL.ja                 
-etc/TUTORIAL.ko
-etc/TUTORIAL.nl                 
-etc/TUTORIAL.pl          
-etc/TUTORIAL.pt_BR       
-etc/TUTORIAL.ro
-etc/TUTORIAL.ru          
-etc/TUTORIAL.sk          
-etc/TUTORIAL.sl          
-etc/TUTORIAL.sv          
-etc/TUTORIAL.th          
-etc/TUTORIAL.zh
+TUTORIAL             
+TUTORIAL.bg          
+TUTORIAL.cn
+TUTORIAL.cs          
+TUTORIAL.de          
+TUTORIAL.eo
+TUTORIAL.es          
+TUTORIAL.fr          
+TUTORIAL.he
+TUTORIAL.it          
+TUTORIAL.ja             
+TUTORIAL.ko
+TUTORIAL.nl             
+TUTORIAL.pl          
+TUTORIAL.pt_BR       
+TUTORIAL.ro
+TUTORIAL.ru          
+TUTORIAL.sk          
+TUTORIAL.sl          
+TUTORIAL.sv          
+TUTORIAL.th          
+TUTORIAL.zh
 
 ** Check the manual.
 
-abbrevs.texi      -- cyd
-ack.texi          -- rgm
+abbrevs.texi      
+ack.texi          
 anti.texi
 arevert-xtra.texi
-basic.texi        -- cyd
-buffers.texi      -- cyd
-building.texi     -- cyd
-calendar.texi     -- rgm
-cal-xtra.texi     -- rgm
-cmdargs.texi      -- cyd
-commands.texi     -- cyd
-custom.texi       -- cyd
-dired.texi        -- cyd
+basic.texi        
+buffers.texi      
+building.texi     
+calendar.texi     
+cal-xtra.texi     
+cmdargs.texi      
+commands.texi     cyd
+custom.texi       
+dired.texi        
 dired-xtra.texi
-display.texi      -- cyd
-emacs.texi        -- cyd
+display.texi      
+emacs.texi        
 emacs-xtra.texi
 emerge-xtra.texi
-entering.texi     -- cyd
-files.texi
-fixit.texi        -- cyd
-fortran-xtra.texi -- rgm
-frames.texi       -- cyd
+entering.texi     cyd
+files.texi        
+fixit.texi        
+fortran-xtra.texi 
+frames.texi       
 glossary.texi
-help.texi
-indent.texi       -- cyd
-killing.texi      -- cyd
-kmacro.texi       -- cyd
-macos.texi     -- contents need to be evaluated and see what is still
- relevant after the NS merge.
-maintaining.texi  -- cyd
-major.texi        -- cyd
-mark.texi         -- cyd
-mini.texi         -- cyd
-misc.texi
-msdog.texi
-msdog-xtra.texi
-mule.texi
-m-x.texi          -- cyd
-programs.texi     -- cyd
-regs.texi         -- cyd
-rmail.texi        -- rgm
-screen.texi       -- cyd
-search.texi       -- cyd
-sending.texi
-text.texi         -- cyd
-trouble.texi
-windows.texi      -- rudalics
-xresources.texi
+help.texi         
+indent.texi       
+killing.texi      
+kmacro.texi       
+macos.texi        
+maintaining.texi  
+major.texi        
+mark.texi         
+mini.texi         
+misc.texi         
+msdog.texi        
+msdog-xtra.texi   
+mule.texi         
+m-x.texi          
+picture-xtra.texi
+programs.texi     
+regs.texi         
+rmail.texi        
+screen.texi       cyd
+search.texi       
+sending.texi      
+text.texi         
+trouble.texi      
+vc-xtra.texi
+vc1-xtra.texi
+windows.texi      
+xresources.texi   
 
 ** Check the Lisp manual.
 
-abbrevs.texi
-advice.texi       -- cyd
-anti.texi
+abbrevs.texi      
+advice.texi       
+anti.texi         
 back.texi
-backups.texi
-buffers.texi
-commands.texi
-compile.texi      -- cyd
-control.texi      -- cyd
-customize.texi    -- cyd
-debugging.texi
-display.texi
+backups.texi      
+buffers.texi      
+commands.texi     
+compile.texi      
+control.texi      
+customize.texi    
+debugging.texi    
+display.texi      
 edebug.texi
 elisp.texi
-errors.texi
-eval.texi         -- cyd
-files.texi
-frames.texi
-functions.texi    -- cyd
-hash.texi         -- cyd
-help.texi
-hooks.texi
+errors.texi       
+eval.texi         
+files.texi        
+frames.texi       
+functions.texi    
+hash.texi         
+help.texi         
+hooks.texi        
 index.texi
-internals.texi
-intro.texi        -- cyd
-keymaps.texi
-lists.texi        -- cyd
-loading.texi      -- cyd
-locals.texi
-macros.texi       -- cyd
-maps.texi
-markers.texi
-minibuf.texi
-modes.texi
-nonascii.texi
-numbers.texi      -- cyd
-objects.texi      -- cyd
-os.texi
-positions.texi
+internals.texi    
+intro.texi        
+keymaps.texi      
+lists.texi        
+loading.texi      
+locals.texi       
+macros.texi       
+maps.texi         
+markers.texi      
+minibuf.texi      
+modes.texi        
+nonascii.texi     
+numbers.texi      
+objects.texi      
+os.texi           
+package.texi
+positions.texi    
 processes.texi
-searching.texi
-sequences.texi    -- cyd
-streams.texi
-strings.texi      -- cyd
-symbols.texi      -- cyd
-syntax.texi
-text.texi
-tips.texi
-variables.texi    -- cyd
-windows.texi
+searching.texi    
+sequences.texi    
+streams.texi      
+strings.texi      
+symbols.texi      
+syntax.texi       
+text.texi         
+tips.texi         
+variables.texi    
+windows.texi      
 
 * PLANNED ADDITIONS
 
-** CEDET (not for 23.1 due to paperwork issues, perhaps for 23.2)
-** js2-mode
 ** pov-mode (probably not for Emacs-23: waiting for a Free POV-Ray).
 ** gas-mode ?