diff options
| author | Glenn Morris | 2017-12-22 13:23:16 -0500 |
|---|---|---|
| committer | Glenn Morris | 2017-12-22 13:23:16 -0500 |
| commit | 3404a87f29b28b449a2e6188f075df2f761caac5 (patch) | |
| tree | 56816f744b5c74273803811d62c9b61ba2334aa3 /doc/lispref | |
| parent | 5ee4f2fa8792ebaa84184f1a82219fbcd93e8103 (diff) | |
| parent | 34fcfc5c049bb99d68945bb24fb9d6a0789a33dd (diff) | |
| download | emacs-3404a87f29b28b449a2e6188f075df2f761caac5.tar.gz emacs-3404a87f29b28b449a2e6188f075df2f761caac5.zip | |
Merge from origin/emacs-26
34fcfc5 (origin/emacs-26, emacs-26) * lisp/emacs-lisp/inline.el (defi...
f7a62c2 Fix doc string of 'footnote-style-alist'
c3b6742 Improve documentation of selecting windows
861d110 Improve documentation of records
22b3075 * etc/NEWS: Mention the removal of pinentry.el. (Bug#27445)
689526b Fix interactive spec of 'semantic-ia-show-variants'
90ca37f Fix documentation of 'mouse-drag-and-drop-region' and friends
d60faf3 Improve detection of speller version in ispell.el
a0e3b06 Document 'mouse-drag-and-drop-region' options and mention the...
164e84c Fix uses of 'nil' and 'non-nil' in manuals and a few more min...
798f07f Document that mode commands should be idempotent.
ad2a47c ; * src/xdisp.c (extend_face_to_end_of_line): Fix last change.
88ddf53 Fontify a CPP construct correctly when a comment follows with...
de7de9c Prevent infloop in redisplay on TTY frames
293720e Fix loss of documentation face in certain CC Mode doc comment...
# Conflicts:
# etc/NEWS
# lisp/mail/footnote.el
Diffstat (limited to 'doc/lispref')
| -rw-r--r-- | doc/lispref/Makefile.in | 1 | ||||
| -rw-r--r-- | doc/lispref/compile.texi | 2 | ||||
| -rw-r--r-- | doc/lispref/files.texi | 3 | ||||
| -rw-r--r-- | doc/lispref/functions.texi | 4 | ||||
| -rw-r--r-- | doc/lispref/keymaps.texi | 5 | ||||
| -rw-r--r-- | doc/lispref/lists.texi | 7 | ||||
| -rw-r--r-- | doc/lispref/modes.texi | 9 | ||||
| -rw-r--r-- | doc/lispref/records.texi | 9 | ||||
| -rw-r--r-- | doc/lispref/windows.texi | 23 |
9 files changed, 45 insertions, 18 deletions
diff --git a/doc/lispref/Makefile.in b/doc/lispref/Makefile.in index 9fa5901a1ac..50d6d161ef6 100644 --- a/doc/lispref/Makefile.in +++ b/doc/lispref/Makefile.in | |||
| @@ -118,6 +118,7 @@ srcs = \ | |||
| 118 | $(srcdir)/package.texi \ | 118 | $(srcdir)/package.texi \ |
| 119 | $(srcdir)/positions.texi \ | 119 | $(srcdir)/positions.texi \ |
| 120 | $(srcdir)/processes.texi \ | 120 | $(srcdir)/processes.texi \ |
| 121 | $(srcdir)/records.texi \ | ||
| 121 | $(srcdir)/searching.texi \ | 122 | $(srcdir)/searching.texi \ |
| 122 | $(srcdir)/sequences.texi \ | 123 | $(srcdir)/sequences.texi \ |
| 123 | $(srcdir)/streams.texi \ | 124 | $(srcdir)/streams.texi \ |
diff --git a/doc/lispref/compile.texi b/doc/lispref/compile.texi index 57ff06085d9..9123e93a5bf 100644 --- a/doc/lispref/compile.texi +++ b/doc/lispref/compile.texi | |||
| @@ -94,7 +94,7 @@ the @code{byte-compile} function. You can compile a whole file with | |||
| 94 | recorded in a buffer called @file{*Compile-Log*}, which uses | 94 | recorded in a buffer called @file{*Compile-Log*}, which uses |
| 95 | Compilation mode. @xref{Compilation Mode,,,emacs, The GNU Emacs | 95 | Compilation mode. @xref{Compilation Mode,,,emacs, The GNU Emacs |
| 96 | Manual}. However, if the variable @code{byte-compile-debug} is | 96 | Manual}. However, if the variable @code{byte-compile-debug} is |
| 97 | non-nil, error message will be signaled as Lisp errors instead | 97 | non-@code{nil}, error messages will be signaled as Lisp errors instead |
| 98 | (@pxref{Errors}). | 98 | (@pxref{Errors}). |
| 99 | 99 | ||
| 100 | @cindex macro compilation | 100 | @cindex macro compilation |
diff --git a/doc/lispref/files.texi b/doc/lispref/files.texi index b257c328f4d..f7eafcadc44 100644 --- a/doc/lispref/files.texi +++ b/doc/lispref/files.texi | |||
| @@ -2282,7 +2282,8 @@ because this is not portable. Always use | |||
| 2282 | @code{file-name-as-directory}. | 2282 | @code{file-name-as-directory}. |
| 2283 | 2283 | ||
| 2284 | To avoid the issues mentioned above, or if the @var{dirname} value | 2284 | To avoid the issues mentioned above, or if the @var{dirname} value |
| 2285 | might be nil (for example, from an element of @code{load-path}), use: | 2285 | might be @code{nil} (for example, from an element of @code{load-path}), |
| 2286 | use: | ||
| 2286 | 2287 | ||
| 2287 | @example | 2288 | @example |
| 2288 | (expand-file-name @var{relfile} @var{dirname}) | 2289 | (expand-file-name @var{relfile} @var{dirname}) |
diff --git a/doc/lispref/functions.texi b/doc/lispref/functions.texi index d84f09d8462..3f993901d4d 100644 --- a/doc/lispref/functions.texi +++ b/doc/lispref/functions.texi | |||
| @@ -1753,8 +1753,8 @@ code) obey the advice and other calls (from C code) do not. | |||
| 1753 | @defmac define-advice symbol (where lambda-list &optional name depth) &rest body | 1753 | @defmac define-advice symbol (where lambda-list &optional name depth) &rest body |
| 1754 | This macro defines a piece of advice and adds it to the function named | 1754 | This macro defines a piece of advice and adds it to the function named |
| 1755 | @var{symbol}. The advice is an anonymous function if @var{name} is | 1755 | @var{symbol}. The advice is an anonymous function if @var{name} is |
| 1756 | nil or a function named @code{symbol@@name}. See @code{advice-add} | 1756 | @code{nil} or a function named @code{symbol@@name}. See |
| 1757 | for explanation of other arguments. | 1757 | @code{advice-add} for explanation of other arguments. |
| 1758 | @end defmac | 1758 | @end defmac |
| 1759 | 1759 | ||
| 1760 | @defun advice-add symbol where function &optional props | 1760 | @defun advice-add symbol where function &optional props |
diff --git a/doc/lispref/keymaps.texi b/doc/lispref/keymaps.texi index 73f5572e69d..71b054e063c 100644 --- a/doc/lispref/keymaps.texi +++ b/doc/lispref/keymaps.texi | |||
| @@ -988,8 +988,9 @@ function is called with no arguments, prior to running each command, | |||
| 988 | while @var{keymap} is active; it should return non-@code{nil} if | 988 | while @var{keymap} is active; it should return non-@code{nil} if |
| 989 | @var{keymap} should stay active. | 989 | @var{keymap} should stay active. |
| 990 | 990 | ||
| 991 | The optional argument @var{on-exit}, if non-nil, specifies a function | 991 | The optional argument @var{on-exit}, if non-@code{nil}, specifies a |
| 992 | that is called, with no arguments, after @var{keymap} is deactivated. | 992 | function that is called, with no arguments, after @var{keymap} is |
| 993 | deactivated. | ||
| 993 | 994 | ||
| 994 | This function works by adding and removing @var{keymap} from the | 995 | This function works by adding and removing @var{keymap} from the |
| 995 | variable @code{overriding-terminal-local-map}, which takes precedence | 996 | variable @code{overriding-terminal-local-map}, which takes precedence |
diff --git a/doc/lispref/lists.texi b/doc/lispref/lists.texi index 0c993806824..230ea4b48eb 100644 --- a/doc/lispref/lists.texi +++ b/doc/lispref/lists.texi | |||
| @@ -1514,9 +1514,10 @@ of property lists and association lists. | |||
| 1514 | @defun assoc key alist &optional testfn | 1514 | @defun assoc key alist &optional testfn |
| 1515 | This function returns the first association for @var{key} in | 1515 | This function returns the first association for @var{key} in |
| 1516 | @var{alist}, comparing @var{key} against the alist elements using | 1516 | @var{alist}, comparing @var{key} against the alist elements using |
| 1517 | @var{testfn} if non-nil, or @code{equal} if nil (@pxref{Equality | 1517 | @var{testfn} if it is non-@code{nil} and @code{equal} otherwise |
| 1518 | Predicates}). It returns @code{nil} if no association in @var{alist} | 1518 | (@pxref{Equality Predicates}). It returns @code{nil} if no |
| 1519 | has a @sc{car} equal to @var{key}. For example: | 1519 | association in @var{alist} has a @sc{car} equal to @var{key}. For |
| 1520 | example: | ||
| 1520 | 1521 | ||
| 1521 | @smallexample | 1522 | @smallexample |
| 1522 | (setq trees '((pine . cones) (oak . acorns) (maple . seeds))) | 1523 | (setq trees '((pine . cones) (oak . acorns) (maple . seeds))) |
diff --git a/doc/lispref/modes.texi b/doc/lispref/modes.texi index bd94aeadf15..1a601baee86 100644 --- a/doc/lispref/modes.texi +++ b/doc/lispref/modes.texi | |||
| @@ -314,6 +314,11 @@ Data}, for other possible forms). The name of the mode appears | |||
| 314 | in the mode line. | 314 | in the mode line. |
| 315 | 315 | ||
| 316 | @item | 316 | @item |
| 317 | Calling the major mode command twice in direct succession should not | ||
| 318 | fail and should do the same thing as calling the command only once. | ||
| 319 | In other words, the major mode command should be idempotent. | ||
| 320 | |||
| 321 | @item | ||
| 317 | @cindex functions in modes | 322 | @cindex functions in modes |
| 318 | Since all global names are in the same name space, all the global | 323 | Since all global names are in the same name space, all the global |
| 319 | variables, constants, and functions that are part of the mode should | 324 | variables, constants, and functions that are part of the mode should |
| @@ -1412,6 +1417,10 @@ a minor mode in a mode hook is a little uglier: | |||
| 1412 | @noindent | 1417 | @noindent |
| 1413 | However, this is not very commonly done. | 1418 | However, this is not very commonly done. |
| 1414 | 1419 | ||
| 1420 | Enabling or disabling a minor mode twice in direct succession should | ||
| 1421 | not fail and should do the same thing as enabling or disabling it only | ||
| 1422 | once. In other words, the minor mode command should be idempotent. | ||
| 1423 | |||
| 1415 | @item | 1424 | @item |
| 1416 | Add an element to @code{minor-mode-alist} for each minor mode | 1425 | Add an element to @code{minor-mode-alist} for each minor mode |
| 1417 | (@pxref{Definition of minor-mode-alist}), if you want to indicate the | 1426 | (@pxref{Definition of minor-mode-alist}), if you want to indicate the |
diff --git a/doc/lispref/records.texi b/doc/lispref/records.texi index 7cc36f14068..cae0f31f273 100644 --- a/doc/lispref/records.texi +++ b/doc/lispref/records.texi | |||
| @@ -5,7 +5,7 @@ | |||
| 5 | @c See the file elisp.texi for copying conditions. | 5 | @c See the file elisp.texi for copying conditions. |
| 6 | @node Records | 6 | @node Records |
| 7 | @chapter Records | 7 | @chapter Records |
| 8 | @cindex record | 8 | @cindex records |
| 9 | 9 | ||
| 10 | The purpose of records is to allow programmers to create objects | 10 | The purpose of records is to allow programmers to create objects |
| 11 | with new types that are not built into Emacs. They are used as the | 11 | with new types that are not built into Emacs. They are used as the |
| @@ -28,6 +28,13 @@ type descriptor, the symbol naming its type will be returned; | |||
| 28 | list specifying the contents. The first list element must be the | 28 | list specifying the contents. The first list element must be the |
| 29 | record type. The following elements are the record slots. | 29 | record type. The following elements are the record slots. |
| 30 | 30 | ||
| 31 | To avoid conflicts with other type names, Lisp programs that define | ||
| 32 | new types of records should normally use the naming conventions of the | ||
| 33 | package where these record types are introduced for the names of the | ||
| 34 | types. Note that the names of the types which could possibly conflict | ||
| 35 | might not be known at the time the package defining a record type is | ||
| 36 | loaded; they could be loaded at some future point in time. | ||
| 37 | |||
| 31 | A record is considered a constant for evaluation: the result of | 38 | A record is considered a constant for evaluation: the result of |
| 32 | evaluating it is the same record. This does not evaluate or even | 39 | evaluating it is the same record. This does not evaluate or even |
| 33 | examine the slots. @xref{Self-Evaluating Forms}. | 40 | examine the slots. @xref{Self-Evaluating Forms}. |
diff --git a/doc/lispref/windows.texi b/doc/lispref/windows.texi index 08ed092c48c..d73b410f977 100644 --- a/doc/lispref/windows.texi +++ b/doc/lispref/windows.texi | |||
| @@ -125,11 +125,13 @@ including for the case where @var{object} is a deleted window. | |||
| 125 | as @dfn{selected within the frame}. For the selected frame, that | 125 | as @dfn{selected within the frame}. For the selected frame, that |
| 126 | window is called the @dfn{selected window}---the one in which most | 126 | window is called the @dfn{selected window}---the one in which most |
| 127 | editing takes place, and in which the cursor for selected windows | 127 | editing takes place, and in which the cursor for selected windows |
| 128 | appears (@pxref{Cursor Parameters}). The selected window's buffer is | 128 | appears (@pxref{Cursor Parameters}). Keyboard input that inserts or |
| 129 | usually also the current buffer, except when @code{set-buffer} has | 129 | deletes text is also normally directed to this window. The selected |
| 130 | been used (@pxref{Current Buffer}). As for non-selected frames, the | 130 | window's buffer is usually also the current buffer, except when |
| 131 | window selected within the frame becomes the selected window if the | 131 | @code{set-buffer} has been used (@pxref{Current Buffer}). As for |
| 132 | frame is ever selected. @xref{Selecting Windows}. | 132 | non-selected frames, the window selected within the frame becomes the |
| 133 | selected window if the frame is ever selected. @xref{Selecting | ||
| 134 | Windows}. | ||
| 133 | 135 | ||
| 134 | @defun selected-window | 136 | @defun selected-window |
| 135 | This function returns the selected window (which is always a live | 137 | This function returns the selected window (which is always a live |
| @@ -1726,7 +1728,7 @@ windows. | |||
| 1726 | 1728 | ||
| 1727 | @defun select-window window &optional norecord | 1729 | @defun select-window window &optional norecord |
| 1728 | This function makes @var{window} the selected window and the window | 1730 | This function makes @var{window} the selected window and the window |
| 1729 | selected within its frame (@pxref{Basic Windows}) and selects that | 1731 | selected within its frame (@pxref{Basic Windows}), and selects that |
| 1730 | frame. It also makes @var{window}'s buffer (@pxref{Buffers and | 1732 | frame. It also makes @var{window}'s buffer (@pxref{Buffers and |
| 1731 | Windows}) current and sets that buffer's value of @code{point} to the | 1733 | Windows}) current and sets that buffer's value of @code{point} to the |
| 1732 | value of @code{window-point} (@pxref{Window Point}) in @var{window}. | 1734 | value of @code{window-point} (@pxref{Window Point}) in @var{window}. |
| @@ -1743,6 +1745,11 @@ next time. If @var{norecord} is non-@code{nil}, such updates are | |||
| 1743 | usually not performed. If, however, @var{norecord} equals the special | 1745 | usually not performed. If, however, @var{norecord} equals the special |
| 1744 | symbol @code{mark-for-redisplay}, the additional actions mentioned above | 1746 | symbol @code{mark-for-redisplay}, the additional actions mentioned above |
| 1745 | are omitted but @var{window} will be nevertheless updated. | 1747 | are omitted but @var{window} will be nevertheless updated. |
| 1748 | |||
| 1749 | Note that sometimes selecting a window is not enough to show it, or | ||
| 1750 | make its frame the top-most frame on display: you may also need to | ||
| 1751 | raise the frame or make sure input focus is directed to that frame. | ||
| 1752 | @xref{Input Focus}. | ||
| 1746 | @end defun | 1753 | @end defun |
| 1747 | 1754 | ||
| 1748 | @cindex select window hook | 1755 | @cindex select window hook |
| @@ -3059,7 +3066,7 @@ This function handles @var{window} and its buffer after quitting. The | |||
| 3059 | optional argument @var{window} must be a live window and defaults to | 3066 | optional argument @var{window} must be a live window and defaults to |
| 3060 | the selected one. The function's behavior is determined by the four | 3067 | the selected one. The function's behavior is determined by the four |
| 3061 | elements of the @code{quit-restore} window parameter (@pxref{Window | 3068 | elements of the @code{quit-restore} window parameter (@pxref{Window |
| 3062 | Parameters}), which is set to nil afterwards. | 3069 | Parameters}), which is set to @code{nil} afterwards. |
| 3063 | 3070 | ||
| 3064 | The window is deleted entirely if: 1) the first element of the | 3071 | The window is deleted entirely if: 1) the first element of the |
| 3065 | @code{quit-restore} parameter is one of 'window or 'frame, 2) the | 3072 | @code{quit-restore} parameter is one of 'window or 'frame, 2) the |
| @@ -3126,7 +3133,7 @@ possible to set it manually, using the following code for displaying | |||
| 3126 | @end group | 3133 | @end group |
| 3127 | @end example | 3134 | @end example |
| 3128 | 3135 | ||
| 3129 | Setting the window history to nil ensures that a future call to | 3136 | Setting the window history to @code{nil} ensures that a future call to |
| 3130 | @code{quit-window} can delete the window altogether. | 3137 | @code{quit-window} can delete the window altogether. |
| 3131 | 3138 | ||
| 3132 | @end defun | 3139 | @end defun |