[Emacs-diffs] /srv/bzr/emacs/trunk r109612: More doc fixes.

[Chong Yidong]

------------------------------------------------------------
revno: 109612
fixes bugs: http://debbugs.gnu.org/11542 http://debbugs.gnu.org/11040 
http://debbugs.gnu.org/12076 http://debbugs.gnu.org/10881
committer: Chong Yidong <address@hidden>
branch nick: trunk
timestamp: Wed 2012-08-15 01:10:38 +0800
message:
  More doc fixes.
  
  * lisp/minibuffer.el (read-file-name): Doc fix.
  
  * character.c (Fcharacterp): Doc fix (Bug#12076).
  
  * data.c (Findirect_variable): Doc fix (Bug#11040).
  
  * editfns.c (Fsave_current_buffer): Doc fix (Bug#11542).
modified:
  lisp/ChangeLog
  lisp/minibuffer.el
  src/ChangeLog
  src/character.c
  src/data.c
  src/editfns.c

=== modified file 'lisp/ChangeLog'
--- a/lisp/ChangeLog    2012-08-14 16:28:23 +0000
+++ b/lisp/ChangeLog    2012-08-14 17:10:38 +0000
@@ -1,5 +1,7 @@
 2012-08-14  Chong Yidong  <address@hidden>
 
+       * minibuffer.el (read-file-name): Doc fix (Bug#10881).
+
        * emacs-lisp/regexp-opt.el (regexp-opt-charset): Doc fix
        (Bug#12085).
 

=== modified file 'lisp/minibuffer.el'
--- a/lisp/minibuffer.el        2012-07-10 11:51:54 +0000
+++ b/lisp/minibuffer.el        2012-08-14 17:10:38 +0000
@@ -2259,14 +2259,24 @@
 (defun read-file-name (prompt &optional dir default-filename mustmatch initial 
predicate)
   "Read file name, prompting with PROMPT and completing in directory DIR.
 Value is not expanded---you must call `expand-file-name' yourself.
-Default name to DEFAULT-FILENAME if user exits the minibuffer with
-the same non-empty string that was inserted by this function.
- (If DEFAULT-FILENAME is omitted, the visited file name is used,
-  except that if INITIAL is specified, that combined with DIR is used.
-  If DEFAULT-FILENAME is a list of file names, the first file name is used.)
-If the user exits with an empty minibuffer, this function returns
-an empty string.  (This can only happen if the user erased the
-pre-inserted contents or if `insert-default-directory' is nil.)
+
+DIR is the directory to use for completing relative file names.
+It should be an absolute directory name, or nil (which means the
+current buffer's value of `default-directory').
+
+DEFAULT-FILENAME specifies the default file name to return if the
+user exits the minibuffer with the same non-empty string inserted
+by this function.  If DEFAULT-FILENAME is a string, that serves
+as the default.  If DEFAULT-FILENAME is a list of strings, the
+first string is the default.  If DEFAULT-FILENAME is omitted or
+nil, then if INITIAL is non-nil, the default is DIR combined with
+INITIAL; otherwise, if the current buffer is visiting a file,
+that file serves as the default; otherwise, the default is simply
+the string inserted into the minibuffer.
+
+If the user exits with an empty minibuffer, return an empty
+string.  (This happens only if the user erases the pre-inserted
+contents, or if `insert-default-directory' is nil.)
 
 Fourth arg MUSTMATCH can take the following values:
 - nil means that the user can exit with any input.
@@ -2283,10 +2293,10 @@
 
 Fifth arg INITIAL specifies text to start with.
 
-If optional sixth arg PREDICATE is non-nil, possible completions and
-the resulting file name must satisfy (funcall PREDICATE NAME).
-DIR should be an absolute directory name.  It defaults to the value of
-`default-directory'.
+Sixth arg PREDICATE, if non-nil, should be a function of one
+argument; then a file name is considered an acceptable completion
+alternative only if PREDICATE returns non-nil with the file name
+as its argument.
 
 If this command was invoked with the mouse, use a graphical file
 dialog if `use-dialog-box' is non-nil, and the window system or X

=== modified file 'src/ChangeLog'
--- a/src/ChangeLog     2012-08-14 16:28:23 +0000
+++ b/src/ChangeLog     2012-08-14 17:10:38 +0000
@@ -1,8 +1,13 @@
 2012-08-14  Chong Yidong  <address@hidden>
 
+       * character.c (Fcharacterp): Doc fix (Bug#12076).
+
+       * data.c (Findirect_variable): Doc fix (Bug#11040).
+
        * chartab.c (Fmap_char_table): Doc fix (Bug#12061).
 
        * editfns.c (Fformat): Doc fix (Bug#12059).
+       (Fsave_current_buffer): Doc fix (Bug#11542).
 
 2012-08-14  Barry OReilly  <address@hidden>  (tiny change)
 

=== modified file 'src/character.c'
--- a/src/character.c   2012-08-03 23:36:11 +0000
+++ b/src/character.c   2012-08-14 17:10:38 +0000
@@ -258,6 +258,9 @@
 
 DEFUN ("characterp", Fcharacterp, Scharacterp, 1, 2, 0,
        doc: /* Return non-nil if OBJECT is a character.
+In Emacs Lisp, characters are represented by character codes, which
+are non-negative integers.  The function `max-char' returns the
+maximum character code.
 usage: (characterp OBJECT)  */)
   (Lisp_Object object, Lisp_Object ignore)
 {

=== modified file 'src/data.c'
--- a/src/data.c        2012-08-13 03:39:07 +0000
+++ b/src/data.c        2012-08-14 17:10:38 +0000
@@ -808,10 +808,12 @@
 
 DEFUN ("indirect-variable", Findirect_variable, Sindirect_variable, 1, 1, 0,
        doc: /* Return the variable at the end of OBJECT's variable chain.
-If OBJECT is a symbol, follow all variable indirections and return the final
-variable.  If OBJECT is not a symbol, just return it.
-Signal a cyclic-variable-indirection error if there is a loop in the
-variable chain of symbols.  */)
+If OBJECT is a symbol, follow its variable indirections (if any), and
+return the variable at the end of the chain of aliases.  See Info node
+`(elisp)Variable Aliases'.
+
+If OBJECT is not a symbol, just return it.  If there is a loop in the
+chain of aliases, signal a `cyclic-variable-indirection' error.  */)
   (Lisp_Object object)
 {
   if (SYMBOLP (object))

=== modified file 'src/editfns.c'
--- a/src/editfns.c     2012-08-14 16:28:23 +0000
+++ b/src/editfns.c     2012-08-14 17:10:38 +0000
@@ -946,8 +946,8 @@
 }
 
 DEFUN ("save-current-buffer", Fsave_current_buffer, Ssave_current_buffer, 0, 
UNEVALLED, 0,
-       doc: /* Save the current buffer; execute BODY; restore the current 
buffer.
-Executes BODY just like `progn'.
+       doc: /* Record which buffer is current; execute BODY; make that buffer 
current.
+BODY is executed just like `progn'.
 usage: (save-current-buffer &rest BODY)  */)
   (Lisp_Object args)
 {