[Emacs-diffs] /srv/bzr/emacs/trunk r107475: Checked lispref/hooks.texi

[Glenn Morris]

------------------------------------------------------------
revno: 107475
committer: Glenn Morris <address@hidden>
branch nick: trunk
timestamp: Thu 2012-03-01 21:52:40 -0500
message:
  Checked lispref/hooks.texi
  
  * doc/lispref/hooks.texi (Standard Hooks): General update.
  Put related hooks together.
  
  * doc/lispref/commands.texi (Keyboard Macros):
  Remove cross-ref to Standard Hooks.
  
  * doc/lispref/modes.texi (Hooks): Tweak cross-ref description.
  Remove non-standard file-local fill-column (r100251).
  
  * admin/FOR-RELEASE: Related markup.
modified:
  admin/FOR-RELEASE
  doc/lispref/ChangeLog
  doc/lispref/commands.texi
  doc/lispref/hooks.texi
  doc/lispref/modes.texi

=== modified file 'admin/FOR-RELEASE'
--- a/admin/FOR-RELEASE 2012-03-01 07:29:48 +0000
+++ b/admin/FOR-RELEASE 2012-03-02 02:52:40 +0000
@@ -201,7 +201,7 @@
 functions.texi    cyd
 hash.texi         cyd
 help.texi         cyd
-hooks.texi        
+hooks.texi        rgm
 index.texi
 internals.texi    
 intro.texi        cyd

=== modified file 'doc/lispref/ChangeLog'
--- a/doc/lispref/ChangeLog     2012-03-01 08:21:32 +0000
+++ b/doc/lispref/ChangeLog     2012-03-02 02:52:40 +0000
@@ -1,3 +1,10 @@
+2012-03-02  Glenn Morris  <address@hidden>
+
+       * hooks.texi (Standard Hooks): General update.
+       Put related hooks together.  Add and remove items.
+       * commands.texi (Keyboard Macros): Remove cross-ref to Standard Hooks.
+       * modes.texi (Hooks): Tweak cross-ref description.
+
 2012-03-01  Michael Albinus  <address@hidden>
 
        * files.texi (Kinds of Files): The return value of file-equal-p is

=== modified file 'doc/lispref/commands.texi'
--- a/doc/lispref/commands.texi 2012-02-11 13:32:02 +0000
+++ b/doc/lispref/commands.texi 2012-03-02 02:52:40 +0000
@@ -1,7 +1,6 @@
 @c -*-texinfo-*-
 @c This is part of the GNU Emacs Lisp Reference Manual.
address@hidden Copyright (C) 1990-1995, 1998-1999, 2001-2012
address@hidden   Free Software Foundation, Inc.
address@hidden Copyright (C) 1990-1995, 1998-1999, 2001-2012 Free Software 
Foundation, Inc.
 @c See the file elisp.texi for copying conditions.
 @setfilename ../../info/commands
 @node Command Loop, Keymaps, Minibuffers, Top
@@ -3430,7 +3429,7 @@
 @end defvar
 
 @defvar kbd-macro-termination-hook
-This normal hook (@pxref{Standard Hooks}) is run when a keyboard
-macro terminates, regardless of what caused it to terminate (reaching
-the macro end or an error which ended the macro prematurely).
+This normal hook is run when a keyboard macro terminates, regardless
+of what caused it to terminate (reaching the macro end or an error
+which ended the macro prematurely).
 @end defvar

=== modified file 'doc/lispref/hooks.texi'
--- a/doc/lispref/hooks.texi    2012-03-01 07:31:15 +0000
+++ b/doc/lispref/hooks.texi    2012-03-02 02:52:40 +0000
@@ -8,7 +8,7 @@
 @cindex standard hooks
 @cindex hook variables, list of
 
-The following is a list of hook variables that let you provide
+The following is a list of some hook variables that let you provide
 functions to be called from within Emacs on suitable occasions.
 
 Most of these variables have names ending with @samp{-hook}.  They are
@@ -18,85 +18,92 @@
 to put a new function on such a hook is to call @code{add-hook}.
 @xref{Hooks}, for more information about using hooks.
 
