[Emacs-diffs] emacs-24 r116903: Doc updates for default values of some -function vars no longer being nil

[Glenn Morris]

------------------------------------------------------------
revno: 116903
revision-id: address@hidden
parent: address@hidden
committer: Glenn Morris <address@hidden>
branch nick: emacs-24
timestamp: Thu 2014-04-03 21:49:28 -0400
message:
  Doc updates for default values of some -function vars no longer being nil
  
  * doc/emacs/files.texi (Backup Names):
  * doc/emacs/arevert-xtra.texi (Supporting additional buffers):
  * doc/lispref/backups.texi (Making Backups, Reverting):
  Update for default values of some -function vars no longer being nil.
  
  * etc/NEWS: Related edits.
modified:
  doc/emacs/ChangeLog            changelog-20091113204419-o5vbwnq5f7feedwu-6227
  doc/emacs/arevert-xtra.texi    
arevertxtra.texi-20091113204419-o5vbwnq5f7feedwu-6232
  doc/emacs/files.texi           files.texi-20091113204419-o5vbwnq5f7feedwu-6249
  doc/lispref/ChangeLog          changelog-20091113204419-o5vbwnq5f7feedwu-6155
  doc/lispref/backups.texi       
backups.texi-20091113204419-o5vbwnq5f7feedwu-6162
  etc/NEWS                       news-20100311060928-aoit31wvzf25yr1z-1

