aboutsummaryrefslogtreecommitdiffstats
path: root/doc
diff options
context:
space:
mode:
authorDaniel Colascione2014-04-07 13:54:16 -0700
committerDaniel Colascione2014-04-07 13:54:16 -0700
commit7e31acf6b81fdce7258077645bc239767c484841 (patch)
tree1f0d7b063a19b54982550797df063e0a9f87eaed /doc
parent608a4502b9fa8f5681368657fba5d5fd0fa46817 (diff)
parente3b838807bf9fbbbec9826de6c1e4efdf72acb78 (diff)
downloademacs-7e31acf6b81fdce7258077645bc239767c484841.tar.gz
emacs-7e31acf6b81fdce7258077645bc239767c484841.zip
Merge from emacs-24; up to 2014-04-01T20:18:12Z!eggert@cs.ucla.edu
Diffstat (limited to 'doc')
-rw-r--r--doc/emacs/ChangeLog12
-rw-r--r--doc/emacs/arevert-xtra.texi10
-rw-r--r--doc/emacs/files.texi4
-rw-r--r--doc/emacs/trouble.texi4
-rw-r--r--doc/lispref/ChangeLog11
-rw-r--r--doc/lispref/backups.texi41
-rw-r--r--doc/lispref/os.texi13
7 files changed, 55 insertions, 40 deletions
diff --git a/doc/emacs/ChangeLog b/doc/emacs/ChangeLog
index 507d9cb427a..f8cb233bb19 100644
--- a/doc/emacs/ChangeLog
+++ b/doc/emacs/ChangeLog
@@ -1,3 +1,15 @@
12014-04-05 Glenn Morris <rgm@gnu.org>
2
3 * trouble.texi (Checklist): Dribble files may contain passwords.
4
52014-04-04 Glenn Morris <rgm@gnu.org>
6
7 * files.texi (Backup Names):
8 * arevert-xtra.texi (Supporting additional buffers):
9 Update for default values of some -function vars no longer being nil.
10 (Supporting additional buffers):
11 Update for buffer-stale-function also applying to file-buffers.
12
12014-03-28 Glenn Morris <rgm@gnu.org> 132014-03-28 Glenn Morris <rgm@gnu.org>
2 14
3 * custom.texi (Terminal Init): Mention term-file-aliases. 15 * custom.texi (Terminal Init): Mention term-file-aliases.
diff --git a/doc/emacs/arevert-xtra.texi b/doc/emacs/arevert-xtra.texi
index a13f59b69bd..dcb73bc96de 100644
--- a/doc/emacs/arevert-xtra.texi
+++ b/doc/emacs/arevert-xtra.texi
@@ -103,15 +103,15 @@ arguments to list only some of the files. @file{*Find*} and
103This section is intended for Elisp programmers who would like to add 103This section is intended for Elisp programmers who would like to add
104support for auto-reverting new types of buffers. 104support for auto-reverting new types of buffers.
105 105
106To support auto-reverting the buffer must first of all have a 106To support auto-reverting the buffer must first of all have a suitable
107@code{revert-buffer-function}. @xref{Definition of 107@code{revert-buffer-function}. @xref{Definition of
108revert-buffer-function,, Reverting, elisp, the Emacs Lisp Reference Manual}. 108revert-buffer-function,, Reverting, elisp, the Emacs Lisp Reference Manual}.
109 109
110In addition, it @emph{must} have a @code{buffer-stale-function}. 110In addition, it must have a suitable @code{buffer-stale-function}.
111 111
112@c FIXME only defvar in all of doc/emacs! 112@c FIXME only defvar in all of doc/emacs!
113@defvar buffer-stale-function 113@defvar buffer-stale-function
114The value of this variable is a function to check whether a non-file 114The value of this variable is a function to check whether a
115buffer needs reverting. This should be a function with one optional 115buffer needs reverting. This should be a function with one optional
116argument @var{noconfirm}. The function should return non-@code{nil} 116argument @var{noconfirm}. The function should return non-@code{nil}
117if the buffer should be reverted. The buffer is current when this 117if the buffer should be reverted. The buffer is current when this
@@ -132,7 +132,7 @@ If you just want to automatically auto-revert every
132@code{auto-revert-interval} seconds (like the Buffer Menu), use: 132@code{auto-revert-interval} seconds (like the Buffer Menu), use:
133 133
134@example 134@example
135(set (make-local-variable 'buffer-stale-function) 135(setq-local buffer-stale-function
136 #'(lambda (&optional noconfirm) 'fast)) 136 #'(lambda (&optional noconfirm) 'fast))
137@end example 137@end example
138 138
@@ -149,7 +149,7 @@ also be useful if the function is consulted for purposes other than
149auto-reverting. 149auto-reverting.
150@end defvar 150@end defvar
151 151
152Once the buffer has a @code{revert-buffer-function} and a 152Once the buffer has a suitable @code{revert-buffer-function} and
153@code{buffer-stale-function}, several problems usually remain. 153@code{buffer-stale-function}, several problems usually remain.
154 154
155The buffer will only auto-revert if it is marked unmodified. Hence, 155The buffer will only auto-revert if it is marked unmodified. Hence,
diff --git a/doc/emacs/files.texi b/doc/emacs/files.texi
index 3b9aefa332b..9310c44f1e6 100644
--- a/doc/emacs/files.texi
+++ b/doc/emacs/files.texi
@@ -594,8 +594,8 @@ directory. Emacs creates the directory, if necessary, to make the
594backup. 594backup.
595 595
596@vindex make-backup-file-name-function 596@vindex make-backup-file-name-function
597 If you define the variable @code{make-backup-file-name-function} to 597 If you set the variable @code{make-backup-file-name-function} to
598a suitable Lisp function, that overrides the usual way Emacs 598a suitable Lisp function, you can override the usual way Emacs
599constructs backup file names. 599constructs backup file names.
600 600
601@node Backup Deletion 601@node Backup Deletion
diff --git a/doc/emacs/trouble.texi b/doc/emacs/trouble.texi
index e7bff6c28a4..52e5b9c4045 100644
--- a/doc/emacs/trouble.texi
+++ b/doc/emacs/trouble.texi
@@ -759,7 +759,9 @@ customizations.
759One way to record the input to Emacs precisely is to write a dribble 759One way to record the input to Emacs precisely is to write a dribble
760file. To start the file, use the @kbd{M-x open-dribble-file 760file. To start the file, use the @kbd{M-x open-dribble-file
761@key{RET}} command. From then on, Emacs copies all your input to the 761@key{RET}} command. From then on, Emacs copies all your input to the
762specified dribble file until the Emacs process is killed. 762specified dribble file until the Emacs process is killed. Be aware
763that sensitive information (such as passwords) may end up recorded in
764the dribble file.
763 765
764@item 766@item
765@findex open-termscript 767@findex open-termscript
diff --git a/doc/lispref/ChangeLog b/doc/lispref/ChangeLog
index 933078e9229..cb274474973 100644
--- a/doc/lispref/ChangeLog
+++ b/doc/lispref/ChangeLog
@@ -1,3 +1,14 @@
12014-04-05 Glenn Morris <rgm@gnu.org>
2
3 * os.texi (Recording Input): Dribble files may contain passwords.
4
52014-04-04 Glenn Morris <rgm@gnu.org>
6
7 * backups.texi (Making Backups, Reverting):
8 Update for default values of some -function vars no longer being nil.
9 (Reverting): Update for buffer-stale-function
10 also applying to file-buffers.
11
12014-03-31 Daniel Colascione <dancol@dancol.org> 122014-03-31 Daniel Colascione <dancol@dancol.org>
2 13
3 * minibuf.texi (Completion in Buffers): Discuss using lazy 14 * minibuf.texi (Completion in Buffers): Discuss using lazy
diff --git a/doc/lispref/backups.texi b/doc/lispref/backups.texi
index 83ffb2f95e4..63f8f227c84 100644
--- a/doc/lispref/backups.texi
+++ b/doc/lispref/backups.texi
@@ -90,8 +90,7 @@ save disk space. (You would put this code in your init file.)
90@smallexample 90@smallexample
91@group 91@group
92(add-hook 'rmail-mode-hook 92(add-hook 'rmail-mode-hook
93 (lambda () 93 (lambda () (setq-local make-backup-files nil)))
94 (set (make-local-variable 'make-backup-files) nil)))
95@end group 94@end group
96@end smallexample 95@end smallexample
97@end defopt 96@end defopt
@@ -150,13 +149,12 @@ ignored.
150@end defopt 149@end defopt
151 150
152@defopt make-backup-file-name-function 151@defopt make-backup-file-name-function
153This variable's value is a function to use for making backups instead 152This variable's value is a function to use for making backup file names.
154of the default @code{make-backup-file-name}. A value of @code{nil} 153The function @code{make-backup-file-name} calls it.
155gives the default @code{make-backup-file-name} behavior.
156@xref{Backup Names,, Naming Backup Files}. 154@xref{Backup Names,, Naming Backup Files}.
157 155
158This could be buffer-local to do something special for specific 156This could be buffer-local to do something special for specific
159files. If you define it, you may need to change 157files. If you change it, you may need to change
160@code{backup-file-name-p} and @code{file-name-sans-versions} too. 158@code{backup-file-name-p} and @code{file-name-sans-versions} too.
161@end defopt 159@end defopt
162 160
@@ -727,25 +725,24 @@ buffer-local bindings for these variables:
727@defvar revert-buffer-function 725@defvar revert-buffer-function
728@anchor{Definition of revert-buffer-function} 726@anchor{Definition of revert-buffer-function}
729The value of this variable is the function to use to revert this 727The value of this variable is the function to use to revert this
730buffer. If non-@code{nil}, it should be a function with two optional 728buffer. It should be a function with two optional
731arguments to do the work of reverting. The two optional arguments, 729arguments to do the work of reverting. The two optional arguments,
732@var{ignore-auto} and @var{noconfirm}, are the arguments that 730@var{ignore-auto} and @var{noconfirm}, are the arguments that
733@code{revert-buffer} received. If the value is @code{nil}, reverting 731@code{revert-buffer} received.
734works the usual way.
735 732
736Modes such as Dired mode, in which the text being edited does not 733Modes such as Dired mode, in which the text being edited does not
737consist of a file's contents but can be regenerated in some other 734consist of a file's contents but can be regenerated in some other
738fashion, can give this variable a buffer-local value that is a function to 735fashion, can give this variable a buffer-local value that is a special
739regenerate the contents. 736function to regenerate the contents.
740@end defvar 737@end defvar
741 738
742@defvar revert-buffer-insert-file-contents-function 739@defvar revert-buffer-insert-file-contents-function
743The value of this variable, if non-@code{nil}, specifies the function to use to 740The value of this variable specifies the function to use to
744insert the updated contents when reverting this buffer. The function 741insert the updated contents when reverting this buffer. The function
745receives two arguments: first the file name to use; second, @code{t} if 742receives two arguments: first the file name to use; second, @code{t} if
746the user has asked to read the auto-save file. 743the user has asked to read the auto-save file.
747 744
748The reason for a mode to set this variable instead of 745The reason for a mode to change this variable instead of
749@code{revert-buffer-function} is to avoid duplicating or replacing the 746@code{revert-buffer-function} is to avoid duplicating or replacing the
750rest of what @code{revert-buffer} does: asking for confirmation, 747rest of what @code{revert-buffer} does: asking for confirmation,
751clearing the undo list, deciding the proper major mode, and running the 748clearing the undo list, deciding the proper major mode, and running the
@@ -753,21 +750,23 @@ hooks listed below.
753@end defvar 750@end defvar
754 751
755@defvar before-revert-hook 752@defvar before-revert-hook
756This normal hook is run by @code{revert-buffer} before 753This normal hook is run by the default @code{revert-buffer-function}
757inserting the modified contents---but only if 754before inserting the modified contents. A custom @code{revert-buffer-function}
758@code{revert-buffer-function} is @code{nil}. 755may or may not run this hook.
759@end defvar 756@end defvar
760 757
761@defvar after-revert-hook 758@defvar after-revert-hook
762This normal hook is run by @code{revert-buffer} after inserting 759This normal hook is run by the default @code{revert-buffer-function}
763the modified contents---but only if @code{revert-buffer-function} is 760after inserting the modified contents. A custom @code{revert-buffer-function}
764@code{nil}. 761may or may not run this hook.
765@end defvar 762@end defvar
766 763
767@c FIXME? Move this section from arevert-xtra to here? 764@c FIXME? Move this section from arevert-xtra to here?
768@defvar buffer-stale-function 765@defvar buffer-stale-function
769The value of this variable, if non-@code{nil}, specifies a function 766The value of this variable specifies a function to call to check
770to call to check whether a non-file buffer needs reverting 767whether a buffer needs reverting. The default value only handles
768buffers that are visiting files, by checking their modification time.
769Buffers that are not visiting files require a custom function
771@iftex 770@iftex
772(@pxref{Supporting additional buffers,,, emacs-xtra, Specialized Emacs Features}). 771(@pxref{Supporting additional buffers,,, emacs-xtra, Specialized Emacs Features}).
773@end iftex 772@end iftex
diff --git a/doc/lispref/os.texi b/doc/lispref/os.texi
index cad5d7ec544..b63b932b4da 100644
--- a/doc/lispref/os.texi
+++ b/doc/lispref/os.texi
@@ -2001,20 +2001,11 @@ This function opens a @dfn{dribble file} named @var{filename}. When a
2001dribble file is open, each input event from the keyboard or mouse (but 2001dribble file is open, each input event from the keyboard or mouse (but
2002not those from keyboard macros) is written in that file. A 2002not those from keyboard macros) is written in that file. A
2003non-character event is expressed using its printed representation 2003non-character event is expressed using its printed representation
2004surrounded by @samp{<@dots{}>}. 2004surrounded by @samp{<@dots{}>}. Be aware that sensitive information
2005(such as passwords) may end up recorded in the dribble file.
2005 2006
2006You close the dribble file by calling this function with an argument 2007You close the dribble file by calling this function with an argument
2007of @code{nil}. 2008of @code{nil}.
2008
2009This function is normally used to record the input necessary to
2010trigger an Emacs bug, for the sake of a bug report.
2011
2012@example
2013@group
2014(open-dribble-file "~/dribble")
2015 @result{} nil
2016@end group
2017@end example
2018@end deffn 2009@end deffn
2019 2010
2020 See also the @code{open-termscript} function (@pxref{Terminal Output}). 2011 See also the @code{open-termscript} function (@pxref{Terminal Output}).