-Every major mode defines a mode hook named
address@hidden@var{modename}-mode-hook}.  The major mode command runs this
-normal hook with @code{run-mode-hooks} as the very last thing it does.
address@hidden Hooks}.  Most minor modes have mode hooks too.  Mode hooks
-are omitted from the list below.
-
 The variables whose names end in @samp{-hooks} or @samp{-functions} are
 usually @dfn{abnormal hooks}; their values are lists of functions, but
 these functions are called in a special way (they are passed arguments,
 or their values are used). The variables whose names end in
 @samp{-function} have single functions as their values.
 
+This is not an exhaustive list, it only covers the more general hooks.
+For example, every major mode defines a hook named
address@hidden@var{modename}-mode-hook}.  The major mode command runs this
+normal hook with @code{run-mode-hooks} as the very last thing it does.
address@hidden Hooks}.  Most minor modes have mode hooks too.
+
 A special feature allows you to specify expressions to evaluate if and
 when a file is loaded (@pxref{Hooks for Loading}).  That feature is
 not exactly a hook, but does a similar job.
 
address@hidden We need to xref to where each hook is documented or else document
address@hidden it here.
address@hidden We need to xref to where each hook is documented or else 
document it here.
address@hidden Add vindex for anything not indexed elsewhere.
address@hidden This list is in alphabetical order, grouped by topic.
address@hidden TODO It should probably be more thoroughly ordered by topic.
 
 @table @code
address@hidden abbrev-expand-functions
address@hidden Expansion}.
-
 @item activate-mark-hook
address@hidden deactivate-mark-hook
 @xref{The Mark}.
 
 @item after-change-functions
address@hidden before-change-functions
address@hidden first-change-hook
 @xref{Change Hooks}.
 
 @item after-change-major-mode-hook
address@hidden change-major-mode-after-body-hook
 @xref{Mode Hooks}.
 
 @item after-init-hook
address@hidden before-init-hook
address@hidden emacs-startup-hook
 @xref{Init File}.
 
 @item after-insert-file-functions
address@hidden write-region-annotate-functions
address@hidden write-region-post-annotation-function
 @xref{Format Conversion}.
 
 @item after-make-frame-functions
address@hidden before-make-frame-hook
 @xref{Creating Frames}.
 
address@hidden Not general enough?
address@hidden
 @item after-revert-hook
address@hidden before-revert-hook
address@hidden buffer-stale-function
address@hidden revert-buffer-function
address@hidden revert-buffer-insert-file-contents-function
 @xref{Reverting}.
address@hidden ignore
 
 @item after-save-hook
address@hidden before-save-hook
address@hidden write-contents-functions
address@hidden write-file-functions
 @xref{Saving Buffers}.
 
address@hidden auto-fill-function
address@hidden Filling}.
address@hidden after-setting-font-hook
address@hidden after-setting-font-hook
+Hook run after a frame's font changes.
 
 @item auto-save-hook
 @xref{Auto-Saving}.
 
address@hidden before-change-functions
address@hidden Hooks}.
-
 @item before-hack-local-variables-hook
address@hidden hack-local-variables-hook
 @xref{File Local Variables}.
 
address@hidden before-init-hook
address@hidden File}.
-
address@hidden before-make-frame-hook
address@hidden Frames}.
-
address@hidden before-revert-hook
address@hidden
-
address@hidden before-save-hook
address@hidden Buffers}.
-
address@hidden blink-paren-function
address@hidden
-
 @item buffer-access-fontify-functions
 @xref{Lazy Properties}.
 
address@hidden change-major-mode-after-body-hook
address@hidden Hooks}.
address@hidden buffer-list-update-hook
address@hidden buffer-list-update-hook
+Hook run when the buffer list changes.
+
address@hidden buffer-quit-function
address@hidden buffer-quit-function
+Function to call to ``quit'' the current buffer.
 
 @item change-major-mode-hook
 @xref{Creating Buffer-Local}.
@@ -104,151 +111,175 @@
 @item command-line-functions
 @xref{Command-Line Arguments}.
 
address@hidden comment-indent-function
address@hidden for Comments,, Options Controlling Comments, emacs, the
-GNU Emacs Manual}.
-
address@hidden compilation-finish-functions
-Functions to call when a compilation process finishes.
-
address@hidden custom-define-hook
-Hook called after defining each customize option.
-
address@hidden deactivate-mark-hook
address@hidden Mark}.
address@hidden delayed-warnings-hook
address@hidden delayed-warnings-hook
+The command loop runs this soon after @code{post-command-hook} (q.v.).
 
 @item delete-frame-functions
