aboutsummaryrefslogtreecommitdiffstats
path: root/doc
diff options
context:
space:
mode:
Diffstat (limited to 'doc')
-rw-r--r--doc/emacs/ChangeLog4
-rw-r--r--doc/emacs/custom.texi13
-rw-r--r--doc/lispintro/emacs-lisp-intro.texi14
-rw-r--r--doc/lispref/ChangeLog4
-rw-r--r--doc/lispref/functions.texi2
-rw-r--r--doc/lispref/hooks.texi10
-rw-r--r--doc/lispref/loading.texi4
-rw-r--r--doc/lispref/modes.texi6
-rw-r--r--doc/misc/dbus.texi4
-rw-r--r--doc/misc/ede.texi2
-rw-r--r--doc/misc/ediff.texi2
-rw-r--r--doc/misc/forms.texi4
-rw-r--r--doc/misc/gnus.texi2
-rw-r--r--doc/misc/mh-e.texi6
-rw-r--r--doc/misc/sem-user.texi2
-rw-r--r--doc/misc/tramp.texi32
16 files changed, 60 insertions, 51 deletions
diff --git a/doc/emacs/ChangeLog b/doc/emacs/ChangeLog
index f1a3cdb6235..90beb08233d 100644
--- a/doc/emacs/ChangeLog
+++ b/doc/emacs/ChangeLog
@@ -1,3 +1,7 @@
12012-10-23 Stefan Monnier <monnier@iro.umontreal.ca>
2
3 * custom.texi (Hooks): Clarify that -hooks is deprecated.
4
12012-10-23 Chong Yidong <cyd@gnu.org> 52012-10-23 Chong Yidong <cyd@gnu.org>
2 6
3 * kmacro.texi (Edit Keyboard Macro): Fix typo. 7 * kmacro.texi (Edit Keyboard Macro): Fix typo.
diff --git a/doc/emacs/custom.texi b/doc/emacs/custom.texi
index 68219d7890f..a614126dbc0 100644
--- a/doc/emacs/custom.texi
+++ b/doc/emacs/custom.texi
@@ -838,7 +838,8 @@ is a normal hook.
838 838
839@cindex abnormal hook 839@cindex abnormal hook
840 A few hooks are @dfn{abnormal hooks}. Their names end in 840 A few hooks are @dfn{abnormal hooks}. Their names end in
841@samp{-hooks} or @samp{-functions}, instead of @samp{-hook}. What 841@samp{-functions}, instead of @samp{-hook} (some old code may also use
842the deprecated suffix @samp{-hooks}). What
842makes these hooks abnormal is the way its functions are 843makes these hooks abnormal is the way its functions are
843called---perhaps they are given arguments, or perhaps the values they 844called---perhaps they are given arguments, or perhaps the values they
844return are used in some way. For example, 845return are used in some way. For example,
@@ -1735,11 +1736,11 @@ and @kbd{C-c p} in Texinfo mode:
1735 1736
1736@example 1737@example
1737(add-hook 'texinfo-mode-hook 1738(add-hook 'texinfo-mode-hook
1738 '(lambda () 1739 (lambda ()
1739 (define-key texinfo-mode-map "\C-cp" 1740 (define-key texinfo-mode-map "\C-cp"
1740 'backward-paragraph) 1741 'backward-paragraph)
1741 (define-key texinfo-mode-map "\C-cn" 1742 (define-key texinfo-mode-map "\C-cn"
1742 'forward-paragraph))) 1743 'forward-paragraph)))
1743@end example 1744@end example
1744 1745
1745@node Modifier Keys 1746@node Modifier Keys
diff --git a/doc/lispintro/emacs-lisp-intro.texi b/doc/lispintro/emacs-lisp-intro.texi
index 55c3ef4e09e..70ddb81c776 100644
--- a/doc/lispintro/emacs-lisp-intro.texi
+++ b/doc/lispintro/emacs-lisp-intro.texi
@@ -17909,10 +17909,10 @@ file that set values:
17909@group 17909@group
17910;; Set calendar highlighting colors 17910;; Set calendar highlighting colors
17911(setq calendar-load-hook 17911(setq calendar-load-hook
17912 '(lambda () 17912 (lambda ()
17913 (set-face-foreground 'diary-face "skyblue") 17913 (set-face-foreground 'diary-face "skyblue")
17914 (set-face-background 'holiday-face "slate blue") 17914 (set-face-background 'holiday-face "slate blue")
17915 (set-face-foreground 'holiday-face "white"))) 17915 (set-face-foreground 'holiday-face "white")))
17916@end group 17916@end group
17917@end smallexample 17917@end smallexample
17918 17918
@@ -20947,7 +20947,7 @@ not yet seen, @code{mapcar} and @code{lambda}.
20947@group 20947@group
20948(defun one-fiftieth (full-range) 20948(defun one-fiftieth (full-range)
20949 "Return list, each number one-fiftieth of previous." 20949 "Return list, each number one-fiftieth of previous."
20950 (mapcar '(lambda (arg) (/ arg 50)) full-range)) 20950 (mapcar (lambda (arg) (/ arg 50)) full-range))
20951@end group 20951@end group
20952@end smallexample 20952@end smallexample
20953 20953
@@ -21168,7 +21168,7 @@ and the second argument is @code{full-range}, which will be bound to
21168The whole expression looks like this: 21168The whole expression looks like this:
21169 21169
21170@smallexample 21170@smallexample
21171(mapcar '(lambda (arg) (/ arg 50)) full-range)) 21171(mapcar (lambda (arg) (/ arg 50)) full-range))
21172@end smallexample 21172@end smallexample
21173 21173
21174@xref{Mapping Functions, , Mapping Functions, elisp, The GNU Emacs 21174@xref{Mapping Functions, , Mapping Functions, elisp, The GNU Emacs
@@ -21840,7 +21840,7 @@ each column."
21840@group 21840@group
21841(defun one-fiftieth (full-range) 21841(defun one-fiftieth (full-range)
21842 "Return list, each number of which is 1/50th previous." 21842 "Return list, each number of which is 1/50th previous."
21843 (mapcar '(lambda (arg) (/ arg 50)) full-range)) 21843 (mapcar (lambda (arg) (/ arg 50)) full-range))
21844@end group 21844@end group
21845@end smallexample 21845@end smallexample
21846 21846
diff --git a/doc/lispref/ChangeLog b/doc/lispref/ChangeLog
index a767bbf1fce..26765e7a384 100644
--- a/doc/lispref/ChangeLog
+++ b/doc/lispref/ChangeLog
@@ -1,3 +1,7 @@
12012-10-23 Stefan Monnier <monnier@iro.umontreal.ca>
2
3 * hooks.texi (Standard Hooks): Clarify that -hooks is deprecated.
4
12012-10-23 Paul Eggert <eggert@cs.ucla.edu> 52012-10-23 Paul Eggert <eggert@cs.ucla.edu>
2 6
3 Fix outdated timestamp documentation in Elisp manual (bug#12706). 7 Fix outdated timestamp documentation in Elisp manual (bug#12706).
diff --git a/doc/lispref/functions.texi b/doc/lispref/functions.texi
index c94e46dad18..623106b6d06 100644
--- a/doc/lispref/functions.texi
+++ b/doc/lispref/functions.texi
@@ -978,7 +978,7 @@ anonymous function by quoting it as a list:
978@example 978@example
979@group 979@group
980(defun double-property (symbol prop) 980(defun double-property (symbol prop)
981 (change-property symbol prop '(lambda (x) (* 2 x)))) 981 (change-property symbol prop (lambda (x) (* 2 x))))
982@end group 982@end group
983@end example 983@end example
984 984
diff --git a/doc/lispref/hooks.texi b/doc/lispref/hooks.texi
index 7c91b51b290..a7f01243641 100644
--- a/doc/lispref/hooks.texi
+++ b/doc/lispref/hooks.texi
@@ -17,11 +17,11 @@ arguments and their values are completely ignored. The recommended way
17to put a new function on such a hook is to call @code{add-hook}. 17to put a new function on such a hook is to call @code{add-hook}.
18@xref{Hooks}, for more information about using hooks. 18@xref{Hooks}, for more information about using hooks.
19 19
20The variables whose names end in @samp{-hooks} or @samp{-functions} are 20The variables whose names end in @samp{-functions} are usually @dfn{abnormal
21usually @dfn{abnormal hooks}; their values are lists of functions, but 21hooks} (some old code may also use the deprecated @samp{-hooks} suffix); their
22these functions are called in a special way (they are passed arguments, 22values are lists of functions, but these functions are called in a special way
23or their values are used). The variables whose names end in 23(they are passed arguments, or their return values are used). The variables
24@samp{-function} have single functions as their values. 24whose names end in @samp{-function} have single functions as their values.
25 25
26This is not an exhaustive list, it only covers the more general hooks. 26This is not an exhaustive list, it only covers the more general hooks.
27For example, every major mode defines a hook named 27For example, every major mode defines a hook named
diff --git a/doc/lispref/loading.texi b/doc/lispref/loading.texi
index aa243185359..77a31cfde7a 100644
--- a/doc/lispref/loading.texi
+++ b/doc/lispref/loading.texi
@@ -897,8 +897,8 @@ It then restores any autoloads formerly associated with those symbols.
897 897
898Before restoring the previous definitions, @code{unload-feature} runs 898Before restoring the previous definitions, @code{unload-feature} runs
899@code{remove-hook} to remove functions in the library from certain 899@code{remove-hook} to remove functions in the library from certain
900hooks. These hooks include variables whose names end in @samp{hook} 900hooks. These hooks include variables whose names end in @samp{-hook}
901or @samp{-hooks}, plus those listed in 901(or the deprecated suffix @samp{-hooks}), plus those listed in
902@code{unload-feature-special-hooks}, as well as 902@code{unload-feature-special-hooks}, as well as
903@code{auto-mode-alist}. This is to prevent Emacs from ceasing to 903@code{auto-mode-alist}. This is to prevent Emacs from ceasing to
904function because important hooks refer to functions that are no longer 904function because important hooks refer to functions that are no longer
diff --git a/doc/lispref/modes.texi b/doc/lispref/modes.texi
index 8b5e3da493a..4e4d700aade 100644
--- a/doc/lispref/modes.texi
+++ b/doc/lispref/modes.texi
@@ -70,9 +70,9 @@ called. You can use @code{add-hook} to add a function to an abnormal
70hook, but you must write the function to follow the hook's calling 70hook, but you must write the function to follow the hook's calling
71convention. 71convention.
72 72
73 By convention, abnormal hook names end in @samp{-functions} or 73 By convention, abnormal hook names end in @samp{-functions}. If the
74@samp{-hooks}. If the variable's name ends in @samp{-function}, then 74variable's name ends in @samp{-function}, then its value is just a single
75its value is just a single function, not a list of functions. 75function, not a list of functions.
76 76
77@menu 77@menu
78* Running Hooks:: How to run a hook. 78* Running Hooks:: How to run a hook.
diff --git a/doc/misc/dbus.texi b/doc/misc/dbus.texi
index 865e99a3aa6..1f9a401df90 100644
--- a/doc/misc/dbus.texi
+++ b/doc/misc/dbus.texi
@@ -1981,7 +1981,7 @@ usually not desired. D-Bus errors in events can be made visible by
1981setting the variable @code{dbus-debug} to @code{t}. They can also be 1981setting the variable @code{dbus-debug} to @code{t}. They can also be
1982handled by a hook function. 1982handled by a hook function.
1983 1983
1984@defvar dbus-event-error-hooks 1984@defvar dbus-event-error-functions
1985This hook variable keeps a list of functions, which are called when a 1985This hook variable keeps a list of functions, which are called when a
1986D-Bus error happens in the event handler. Every function must accept 1986D-Bus error happens in the event handler. Every function must accept
1987two arguments, the event and the error variable caught in 1987two arguments, the event and the error variable caught in
@@ -1997,7 +1997,7 @@ Example:
1997 (message "my-dbus-event-error-handler: %S %S" event error) 1997 (message "my-dbus-event-error-handler: %S %S" event error)
1998 (signal 'file-error (cdr error)))) 1998 (signal 'file-error (cdr error))))
1999 1999
2000(add-hook 'dbus-event-error-hooks 'my-dbus-event-error-handler) 2000(add-hook 'dbus-event-error-functions 'my-dbus-event-error-handler)
2001@end lisp 2001@end lisp
2002@end defvar 2002@end defvar
2003 2003
diff --git a/doc/misc/ede.texi b/doc/misc/ede.texi
index 046cdc99414..1299f2ff062 100644
--- a/doc/misc/ede.texi
+++ b/doc/misc/ede.texi
@@ -1248,7 +1248,7 @@ detection scheme works like this:
1248 1248
1249@table @asis 1249@table @asis
1250@item Step 1: 1250@item Step 1:
1251@code{find-file-hooks} calls @code{ede-turn-on-hook} on BUFFER. 1251@code{find-file-hook} calls @code{ede-turn-on-hook} on BUFFER.
1252@item Step 2: 1252@item Step 2:
1253@code{ede-turn-on-hook} turns on @code{ede-minor-mode} 1253@code{ede-turn-on-hook} turns on @code{ede-minor-mode}
1254@item Step 3: 1254@item Step 3:
diff --git a/doc/misc/ediff.texi b/doc/misc/ediff.texi
index 01349e31468..0afcdd923d6 100644
--- a/doc/misc/ediff.texi
+++ b/doc/misc/ediff.texi
@@ -1248,7 +1248,7 @@ This hook is run just before @code{ediff-quit-hook}. This is a good
1248place to do various cleanups, such as deleting the variant buffers. 1248place to do various cleanups, such as deleting the variant buffers.
1249Ediff provides a function, @code{ediff-janitor}, as one such possible 1249Ediff provides a function, @code{ediff-janitor}, as one such possible
1250hook, which you can add to @code{ediff-cleanup-hook} with 1250hook, which you can add to @code{ediff-cleanup-hook} with
1251@code{add-hooks}. 1251@code{add-hook}.
1252 1252
1253@findex ediff-janitor 1253@findex ediff-janitor
1254This function kills buffers A, B, and, possibly, C, if these buffers aren't 1254This function kills buffers A, B, and, possibly, C, if these buffers aren't
diff --git a/doc/misc/forms.texi b/doc/misc/forms.texi
index bcb8d8974ea..11c3782dd7e 100644
--- a/doc/misc/forms.texi
+++ b/doc/misc/forms.texi
@@ -170,8 +170,8 @@ of the buffer are parsed using the specifications in
170@code{forms-format-list}, and the data file is updated. If the record 170@code{forms-format-list}, and the data file is updated. If the record
171has fields that aren't included in the display, they are not changed. 171has fields that aren't included in the display, they are not changed.
172 172
173@vindex forms-mode-hooks 173@vindex forms-mode-hook
174Entering Forms mode runs the normal hook @code{forms-mode-hooks} to 174Entering Forms mode runs the normal hook @code{forms-mode-hook} to
175perform user-defined customization. 175perform user-defined customization.
176 176
177To save any modified data, you can use @kbd{C-x C-s} 177To save any modified data, you can use @kbd{C-x C-s}
diff --git a/doc/misc/gnus.texi b/doc/misc/gnus.texi
index afc324e3fb4..a9cd0d3567c 100644
--- a/doc/misc/gnus.texi
+++ b/doc/misc/gnus.texi
@@ -3148,7 +3148,7 @@ following is added to a group parameter
3148 3148
3149@lisp 3149@lisp
3150(gnus-summary-prepared-hook 3150(gnus-summary-prepared-hook
3151 '(lambda nil (local-set-key "d" (local-key-binding "n")))) 3151 (lambda nil (local-set-key "d" (local-key-binding "n"))))
3152@end lisp 3152@end lisp
3153 3153
3154when the group is entered, the 'd' key will not mark the article as 3154when the group is entered, the 'd' key will not mark the article as
diff --git a/doc/misc/mh-e.texi b/doc/misc/mh-e.texi
index f6adc435789..e59b312889d 100644
--- a/doc/misc/mh-e.texi
+++ b/doc/misc/mh-e.texi
@@ -429,7 +429,7 @@ for a description about @dfn{normal hooks} and @dfn{abnormal hooks}.
429MH-E uses normal hooks in nearly all cases, so you can assume that we 429MH-E uses normal hooks in nearly all cases, so you can assume that we
430are talking about normal hooks unless we explicitly mention that a 430are talking about normal hooks unless we explicitly mention that a
431hook is abnormal. We also follow the conventions described in that 431hook is abnormal. We also follow the conventions described in that
432section: the name of the abnormal hooks end in @code{-hooks} and all 432section: the name of the abnormal hooks end in @code{-functions} and all
433the rest of the MH-E hooks end in @code{-hook}. You can add hooks with 433the rest of the MH-E hooks end in @code{-hook}. You can add hooks with
434either @code{customize-option} or @code{add-hook}. 434either @code{customize-option} or @code{add-hook}.
435 435
@@ -3749,9 +3749,9 @@ when you press @key{TAB} when prompted for a folder name.
3749 3749
3750@findex mh-search-p 3750@findex mh-search-p
3751@kindex k 3751@kindex k
3752@vindex mh-kill-folder-suppress-prompt-hooks 3752@vindex mh-kill-folder-suppress-prompt-functions
3753 3753
3754The hook @code{mh-kill-folder-suppress-prompt-hooks} is an abnormal 3754The hook @code{mh-kill-folder-suppress-prompt-functions} is an abnormal
3755hook run at the beginning of the command @kbd{k}. The hook functions 3755hook run at the beginning of the command @kbd{k}. The hook functions
3756are called with no arguments and should return a non-nil value to 3756are called with no arguments and should return a non-nil value to
3757suppress the normal prompt when you remove a folder. This is useful 3757suppress the normal prompt when you remove a folder. This is useful
diff --git a/doc/misc/sem-user.texi b/doc/misc/sem-user.texi
index 9f4dc72fea3..9d6fb11db50 100644
--- a/doc/misc/sem-user.texi
+++ b/doc/misc/sem-user.texi
@@ -277,7 +277,7 @@ variable. This allows SemanticDB to save tag caches in directories
277controlled by them. 277controlled by them.
278@end defvar 278@end defvar
279 279
280@deffn Option semanticdb-save-database-hooks 280@deffn Option semanticdb-save-database-functions
281Abnormal hook run after a database is saved. Each function is called 281Abnormal hook run after a database is saved. Each function is called
282with one argument, the object representing the database recently 282with one argument, the object representing the database recently
283written. 283written.
diff --git a/doc/misc/tramp.texi b/doc/misc/tramp.texi
index 530b8fdd6c2..46f99acbb87 100644
--- a/doc/misc/tramp.texi
+++ b/doc/misc/tramp.texi
@@ -3007,10 +3007,10 @@ checksum.
3007 3007
3008@lisp 3008@lisp
3009(add-hook 3009(add-hook
3010 'find-file-hooks 3010 'find-file-hook
3011 '(lambda () 3011 (lambda ()
3012 (when (file-remote-p default-directory) 3012 (when (file-remote-p default-directory)
3013 (set (make-local-variable 'file-precious-flag) t)))) 3013 (set (make-local-variable 'file-precious-flag) t))))
3014@end lisp 3014@end lisp
3015@end itemize 3015@end itemize
3016 3016
@@ -3126,7 +3126,7 @@ into your @file{~/.emacs}:
3126 (setq mode-line-format 3126 (setq mode-line-format
3127 (format-mode-line mode-line-format 'font-lock-warning-face)))) 3127 (format-mode-line mode-line-format 'font-lock-warning-face))))
3128 3128
3129(add-hook 'find-file-hooks 'my-mode-line-function) 3129(add-hook 'find-file-hook 'my-mode-line-function)
3130(add-hook 'dired-mode-hook 'my-mode-line-function) 3130(add-hook 'dired-mode-hook 'my-mode-line-function)
3131@end lisp 3131@end lisp
3132@end ifset 3132@end ifset
@@ -3159,10 +3159,10 @@ should put it into your @file{~/.emacs}:
3159 3159
3160(add-hook 3160(add-hook
3161 'dired-mode-hook 3161 'dired-mode-hook
3162 '(lambda () 3162 (lambda ()
3163 (setq 3163 (setq
3164 mode-line-buffer-identification 3164 mode-line-buffer-identification
3165 my-mode-line-buffer-identification))) 3165 my-mode-line-buffer-identification)))
3166@end lisp 3166@end lisp
3167 3167
3168Since @value{emacsname} 23.1, the mode line contains an indication if 3168Since @value{emacsname} 23.1, the mode line contains an indication if
@@ -3195,9 +3195,9 @@ like this:
3195@lisp 3195@lisp
3196(add-hook 3196(add-hook
3197 'dired-before-readin-hook 3197 'dired-before-readin-hook
3198 '(lambda () 3198 (lambda ()
3199 (when (file-remote-p default-directory) 3199 (when (file-remote-p default-directory)
3200 (setq dired-actual-switches "-al")))) 3200 (setq dired-actual-switches "-al"))))
3201@end lisp 3201@end lisp
3202@end ifset 3202@end ifset
3203 3203
@@ -3329,9 +3329,9 @@ minibuffer:
3329 3329
3330(add-hook 3330(add-hook
3331 'minibuffer-setup-hook 3331 'minibuffer-setup-hook
3332 '(lambda () 3332 (lambda ()
3333 (abbrev-mode 1) 3333 (abbrev-mode 1)
3334 (setq local-abbrev-table my-tramp-abbrev-table))) 3334 (setq local-abbrev-table my-tramp-abbrev-table)))
3335 3335
3336(defadvice minibuffer-complete 3336(defadvice minibuffer-complete
3337 (before my-minibuffer-complete activate) 3337 (before my-minibuffer-complete activate)
@@ -3398,7 +3398,7 @@ their readability through a remote access:
3398@ifset xemacs 3398@ifset xemacs
3399(recent-files-initialize) 3399(recent-files-initialize)
3400(add-hook 3400(add-hook
3401 'find-file-hooks 3401 'find-file-hook
3402 (lambda () 3402 (lambda ()
3403 (when (file-remote-p (buffer-file-name)) 3403 (when (file-remote-p (buffer-file-name))
3404 (recent-files-make-permanent))) 3404 (recent-files-make-permanent)))