Checked lispref/internals.texi, somewhat
[bpt/emacs.git] / admin / FOR-RELEASE
dissimilarity index 71%
index 9388e76..85c2528 100644 (file)
-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/.
-
-** Ask maintainers of refcard translations to update them.
-
-Emacs 22 translators:
-
-LANG   Translator            Status
-cs     Pavel Janík           
-de     Sven Joachim          
-fr     Eric Jacoboni         
-pl     Włodek Bzyl           
-pt-br  Rodrigo Real          
-ru     Alex Ott              
-sk     Miroslav Vaško        
-
-** Remove temporary +++/--- lines in NEWS.
-
-** Try to reorder NEWS: most important things first, related items together.
-
-* BUGS
-
-** Does deleting frames run Lisp code?  If so, can we get rid of that?
-It is a dangerous design.
-http://lists.gnu.org/archive/html/emacs-devel/2007-09/msg01330.html
-
-** Why were the calls to x_fully_uncatch_errors commented out in eval.c?
-http://lists.gnu.org/archive/html/emacs-devel/2007-09/msg01987.html
-
-** 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.
-
-** 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:
-
-1. Gnus binds `M-s' to `gnus-summary-search-article-forward'.
-
-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
-   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
-   `log-edit-comment-search-forward'.  Perhaps search commands
-   on the global key binding `M-s' are useless in these modes.
-
-** sdl.web@gmail.com, 30 Oct: ps-lpr-switches has no effect
-http://lists.gnu.org/archive/html/emacs-devel/2007-10/msg02091.html
-
-Fixed by this change?
-
-2007-11-09  Vinicius Jose Latorre  <viniciusjl@ig.com.br>
-
-       * ps-print.el: [...]
-       (ps-do-despool): If ps-lpr-switches is not a list, force it to be one.
-
-** In C, use EMACS_INT for variables and structure members
-for buffer/string positions.  E.g. struct it, struct text_pos.
-
-* DOCUMENTATION
-
-** Clean up Emacs.app references in code and documentation.
-
-** Document new font backend
-
-** Document XEmbed support
-
-** Check the Emacs Tutorial.
-
-The first line of every tutorial must begin with text ending in a
-period (".", ASCII 0x2E) saying "Emacs Tutorial" in the respective
-language. This should be followed by "See end for copying conditions",
-likewise in the respective language.
-
-After each file name, on the same line or the following line, come the
-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
-
-** Check the manual.
-
-abbrevs.texi      -- cyd
-ack.texi          -- rgm
-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
-dired-xtra.texi
-display.texi      -- cyd
-emacs.texi        -- cyd
-emacs-xtra.texi
-emerge-xtra.texi
-entering.texi     -- cyd
-files.texi        -- cyd
-fixit.texi        -- cyd
-fortran-xtra.texi -- rgm
-frames.texi       -- cyd
-glossary.texi
-help.texi         -- cyd
-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         -- cyd
-msdog.texi        -- eliz
-msdog-xtra.texi   -- eliz
-mule.texi         -- cyd
-m-x.texi          -- cyd
-programs.texi     -- cyd
-regs.texi         -- cyd
-rmail.texi        -- rgm
-screen.texi       -- cyd
-search.texi       -- cyd
-sending.texi      -- rgm (maybe needs some brief mailclient.el details in
-                          "Mail Sending" section?)
-text.texi         -- cyd
-trouble.texi      -- cyd
-windows.texi      -- rudalics
-xresources.texi   -- cyd
-
-** Check the Lisp manual.
-
-abbrevs.texi      -- cyd
-advice.texi       -- cyd
-anti.texi         -- cyd
-back.texi
-backups.texi      -- cyd
-buffers.texi      -- cyd
-commands.texi     -- cyd
-compile.texi      -- cyd
-control.texi      -- cyd
-customize.texi    -- cyd
-debugging.texi    -- cyd
-display.texi      -- cyd
-edebug.texi
-elisp.texi
-errors.texi       -- cyd
-eval.texi         -- cyd
-files.texi        -- cyd
-frames.texi       -- cyd
-functions.texi    -- cyd
-hash.texi         -- cyd
-help.texi         -- cyd
-hooks.texi        -- cyd
-index.texi
-internals.texi    -- cyd
-intro.texi        -- cyd
-keymaps.texi      -- cyd
-lists.texi        -- cyd
-loading.texi      -- cyd
-locals.texi       -- cyd
-macros.texi       -- cyd
-maps.texi         -- cyd
-markers.texi      -- cyd
-minibuf.texi      -- cyd
-modes.texi        -- cyd
-nonascii.texi     -- cyd
-numbers.texi      -- cyd
-objects.texi      -- cyd
-os.texi           -- cyd
-positions.texi    -- cyd
-processes.texi
-searching.texi    -- cyd
-sequences.texi    -- cyd
-streams.texi      -- cyd
-strings.texi      -- cyd
-symbols.texi      -- cyd
-syntax.texi       -- cyd
-text.texi         -- cyd
-tips.texi         -- cyd
-variables.texi    -- cyd
-windows.texi      -- rudalics
-
-* 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 ?
-
-\f
-Local variables:
-mode: outline
-coding: utf-8
-end:
+Tasks needed before the next release.
+
+* TO BE DONE SHORTLY BEFORE RELEASE
+
+** 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 "(progn (require 'info) (setq Info-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.
+
+Emacs 22 translators:
+
+LANG   Translator            Status
+cs     Pavel Janík           
+de     Sven Joachim          
+fr     Eric Jacoboni         
+pl     Włodek Bzyl           
+pt-br  Rodrigo Real          
+ru     Alex Ott              
+sk     Miroslav Vaško        
+
+** Remove temporary +++/--- lines in NEWS.
+
+** Try to reorder NEWS: most important things first, related items together.
+
+** Consider bumping customize-changed-options-previous-release.
+
+* 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:
+
+1. Gnus binds `M-s' to `gnus-summary-search-article-forward'.
+
+2. Minibuffer binds `M-s' to `next-matching-history-element'
+   (not useful any more since C-s can now search in the history).
+
+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').
+
+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.
+
+5. Rmail binds `\es' to `rmail-search'/`rmail-summary-search'.
+
+
+* DOCUMENTATION
+
+** Check the Emacs Tutorial.
+
+The first line of every tutorial must begin with text ending in a
+period (".", ASCII 0x2E) saying "Emacs Tutorial" in the respective
+language. This should be followed by "See end for copying conditions",
+likewise in the respective language.
+
+After each file name, on the same line or the following line, come the
+names of the people who have checked it.
+
+SECTION                  READERS
+----------------------------------
+TUTORIAL             cyd
+TUTORIAL.bg          ogi
+TUTORIAL.cn
+TUTORIAL.cs          
+TUTORIAL.de          wl
+TUTORIAL.eo
+TUTORIAL.es          
+TUTORIAL.fr          
+TUTORIAL.he          eliz
+TUTORIAL.it          
+TUTORIAL.ja             
+TUTORIAL.ko
+TUTORIAL.nl         Pieter Schoenmakers
+TUTORIAL.pl          
+TUTORIAL.pt_BR       
+TUTORIAL.ro
+TUTORIAL.ru          Alex Ott
+TUTORIAL.sk          
+TUTORIAL.sl          Primoz PETERLIN
+TUTORIAL.sv          Mats Lidell
+TUTORIAL.th          
+TUTORIAL.zh
+
+** Check the manual.
+
+abbrevs.texi      cyd
+ack.texi          rgm
+anti.texi         cyd
+arevert-xtra.texi cyd
+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
+dired-xtra.texi   rgm
+display.texi      cyd
+emacs.texi        rgm
+emacs-xtra.texi   rgm
+emerge-xtra.texi  rgm
+entering.texi     cyd
+files.texi        cyd
+fixit.texi        cyd
+fortran-xtra.texi rgm
+frames.texi       cyd
+glossary.texi
+help.texi         cyd
+indent.texi       cyd
+killing.texi      cyd
+kmacro.texi       cyd
+macos.texi        rgm  (can't actually test any of it though)
+maintaining.texi  cyd
+mark.texi         cyd
+mini.texi         rgm
+misc.texi         cyd
+modes.texi        cyd
+msdog.texi        rgm  (can't actually test any of it though)
+  It was not obvious to me that the following is true (it could well be though):
+
+   Emacs on Windows automatically determines your default printer and
+   sets the variable `printer-name' to that printer's name.
+
+msdog-xtra.texi   rgm  (can't actually test any of it though)
+mule.texi         
+m-x.texi          cyd
+package.texi      cyd
+picture-xtra.texi rgm
+programs.texi     cyd
+regs.texi         cyd
+rmail.texi        rgm
+screen.texi       cyd
+search.texi       cyd
+sending.texi      cyd
+text.texi         cyd
+trouble.texi      cyd
+vc-xtra.texi      cyd
+vc1-xtra.texi     cyd
+windows.texi      cyd
+xresources.texi   cyd
+
+** Check the Lisp manual.
+
+abbrevs.texi      
+advice.texi       cyd
+anti.texi         
+back.texi
+backups.texi      cyd
+buffers.texi      cyd
+commands.texi     cyd
+compile.texi      cyd
+control.texi      cyd
+customize.texi    cyd
+debugging.texi    cyd
+display.texi      
+edebug.texi
+elisp.texi
+errors.texi       rgm
+eval.texi         cyd
+files.texi        cyd
+frames.texi       
+functions.texi    cyd
+hash.texi         cyd
+help.texi         cyd
+hooks.texi        rgm
+index.texi
+internals.texi    rgm  (I don't know much about this, so it would be
+    good if someone else could at least look at the FIXME? comments.)
+intro.texi        cyd
+keymaps.texi      cyd
+lists.texi        cyd
+loading.texi      cyd
+macros.texi       cyd
+maps.texi         rgm
+markers.texi      
+minibuf.texi      
+modes.texi        cyd
+nonascii.texi     
+numbers.texi      cyd
+objects.texi      cyd
+os.texi           
+package.texi
+positions.texi    
+processes.texi
+searching.texi    
+sequences.texi    cyd
+streams.texi      cyd
+strings.texi      cyd
+symbols.texi      cyd
+syntax.texi       cyd
+text.texi         
+tips.texi         rgm
+variables.texi    cyd
+windows.texi      
+
+\f
+Local variables:
+mode: outline
+coding: utf-8
+end: