diff options
| author | Glenn Morris | 2014-06-08 16:41:43 -0700 |
|---|---|---|
| committer | Glenn Morris | 2014-06-08 16:41:43 -0700 |
| commit | fd60bf6c902b47daadda6ebf442045dbe1328941 (patch) | |
| tree | fd351a1fc087aefbca38b87102f06edf9f8b04ff /doc/lispref | |
| parent | ff2d0e8336c05cb7d3e86f7406784cefc1d6589e (diff) | |
| parent | 4181427f24e591f539122db2e3d8d8b55a7de7cd (diff) | |
| download | emacs-fd60bf6c902b47daadda6ebf442045dbe1328941.tar.gz emacs-fd60bf6c902b47daadda6ebf442045dbe1328941.zip | |
Merge from emacs-24; up to 2014-06-02T11:35:40Z!michael.albinus@gmx.de
Diffstat (limited to 'doc/lispref')
| -rw-r--r-- | doc/lispref/ChangeLog | 8 | ||||
| -rw-r--r-- | doc/lispref/anti.texi | 2 | ||||
| -rw-r--r-- | doc/lispref/display.texi | 8 | ||||
| -rw-r--r-- | doc/lispref/files.texi | 5 | ||||
| -rw-r--r-- | doc/lispref/keymaps.texi | 4 | ||||
| -rw-r--r-- | doc/lispref/modes.texi | 8 | ||||
| -rw-r--r-- | doc/lispref/numbers.texi | 20 | ||||
| -rw-r--r-- | doc/lispref/os.texi | 17 | ||||
| -rw-r--r-- | doc/lispref/sequences.texi | 2 | ||||
| -rw-r--r-- | doc/lispref/text.texi | 4 |
10 files changed, 46 insertions, 32 deletions
diff --git a/doc/lispref/ChangeLog b/doc/lispref/ChangeLog index 74557361eab..93128962c33 100644 --- a/doc/lispref/ChangeLog +++ b/doc/lispref/ChangeLog | |||
| @@ -1,5 +1,13 @@ | |||
| 1 | 2014-06-08 Glenn Morris <rgm@gnu.org> | 1 | 2014-06-08 Glenn Morris <rgm@gnu.org> |
| 2 | 2 | ||
| 3 | * os.texi (Startup Summary): Small fix for initial-buffer-choice. | ||
| 4 | |||
| 5 | * files.texi (Subroutines of Visiting): Mention uniquify. | ||
| 6 | |||
| 7 | * numbers.texi (Comparison of Numbers): Copyedits. | ||
| 8 | |||
| 9 | 2014-06-08 Glenn Morris <rgm@gnu.org> | ||
| 10 | |||
| 3 | * display.texi (Window Systems): Remove window-setup-hook. | 11 | * display.texi (Window Systems): Remove window-setup-hook. |
| 4 | * os.texi (Startup Summary, Init File): | 12 | * os.texi (Startup Summary, Init File): |
| 5 | Improve description of window-setup-hook. | 13 | Improve description of window-setup-hook. |
diff --git a/doc/lispref/anti.texi b/doc/lispref/anti.texi index 3de9f4ab9d1..2ca2290a022 100644 --- a/doc/lispref/anti.texi +++ b/doc/lispref/anti.texi | |||
| @@ -30,7 +30,7 @@ minimum of fuss. But @xref{Dynamic Binding Tips}, for tips to avoid | |||
| 30 | making your programs hard to understand. | 30 | making your programs hard to understand. |
| 31 | 31 | ||
| 32 | @item | 32 | @item |
| 33 | Calling a minor mode function from Lisp with a nil or omitted argument | 33 | Calling a minor mode function from Lisp with a @code{nil} or omitted argument |
| 34 | does not enable the minor mode unconditionally; instead, it toggles | 34 | does not enable the minor mode unconditionally; instead, it toggles |
| 35 | the minor mode---which is the straightforward thing to do, since that | 35 | the minor mode---which is the straightforward thing to do, since that |
| 36 | is the behavior when invoked interactively. One downside is that it | 36 | is the behavior when invoked interactively. One downside is that it |
diff --git a/doc/lispref/display.texi b/doc/lispref/display.texi index b4f987bb2a8..e0349e4ca0c 100644 --- a/doc/lispref/display.texi +++ b/doc/lispref/display.texi | |||
| @@ -1720,10 +1720,10 @@ Properties}. | |||
| 1720 | 1720 | ||
| 1721 | @defun overlays-at pos &optional sorted | 1721 | @defun overlays-at pos &optional sorted |
| 1722 | This function returns a list of all the overlays that cover the character at | 1722 | This function returns a list of all the overlays that cover the character at |
| 1723 | position @var{pos} in the current buffer. If @var{sorted} is non-nil, the list | 1723 | position @var{pos} in the current buffer. If @var{sorted} is non-@code{nil}, |
| 1724 | is in decreasing order of priority, otherwise it is in no particular order. | 1724 | the list is in decreasing order of priority, otherwise it is in no particular |
| 1725 | An overlay contains position @var{pos} if it begins at or before @var{pos}, and | 1725 | order. An overlay contains position @var{pos} if it begins at or before |
| 1726 | ends after @var{pos}. | 1726 | @var{pos}, and ends after @var{pos}. |
| 1727 | 1727 | ||
| 1728 | To illustrate usage, here is a Lisp function that returns a list of the | 1728 | To illustrate usage, here is a Lisp function that returns a list of the |
| 1729 | overlays that specify property @var{prop} for the character at point: | 1729 | overlays that specify property @var{prop} for the character at point: |
diff --git a/doc/lispref/files.texi b/doc/lispref/files.texi index fcfd37e987d..ac77b94d8f6 100644 --- a/doc/lispref/files.texi +++ b/doc/lispref/files.texi | |||
| @@ -254,11 +254,16 @@ is permanent local, so it is unaffected by changes of major modes. | |||
| 254 | which are sometimes useful in user Lisp code: @code{create-file-buffer} | 254 | which are sometimes useful in user Lisp code: @code{create-file-buffer} |
| 255 | and @code{after-find-file}. This section explains how to use them. | 255 | and @code{after-find-file}. This section explains how to use them. |
| 256 | 256 | ||
| 257 | @c FIXME This does not describe the default behavior, because | ||
| 258 | @c uniquify is enabled by default and advises this function. | ||
| 259 | @c This is confusing. uniquify should be folded into the function proper. | ||
| 257 | @defun create-file-buffer filename | 260 | @defun create-file-buffer filename |
| 258 | This function creates a suitably named buffer for visiting | 261 | This function creates a suitably named buffer for visiting |
| 259 | @var{filename}, and returns it. It uses @var{filename} (sans directory) | 262 | @var{filename}, and returns it. It uses @var{filename} (sans directory) |
| 260 | as the name if that name is free; otherwise, it appends a string such as | 263 | as the name if that name is free; otherwise, it appends a string such as |
| 261 | @samp{<2>} to get an unused name. See also @ref{Creating Buffers}. | 264 | @samp{<2>} to get an unused name. See also @ref{Creating Buffers}. |
| 265 | Note that the @file{uniquify} library affects the result of this | ||
| 266 | function. @xref{Uniquify,,, emacs, The GNU Emacs Manual}. | ||
| 262 | 267 | ||
| 263 | @strong{Please note:} @code{create-file-buffer} does @emph{not} | 268 | @strong{Please note:} @code{create-file-buffer} does @emph{not} |
| 264 | associate the new buffer with a file and does not select the buffer. | 269 | associate the new buffer with a file and does not select the buffer. |
diff --git a/doc/lispref/keymaps.texi b/doc/lispref/keymaps.texi index a2168d3e53a..7cc2b393456 100644 --- a/doc/lispref/keymaps.texi +++ b/doc/lispref/keymaps.texi | |||
| @@ -2901,7 +2901,7 @@ Documentation}). | |||
| 2901 | 2901 | ||
| 2902 | @item :key-sequence @var{keys} | 2902 | @item :key-sequence @var{keys} |
| 2903 | @var{keys} is a hint for speeding up Emacs's first display of the | 2903 | @var{keys} is a hint for speeding up Emacs's first display of the |
| 2904 | menu. It should be nil if you know that the menu item has no keyboard | 2904 | menu. It should be @code{nil} if you know that the menu item has no keyboard |
| 2905 | equivalent; otherwise it should be a string or vector specifying a | 2905 | equivalent; otherwise it should be a string or vector specifying a |
| 2906 | keyboard equivalent for the menu item. | 2906 | keyboard equivalent for the menu item. |
| 2907 | 2907 | ||
| @@ -2929,7 +2929,7 @@ anything else (meaning an ordinary menu item). | |||
| 2929 | 2929 | ||
| 2930 | @item :selected @var{selected} | 2930 | @item :selected @var{selected} |
| 2931 | @var{selected} is an expression; the checkbox or radio button is | 2931 | @var{selected} is an expression; the checkbox or radio button is |
| 2932 | selected whenever the expression's value is non-nil. | 2932 | selected whenever the expression's value is non-@code{nil}. |
| 2933 | 2933 | ||
| 2934 | @item :help @var{help} | 2934 | @item :help @var{help} |
| 2935 | @var{help} is a string describing the menu item. | 2935 | @var{help} is a string describing the menu item. |
diff --git a/doc/lispref/modes.texi b/doc/lispref/modes.texi index c30547e65ab..e23e2685a7c 100644 --- a/doc/lispref/modes.texi +++ b/doc/lispref/modes.texi | |||
| @@ -702,7 +702,7 @@ mode and minor modes. It uses the @code{documentation} function to | |||
| 702 | retrieve the documentation strings of the major and minor mode | 702 | retrieve the documentation strings of the major and minor mode |
| 703 | commands (@pxref{Accessing Documentation}). | 703 | commands (@pxref{Accessing Documentation}). |
| 704 | 704 | ||
| 705 | If called from Lisp with a non-nil @var{buffer} argument, this | 705 | If called from Lisp with a non-@code{nil} @var{buffer} argument, this |
| 706 | function displays the documentation for that buffer's major and minor | 706 | function displays the documentation for that buffer's major and minor |
| 707 | modes, rather than those of the current buffer. | 707 | modes, rather than those of the current buffer. |
| 708 | @end deffn | 708 | @end deffn |
| @@ -3804,8 +3804,8 @@ expressions (not separated by any token) rather than an expression. | |||
| 3804 | @end itemize | 3804 | @end itemize |
| 3805 | 3805 | ||
| 3806 | When @var{arg} is a token, the function is called with point just before | 3806 | When @var{arg} is a token, the function is called with point just before |
| 3807 | that token. A return value of nil always means to fallback on the | 3807 | that token. A return value of @code{nil} always means to fallback on the |
| 3808 | default behavior, so the function should return nil for arguments it | 3808 | default behavior, so the function should return @code{nil} for arguments it |
| 3809 | does not expect. | 3809 | does not expect. |
| 3810 | 3810 | ||
| 3811 | @var{offset} can be: | 3811 | @var{offset} can be: |
| @@ -3904,7 +3904,7 @@ A few things to note: | |||
| 3904 | @itemize | 3904 | @itemize |
| 3905 | @item | 3905 | @item |
| 3906 | The first case indicates the basic indentation increment to use. | 3906 | The first case indicates the basic indentation increment to use. |
| 3907 | If @code{sample-indent-basic} is nil, then SMIE uses the global | 3907 | If @code{sample-indent-basic} is @code{nil}, then SMIE uses the global |
| 3908 | setting @code{smie-indent-basic}. The major mode could have set | 3908 | setting @code{smie-indent-basic}. The major mode could have set |
| 3909 | @code{smie-indent-basic} buffer-locally instead, but that | 3909 | @code{smie-indent-basic} buffer-locally instead, but that |
| 3910 | is discouraged. | 3910 | is discouraged. |
diff --git a/doc/lispref/numbers.texi b/doc/lispref/numbers.texi index 5da950e1601..8fcd77c009a 100644 --- a/doc/lispref/numbers.texi +++ b/doc/lispref/numbers.texi | |||
| @@ -400,27 +400,23 @@ returns @code{t} if they are not, and @code{nil} if they are. | |||
| 400 | @end defun | 400 | @end defun |
| 401 | 401 | ||
| 402 | @defun < number-or-marker &rest number-or-markers | 402 | @defun < number-or-marker &rest number-or-markers |
| 403 | This function tests whether every argument is strictly less than the | 403 | This function tests whether each argument is strictly less than the |
| 404 | respective next argument. It returns @code{t} if so, @code{nil} | 404 | following argument. It returns @code{t} if so, @code{nil} otherwise. |
| 405 | otherwise. | ||
| 406 | @end defun | 405 | @end defun |
| 407 | 406 | ||
| 408 | @defun <= number-or-marker &rest number-or-markers | 407 | @defun <= number-or-marker &rest number-or-markers |
| 409 | This function tests whether every argument is less than or equal to | 408 | This function tests whether each argument is less than or equal to |
| 410 | the respective next argument. It returns @code{t} if so, @code{nil} | 409 | the following argument. It returns @code{t} if so, @code{nil} otherwise. |
| 411 | otherwise. | ||
| 412 | @end defun | 410 | @end defun |
| 413 | 411 | ||
| 414 | @defun > number-or-marker &rest number-or-markers | 412 | @defun > number-or-marker &rest number-or-markers |
| 415 | This function tests whether every argument is strictly greater than | 413 | This function tests whether each argument is strictly greater than |
| 416 | the respective next argument. It returns @code{t} if so, @code{nil} | 414 | the following argument. It returns @code{t} if so, @code{nil} otherwise. |
| 417 | otherwise. | ||
| 418 | @end defun | 415 | @end defun |
| 419 | 416 | ||
| 420 | @defun >= number-or-marker &rest number-or-markers | 417 | @defun >= number-or-marker &rest number-or-markers |
| 421 | This function tests whether every argument is greater than or equal to | 418 | This function tests whether each argument is greater than or equal to |
| 422 | the respective next argument. It returns @code{t} if so, @code{nil} | 419 | the following argument. It returns @code{t} if so, @code{nil} otherwise. |
| 423 | otherwise. | ||
| 424 | @end defun | 420 | @end defun |
| 425 | 421 | ||
| 426 | @defun max number-or-marker &rest numbers-or-markers | 422 | @defun max number-or-marker &rest numbers-or-markers |
diff --git a/doc/lispref/os.texi b/doc/lispref/os.texi index 04c7adda24a..5cfbb9ff2ef 100644 --- a/doc/lispref/os.texi +++ b/doc/lispref/os.texi | |||
| @@ -194,11 +194,16 @@ It processes any command-line options that were not handled earlier. | |||
| 194 | It now exits if the option @code{--batch} was specified. | 194 | It now exits if the option @code{--batch} was specified. |
| 195 | 195 | ||
| 196 | @item | 196 | @item |
| 197 | If @code{initial-buffer-choice} is a string, it visits the file with | 197 | If @code{initial-buffer-choice} is a string, it visits the file (or |
| 198 | that name. If it is a function, it calls the function and selects the | 198 | directory) with that name. If it is a function, it calls the function |
| 199 | buffer returned by the function. It it is @code{t}, it selects the | 199 | with no arguments and selects the buffer that it returns. |
| 200 | @file{*scratch*} buffer. If the @file{*scratch*} buffer exists and is | 200 | @ignore |
| 201 | empty, it inserts @code{initial-scratch-message} into that buffer. | 201 | @c I do not think this should be mentioned. AFAICS it is just a dodge |
| 202 | @c around inhibit-startup-screen not being settable on a site-wide basis. | ||
| 203 | If it is @code{t}, it selects the @file{*scratch*} buffer. | ||
| 204 | @end ignore | ||
| 205 | If the @file{*scratch*} buffer exists and is empty, it inserts | ||
| 206 | @code{initial-scratch-message} into that buffer. | ||
| 202 | 207 | ||
| 203 | @c To make things nice and confusing, the next three items can be | 208 | @c To make things nice and confusing, the next three items can be |
| 204 | @c called from two places. If displaying a startup screen, they are | 209 | @c called from two places. If displaying a startup screen, they are |
| @@ -753,7 +758,7 @@ Here is an example of how you could use these hooks: | |||
| 753 | (add-hook 'suspend-resume-hook (lambda () (message "Resumed!") | 758 | (add-hook 'suspend-resume-hook (lambda () (message "Resumed!") |
| 754 | (sit-for 2))) | 759 | (sit-for 2))) |
| 755 | @end smallexample | 760 | @end smallexample |
| 756 | @c The sit-for prevents the ``nil'' that suspend-emacs returns | 761 | @c The sit-for prevents the @code{nil} that suspend-emacs returns |
| 757 | @c hiding the message. | 762 | @c hiding the message. |
| 758 | 763 | ||
| 759 | Here is what you would see upon evaluating @code{(suspend-emacs "pwd")}: | 764 | Here is what you would see upon evaluating @code{(suspend-emacs "pwd")}: |
diff --git a/doc/lispref/sequences.texi b/doc/lispref/sequences.texi index cafdb7fc53d..8f17862d427 100644 --- a/doc/lispref/sequences.texi +++ b/doc/lispref/sequences.texi | |||
| @@ -862,7 +862,7 @@ argument @var{b} is given, the result of this operation is stored into | |||
| 862 | 862 | ||
| 863 | @defun bool-vector-subsetp a b | 863 | @defun bool-vector-subsetp a b |
| 864 | Return @code{t} if every @code{t} value in @var{a} is also t in | 864 | Return @code{t} if every @code{t} value in @var{a} is also t in |
| 865 | @var{b}, nil otherwise. All arguments should be bool vectors of the | 865 | @var{b}, @code{nil} otherwise. All arguments should be bool vectors of the |
| 866 | same length. | 866 | same length. |
| 867 | @end defun | 867 | @end defun |
| 868 | 868 | ||
diff --git a/doc/lispref/text.texi b/doc/lispref/text.texi index 4c3286adbfc..6665cc3e673 100644 --- a/doc/lispref/text.texi +++ b/doc/lispref/text.texi | |||
| @@ -806,7 +806,7 @@ non-whitespace character in each line in the region. | |||
| 806 | 806 | ||
| 807 | If this command acts on the entire buffer (i.e. if called | 807 | If this command acts on the entire buffer (i.e. if called |
| 808 | interactively with the mark inactive, or called from Lisp with | 808 | interactively with the mark inactive, or called from Lisp with |
| 809 | @var{end} nil), it also deletes all trailing lines at the end of the | 809 | @var{end} @code{nil}), it also deletes all trailing lines at the end of the |
| 810 | buffer if the variable @code{delete-trailing-lines} is non-@code{nil}. | 810 | buffer if the variable @code{delete-trailing-lines} is non-@code{nil}. |
| 811 | @end deffn | 811 | @end deffn |
| 812 | 812 | ||
| @@ -2865,7 +2865,7 @@ adding the face @var{face} to the @code{face} text property. | |||
| 2865 | (@pxref{Special Properties}), such as a face name or an anonymous face | 2865 | (@pxref{Special Properties}), such as a face name or an anonymous face |
| 2866 | (@pxref{Faces}). | 2866 | (@pxref{Faces}). |
| 2867 | 2867 | ||
| 2868 | If any text in the region already has a non-nil @code{face} property, | 2868 | If any text in the region already has a non-@code{nil} @code{face} property, |
| 2869 | those face(s) are retained. This function sets the @code{face} | 2869 | those face(s) are retained. This function sets the @code{face} |
| 2870 | property to a list of faces, with @var{face} as the first element (by | 2870 | property to a list of faces, with @var{face} as the first element (by |
| 2871 | default) and the pre-existing faces as the remaining elements. If the | 2871 | default) and the pre-existing faces as the remaining elements. If the |