=== modified file 'doc/emacs/ChangeLog'
--- a/doc/emacs/ChangeLog       2014-03-16 02:42:15 +0000
+++ b/doc/emacs/ChangeLog       2014-04-04 01:49:28 +0000
@@ -1,3 +1,9 @@
+2014-04-04  Glenn Morris  <address@hidden>
+
+       * files.texi (Backup Names):
+       * arevert-xtra.texi (Supporting additional buffers):
+       Update for default values of some -function vars no longer being nil.
+
 2014-03-16  Dmitry Gutov  <address@hidden>
 
        * programs.texi (Matching): Update the missed spot.  (Bug#17008)

=== modified file 'doc/emacs/arevert-xtra.texi'
--- a/doc/emacs/arevert-xtra.texi       2014-01-01 07:43:34 +0000
+++ b/doc/emacs/arevert-xtra.texi       2014-04-04 01:49:28 +0000
@@ -103,11 +103,11 @@
 This section is intended for Elisp programmers who would like to add
 support for auto-reverting new types of buffers.
 
-To support auto-reverting the buffer must first of all have a
+To support auto-reverting the buffer must first of all have a suitable
 @code{revert-buffer-function}.  @xref{Definition of
 revert-buffer-function,, Reverting, elisp, the Emacs Lisp Reference Manual}.
 
-In addition, it @emph{must} have a @code{buffer-stale-function}.
+In addition, it must have a @code{buffer-stale-function}.
 
 @c FIXME only defvar in all of doc/emacs!
 @defvar buffer-stale-function
@@ -149,7 +149,7 @@
 auto-reverting.
 @end defvar
 
-Once the buffer has a @code{revert-buffer-function} and a
+Once the buffer has a suitable @code{revert-buffer-function} and
 @code{buffer-stale-function}, several problems usually remain.
 
 The buffer will only auto-revert if it is marked unmodified.  Hence,

=== modified file 'doc/emacs/files.texi'
--- a/doc/emacs/files.texi      2014-01-24 03:34:31 +0000
+++ b/doc/emacs/files.texi      2014-04-04 01:49:28 +0000
@@ -594,8 +594,8 @@
 backup.
 
 @vindex make-backup-file-name-function
-  If you define the variable @code{make-backup-file-name-function} to
-a suitable Lisp function, that overrides the usual way Emacs
+  If you set the variable @code{make-backup-file-name-function} to
+a suitable Lisp function, you can override the usual way Emacs
 constructs backup file names.
 
 @node Backup Deletion

=== modified file 'doc/lispref/ChangeLog'
--- a/doc/lispref/ChangeLog     2014-03-25 16:08:45 +0000
+++ b/doc/lispref/ChangeLog     2014-04-04 01:49:28 +0000
@@ -1,3 +1,8 @@
+2014-04-04  Glenn Morris  <address@hidden>
+
+       * backups.texi (Making Backups, Reverting):
+       Update for default values of some -function vars no longer being nil.
+
 2014-03-25  Eli Zaretskii  <address@hidden>
 
        * files.texi (Kinds of Files): Improve documentation of

=== modified file 'doc/lispref/backups.texi'
--- a/doc/lispref/backups.texi  2014-01-05 23:36:13 +0000
+++ b/doc/lispref/backups.texi  2014-04-04 01:49:28 +0000
@@ -90,8 +90,7 @@
 @smallexample
 @group
 (add-hook 'rmail-mode-hook
-          (lambda ()
-            (set (make-local-variable 'make-backup-files) nil)))
+          (lambda () (setq-local make-backup-files nil)))
 @end group
 @end smallexample
 @end defopt
@@ -150,13 +149,12 @@
 @end defopt
 
 @defopt make-backup-file-name-function
-This variable's value is a function to use for making backups instead
-of the default @code{make-backup-file-name}.  A value of @code{nil}
-gives the default @code{make-backup-file-name} behavior.
+This variable's value is a function to use for making backup file names.
+The function @code{make-backup-file-name} calls it.
 @xref{Backup Names,, Naming Backup Files}.
 
 This could be buffer-local to do something special for specific
-files.  If you define it, you may need to change
+files.  If you change it, you may need to change
 @code{backup-file-name-p} and @code{file-name-sans-versions} too.
 @end defopt
 
@@ -727,25 +725,24 @@
 @defvar revert-buffer-function
 @anchor{Definition of revert-buffer-function}
 The value of this variable is the function to use to revert this
-buffer.  If address@hidden, it should be a function with two optional
+buffer.  It should be a function with two optional
 arguments to do the work of reverting.  The two optional arguments,
 @var{ignore-auto} and @var{noconfirm}, are the arguments that
address@hidden received.  If the value is @code{nil}, reverting
-works the usual way.
address@hidden received.
 
 Modes such as Dired mode, in which the text being edited does not
 consist of a file's contents but can be regenerated in some other
-fashion, can give this variable a buffer-local value that is a function to
-regenerate the contents.
+fashion, can give this variable a buffer-local value that is a special
+function to regenerate the contents.
 @end defvar
 
 @defvar revert-buffer-insert-file-contents-function
-The value of this variable, if address@hidden, specifies the function to use to
+The value of this variable specifies the function to use to
 insert the updated contents when reverting this buffer.  The function
 receives two arguments: first the file name to use; second, @code{t} if
 the user has asked to read the auto-save file.
 
-The reason for a mode to set this variable instead of
+The reason for a mode to change this variable instead of
 @code{revert-buffer-function} is to avoid duplicating or replacing the
 rest of what @code{revert-buffer} does: asking for confirmation,
 clearing the undo list, deciding the proper major mode, and running the
@@ -753,21 +750,21 @@
 @end defvar
 
 @defvar before-revert-hook
-This normal hook is run by @code{revert-buffer} before
-inserting the modified contents---but only if
address@hidden is @code{nil}.
+This normal hook is run by the default @code{revert-buffer-function}
+before inserting the modified contents.  A custom @code{revert-buffer-function}
+may or may not run this hook.
 @end defvar
 
 @defvar after-revert-hook
-This normal hook is run by @code{revert-buffer} after inserting
-the modified contents---but only if @code{revert-buffer-function} is
address@hidden
+This normal hook is run by the default @code{revert-buffer-function}
+after inserting the modified contents.  A custom @code{revert-buffer-function}
+may or may not run this hook.
 @end defvar
 
 @c FIXME?  Move this section from arevert-xtra to here?
 @defvar buffer-stale-function
-The value of this variable, if address@hidden, specifies a function
-to call to check whether a non-file buffer needs reverting
+The value of this variable specifies a function to call to check
+whether a non-file buffer needs reverting
 @iftex
 (@pxref{Supporting additional buffers,,, emacs-xtra,  Specialized Emacs 
Features}).
 @end iftex

=== modified file 'etc/NEWS'
--- a/etc/NEWS  2014-04-03 07:21:37 +0000
+++ b/etc/NEWS  2014-04-04 01:49:28 +0000
@@ -159,6 +159,7 @@
 ** In keymaps where SPC scrolls forward, S-SPC now scrolls backward.
 This affects View mode, etc.
 
++++
 ** The default value of `make-backup-file-name-function' is no longer nil.
 Instead it defaults to a function that does what the nil value used to.
 
@@ -1400,6 +1401,7 @@
 
 ** Revert and Autorevert changes
 
+FIXME buffer-stale-function no longer just for non-file buffers?
 *** The default values of `buffer-stale-function', `revert-buffer-function',
 and `revert-buffer-insert-file-contents-function' are no longer nil.
 Instead they default to functions that do what the nil value used to.