-Functions to call when Emacs deletes a frame.  @xref{Deleting Frames}.
address@hidden Frames}.
 
 @item delete-terminal-functions
-Functions to call when Emacs deletes a terminal.  @xref{Multiple Terminals}.
address@hidden Terminals}.
 
address@hidden
 @item disabled-command-function
 @xref{Disabling Commands}.
address@hidden ignore
+
address@hidden display-buffer-function
address@hidden pop-up-frame-function
address@hidden special-display-function
address@hidden split-window-preferred-function
address@hidden Window Options}.
 
 @item echo-area-clear-hook
 @xref{Echo Area Customization}.
 
address@hidden emacs-startup-hook
address@hidden File}.
-
 @item find-file-hook
address@hidden Functions}.
-
address@hidden find-file-not-found-functions
address@hidden Functions}.
-
address@hidden first-change-hook
address@hidden Hooks}.
-
address@hidden font-lock-beginning-of-syntax-function
address@hidden Font Lock}.
address@hidden find-file-not-found-functions
address@hidden Functions}.
+
address@hidden font-lock-extend-after-change-region-function
address@hidden to Refontify}.
+
address@hidden font-lock-extend-region-functions
address@hidden Font Lock}.
 
 @item font-lock-fontify-buffer-function
address@hidden Font Lock Variables}.
-
address@hidden font-lock-fontify-region-function
address@hidden Font Lock Variables}.
-
address@hidden font-lock-mark-block-function
address@hidden Font Lock Variables}.
-
address@hidden font-lock-syntactic-face-function
address@hidden Font Lock}.
-
address@hidden font-lock-unfontify-buffer-function
address@hidden Font Lock Variables}.
-
address@hidden hack-local-variables-hook
address@hidden Local Variables}.
-
address@hidden font-lock-unfontify-region-function
address@hidden Font Lock Variables}.
-
address@hidden kbd-macro-termination-hook
address@hidden Macros}.
address@hidden font-lock-fontify-region-function
address@hidden font-lock-mark-block-function
address@hidden font-lock-unfontify-buffer-function
address@hidden font-lock-unfontify-region-function
address@hidden Font Lock Variables}.
+
address@hidden fontification-functions
address@hidden Faces,, Automatic Face Assignment}.
+
address@hidden frame-auto-hide-function
address@hidden Windows}.
 
 @item kill-buffer-hook
address@hidden Buffers}.
-
address@hidden kill-buffer-query-functions
address@hidden kill-buffer-query-functions
 @xref{Killing Buffers}.
 
 @item kill-emacs-hook
address@hidden Emacs}.
-
address@hidden kill-emacs-query-functions
address@hidden Emacs}.
-
address@hidden mail-setup-hook
address@hidden Misc,, Mail Miscellany, emacs, the GNU Emacs Manual}.
address@hidden kill-emacs-query-functions
address@hidden Emacs}.
 
 @item menu-bar-update-hook
 @xref{Menu Bar}.
 
 @item minibuffer-setup-hook
address@hidden minibuffer-exit-hook
 @xref{Minibuffer Misc}.
 
address@hidden minibuffer-exit-hook
address@hidden Misc}.
address@hidden mouse-leave-buffer-hook
address@hidden mouse-leave-buffer-hook
+Hook run when about to switch windows with a mouse command.
 
 @item mouse-position-function
 @xref{Mouse Position}.
 
 @item post-command-hook
address@hidden pre-command-hook
 @xref{Command Overview}.
 
address@hidden post-gc-hook
address@hidden Collection}.
+
 @item post-self-insert-hook
 @xref{Keymaps and Minor Modes}.
 
address@hidden pre-command-hook
address@hidden Overview}.
-
address@hidden
 @item prog-mode-hook
address@hidden special-mode-hook
address@hidden special-mode-hook
 @xref{Basic Major Modes}.
-
address@hidden resume-tty-functions
address@hidden Emacs}.
address@hidden ignore
 
 @item suspend-hook
