diff options
| author | Chong Yidong | 2012-08-15 01:10:38 +0800 |
|---|---|---|
| committer | Chong Yidong | 2012-08-15 01:10:38 +0800 |
| commit | 4abcdac823a757bffc204f5eb074eb09ad69e58a (patch) | |
| tree | 636778c2f514810defc0164b1d10d96970e1ab8b | |
| parent | 55802e4a3dc1d6b1ffa05c193cdd94f9f69c1a41 (diff) | |
| download | emacs-4abcdac823a757bffc204f5eb074eb09ad69e58a.tar.gz emacs-4abcdac823a757bffc204f5eb074eb09ad69e58a.zip | |
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).
Fixes: debbugs:11542 debbugs:11040 debbugs:12076 debbugs:10881
| -rw-r--r-- | lisp/ChangeLog | 2 | ||||
| -rw-r--r-- | lisp/minibuffer.el | 34 | ||||
| -rw-r--r-- | src/ChangeLog | 5 | ||||
| -rw-r--r-- | src/character.c | 3 | ||||
| -rw-r--r-- | src/data.c | 10 | ||||
| -rw-r--r-- | src/editfns.c | 4 |
6 files changed, 40 insertions, 18 deletions
diff --git a/lisp/ChangeLog b/lisp/ChangeLog index 8d27fc65185..606be46b118 100644 --- a/lisp/ChangeLog +++ b/lisp/ChangeLog | |||
| @@ -1,5 +1,7 @@ | |||
| 1 | 2012-08-14 Chong Yidong <cyd@gnu.org> | 1 | 2012-08-14 Chong Yidong <cyd@gnu.org> |
| 2 | 2 | ||
| 3 | * minibuffer.el (read-file-name): Doc fix (Bug#10881). | ||
| 4 | |||
| 3 | * emacs-lisp/regexp-opt.el (regexp-opt-charset): Doc fix | 5 | * emacs-lisp/regexp-opt.el (regexp-opt-charset): Doc fix |
| 4 | (Bug#12085). | 6 | (Bug#12085). |
| 5 | 7 | ||
diff --git a/lisp/minibuffer.el b/lisp/minibuffer.el index 5c2c14d1fdb..cc2638d58de 100644 --- a/lisp/minibuffer.el +++ b/lisp/minibuffer.el | |||
| @@ -2259,14 +2259,24 @@ such as making the current buffer visit no file in the case of | |||
| 2259 | (defun read-file-name (prompt &optional dir default-filename mustmatch initial predicate) | 2259 | (defun read-file-name (prompt &optional dir default-filename mustmatch initial predicate) |
| 2260 | "Read file name, prompting with PROMPT and completing in directory DIR. | 2260 | "Read file name, prompting with PROMPT and completing in directory DIR. |
| 2261 | Value is not expanded---you must call `expand-file-name' yourself. | 2261 | Value is not expanded---you must call `expand-file-name' yourself. |
| 2262 | Default name to DEFAULT-FILENAME if user exits the minibuffer with | 2262 | |
| 2263 | the same non-empty string that was inserted by this function. | 2263 | DIR is the directory to use for completing relative file names. |
| 2264 | (If DEFAULT-FILENAME is omitted, the visited file name is used, | 2264 | It should be an absolute directory name, or nil (which means the |
| 2265 | except that if INITIAL is specified, that combined with DIR is used. | 2265 | current buffer's value of `default-directory'). |
| 2266 | If DEFAULT-FILENAME is a list of file names, the first file name is used.) | 2266 | |
| 2267 | If the user exits with an empty minibuffer, this function returns | 2267 | DEFAULT-FILENAME specifies the default file name to return if the |
| 2268 | an empty string. (This can only happen if the user erased the | 2268 | user exits the minibuffer with the same non-empty string inserted |
| 2269 | pre-inserted contents or if `insert-default-directory' is nil.) | 2269 | by this function. If DEFAULT-FILENAME is a string, that serves |
| 2270 | as the default. If DEFAULT-FILENAME is a list of strings, the | ||
| 2271 | first string is the default. If DEFAULT-FILENAME is omitted or | ||
| 2272 | nil, then if INITIAL is non-nil, the default is DIR combined with | ||
| 2273 | INITIAL; otherwise, if the current buffer is visiting a file, | ||
| 2274 | that file serves as the default; otherwise, the default is simply | ||
| 2275 | the string inserted into the minibuffer. | ||
| 2276 | |||
| 2277 | If the user exits with an empty minibuffer, return an empty | ||
| 2278 | string. (This happens only if the user erases the pre-inserted | ||
| 2279 | contents, or if `insert-default-directory' is nil.) | ||
| 2270 | 2280 | ||
| 2271 | Fourth arg MUSTMATCH can take the following values: | 2281 | Fourth arg MUSTMATCH can take the following values: |
| 2272 | - nil means that the user can exit with any input. | 2282 | - nil means that the user can exit with any input. |
| @@ -2283,10 +2293,10 @@ Fourth arg MUSTMATCH can take the following values: | |||
| 2283 | 2293 | ||
| 2284 | Fifth arg INITIAL specifies text to start with. | 2294 | Fifth arg INITIAL specifies text to start with. |
| 2285 | 2295 | ||
| 2286 | If optional sixth arg PREDICATE is non-nil, possible completions and | 2296 | Sixth arg PREDICATE, if non-nil, should be a function of one |
| 2287 | the resulting file name must satisfy (funcall PREDICATE NAME). | 2297 | argument; then a file name is considered an acceptable completion |
| 2288 | DIR should be an absolute directory name. It defaults to the value of | 2298 | alternative only if PREDICATE returns non-nil with the file name |
| 2289 | `default-directory'. | 2299 | as its argument. |
| 2290 | 2300 | ||
| 2291 | If this command was invoked with the mouse, use a graphical file | 2301 | If this command was invoked with the mouse, use a graphical file |
| 2292 | dialog if `use-dialog-box' is non-nil, and the window system or X | 2302 | dialog if `use-dialog-box' is non-nil, and the window system or X |
diff --git a/src/ChangeLog b/src/ChangeLog index 22f2ca18775..956d6922d2e 100644 --- a/src/ChangeLog +++ b/src/ChangeLog | |||
| @@ -1,8 +1,13 @@ | |||
| 1 | 2012-08-14 Chong Yidong <cyd@gnu.org> | 1 | 2012-08-14 Chong Yidong <cyd@gnu.org> |
| 2 | 2 | ||
| 3 | * character.c (Fcharacterp): Doc fix (Bug#12076). | ||
| 4 | |||
| 5 | * data.c (Findirect_variable): Doc fix (Bug#11040). | ||
| 6 | |||
| 3 | * chartab.c (Fmap_char_table): Doc fix (Bug#12061). | 7 | * chartab.c (Fmap_char_table): Doc fix (Bug#12061). |
| 4 | 8 | ||
| 5 | * editfns.c (Fformat): Doc fix (Bug#12059). | 9 | * editfns.c (Fformat): Doc fix (Bug#12059). |
| 10 | (Fsave_current_buffer): Doc fix (Bug#11542). | ||
| 6 | 11 | ||
| 7 | 2012-08-14 Barry OReilly <gundaetiapo@gmail.com> (tiny change) | 12 | 2012-08-14 Barry OReilly <gundaetiapo@gmail.com> (tiny change) |
| 8 | 13 | ||
diff --git a/src/character.c b/src/character.c index bdb0eead740..b2acf36ec15 100644 --- a/src/character.c +++ b/src/character.c | |||
| @@ -258,6 +258,9 @@ multibyte_char_to_unibyte_safe (int c) | |||
| 258 | 258 | ||
| 259 | DEFUN ("characterp", Fcharacterp, Scharacterp, 1, 2, 0, | 259 | DEFUN ("characterp", Fcharacterp, Scharacterp, 1, 2, 0, |
| 260 | doc: /* Return non-nil if OBJECT is a character. | 260 | doc: /* Return non-nil if OBJECT is a character. |
| 261 | In Emacs Lisp, characters are represented by character codes, which | ||
| 262 | are non-negative integers. The function `max-char' returns the | ||
| 263 | maximum character code. | ||
| 261 | usage: (characterp OBJECT) */) | 264 | usage: (characterp OBJECT) */) |
| 262 | (Lisp_Object object, Lisp_Object ignore) | 265 | (Lisp_Object object, Lisp_Object ignore) |
| 263 | { | 266 | { |
diff --git a/src/data.c b/src/data.c index 3e278e8bac3..d0ef5734abc 100644 --- a/src/data.c +++ b/src/data.c | |||
| @@ -808,10 +808,12 @@ indirect_variable (struct Lisp_Symbol *symbol) | |||
| 808 | 808 | ||
| 809 | DEFUN ("indirect-variable", Findirect_variable, Sindirect_variable, 1, 1, 0, | 809 | DEFUN ("indirect-variable", Findirect_variable, Sindirect_variable, 1, 1, 0, |
| 810 | doc: /* Return the variable at the end of OBJECT's variable chain. | 810 | doc: /* Return the variable at the end of OBJECT's variable chain. |
| 811 | If OBJECT is a symbol, follow all variable indirections and return the final | 811 | If OBJECT is a symbol, follow its variable indirections (if any), and |
| 812 | variable. If OBJECT is not a symbol, just return it. | 812 | return the variable at the end of the chain of aliases. See Info node |
| 813 | Signal a cyclic-variable-indirection error if there is a loop in the | 813 | `(elisp)Variable Aliases'. |
| 814 | variable chain of symbols. */) | 814 | |
| 815 | If OBJECT is not a symbol, just return it. If there is a loop in the | ||
| 816 | chain of aliases, signal a `cyclic-variable-indirection' error. */) | ||
| 815 | (Lisp_Object object) | 817 | (Lisp_Object object) |
| 816 | { | 818 | { |
| 817 | if (SYMBOLP (object)) | 819 | if (SYMBOLP (object)) |
diff --git a/src/editfns.c b/src/editfns.c index 806c80c1936..5ac012c8378 100644 --- a/src/editfns.c +++ b/src/editfns.c | |||
| @@ -946,8 +946,8 @@ usage: (save-excursion &rest BODY) */) | |||
| 946 | } | 946 | } |
| 947 | 947 | ||
| 948 | DEFUN ("save-current-buffer", Fsave_current_buffer, Ssave_current_buffer, 0, UNEVALLED, 0, | 948 | DEFUN ("save-current-buffer", Fsave_current_buffer, Ssave_current_buffer, 0, UNEVALLED, 0, |
| 949 | doc: /* Save the current buffer; execute BODY; restore the current buffer. | 949 | doc: /* Record which buffer is current; execute BODY; make that buffer current. |
| 950 | Executes BODY just like `progn'. | 950 | BODY is executed just like `progn'. |
| 951 | usage: (save-current-buffer &rest BODY) */) | 951 | usage: (save-current-buffer &rest BODY) */) |
| 952 | (Lisp_Object args) | 952 | (Lisp_Object args) |
| 953 | { | 953 | { |