address@hidden Emacs}.
-
address@hidden suspend-resume-hook
address@hidden Emacs}.
-
address@hidden suspend-tty-functions
address@hidden Emacs}.
address@hidden suspend-resume-hook
address@hidden suspend-tty-functions
address@hidden resume-tty-functions
address@hidden Emacs}.
+
address@hidden syntax-begin-function
address@hidden syntax-propertize-extend-region-functions
address@hidden syntax-propertize-function
address@hidden font-lock-syntactic-face-function
address@hidden Font Lock}.  @xref{Syntax Properties}.
 
 @item temp-buffer-setup-hook
address@hidden Displays}.
-
address@hidden temp-buffer-show-function
address@hidden Displays}.
-
address@hidden temp-buffer-show-hook
address@hidden temp-buffer-show-function
address@hidden temp-buffer-show-hook
 @xref{Temporary Displays}.
 
 @item term-setup-hook
 @xref{Terminal-Specific}.
 
 @item window-configuration-change-hook
address@hidden Hooks}.
-
address@hidden window-scroll-functions
address@hidden window-scroll-functions
address@hidden window-size-change-functions
 @xref{Window Hooks}.
 
 @item window-setup-hook
 @xref{Window Systems}.
 
address@hidden window-size-change-functions
address@hidden Hooks}.
-
address@hidden write-contents-functions
address@hidden Buffers}.
-
address@hidden write-file-functions
address@hidden Buffers}.
-
address@hidden write-region-annotate-functions
address@hidden Conversion}.
address@hidden window-text-change-functions
address@hidden window-text-change-functions
+Functions to call in redisplay when text in the window might change.
+
 @end table
+
address@hidden
+Some -hook, -function, -functions from preloaded Lisp or C files that
+I thought did not need to be mentioned here:
+
+Lisp:
+after-load-functions
+auto-coding-functions
+choose-completion-string-functions
+completing-read-function
+completion-annotate-function
+completion-at-point-functions
+completion-in-region-functions
+completion-list-insert-choice-function
+describe-current-input-method-function
+filter-buffer-substring-functions
+font-lock-function
+inactivate-current-input-method-function
+menu-bar-select-buffer-function
+read-file-name-function
+replace-re-search-function
+replace-search-function
+yank-undo-function
+
+C hooks:
+kbd-macro-termination-hook
+signal-hook-function
+
+C functions:
+redisplay-end-trigger-functions
+x-lost-selection-functions
+x-sent-selection-functions
+
+C function:
+auto-composition-function
+auto-fill-function
+command-error-function
+compose-chars-after-function
+composition-function-table
+deferred-action-function
+input-method-function
+load-read-function
+load-source-file-function
+macro-declaration-function
+read-buffer-function
+ring-bell-function
+select-safe-coding-system-function
+set-auto-coding-function
+show-help-function
+signal-hook-function
+undo-outer-limit-function
+
address@hidden ignore

=== modified file 'doc/lispref/modes.texi'
--- a/doc/lispref/modes.texi    2012-02-26 09:08:19 +0000
+++ b/doc/lispref/modes.texi    2012-03-02 02:52:40 +0000
@@ -1,6 +1,6 @@
 @c -*-texinfo-*-
 @c This is part of the GNU Emacs Lisp Reference Manual.
address@hidden Copyright (C) 1990-1995, 1998-1999, 2001-2012  Free Software 
Foundation, Inc.
address@hidden Copyright (C) 1990-1995, 1998-1999, 2001-2012 Free Software 
Foundation, Inc.
 @c See the file elisp.texi for copying conditions.
 @setfilename ../../info/modes
 @node Modes, Documentation, Keymaps, Top
@@ -38,7 +38,7 @@
 to be called on a particular occasion by an existing program.  Emacs
 provides hooks for the sake of customization.  Most often, hooks are set
 up in the init file (@pxref{Init File}), but Lisp programs can set them also.
address@hidden Hooks}, for a list of standard hook variables.
address@hidden Hooks}, for a list of some standard hook variables.
 
 @cindex normal hook
   Most of the hooks in Emacs are @dfn{normal hooks}.  These variables
@@ -4030,8 +4030,3 @@
 optionally bound to @code{desktop-save-buffer}.
 @end defvar
 
address@hidden
-   Local Variables:
-   fill-column: 72
-   End:
address@hidden ignore