diff options
| author | Glenn Morris | 2018-02-02 07:50:22 -0800 |
|---|---|---|
| committer | Glenn Morris | 2018-02-02 07:50:22 -0800 |
| commit | c4f8b5545efb94cdab21d92b83b388b059235d5c (patch) | |
| tree | d2b836765357732470786a74f867eaf9a056a87a /doc/lispref | |
| parent | 6ff8b7749fcc96b79489f73500bcd4722263383c (diff) | |
| parent | 56c37bbdb60f201791b57a3af2f47b7517de810c (diff) | |
| download | emacs-c4f8b5545efb94cdab21d92b83b388b059235d5c.tar.gz emacs-c4f8b5545efb94cdab21d92b83b388b059235d5c.zip | |
Merge from origin/emacs-26
56c37bb Use @key{} where it is missing in the manuals
25c0198 Another round of manual fixes from proofreading
Diffstat (limited to 'doc/lispref')
| -rw-r--r-- | doc/lispref/commands.texi | 2 | ||||
| -rw-r--r-- | doc/lispref/debugging.texi | 8 | ||||
| -rw-r--r-- | doc/lispref/display.texi | 2 | ||||
| -rw-r--r-- | doc/lispref/modes.texi | 9 | ||||
| -rw-r--r-- | doc/lispref/nonascii.texi | 2 | ||||
| -rw-r--r-- | doc/lispref/tips.texi | 19 |
6 files changed, 22 insertions, 20 deletions
diff --git a/doc/lispref/commands.texi b/doc/lispref/commands.texi index 6700b8fac30..0753d6fb67c 100644 --- a/doc/lispref/commands.texi +++ b/doc/lispref/commands.texi | |||
| @@ -748,7 +748,7 @@ part of the prompt. | |||
| 748 | @group | 748 | @group |
| 749 | (execute-extended-command 3) | 749 | (execute-extended-command 3) |
| 750 | ---------- Buffer: Minibuffer ---------- | 750 | ---------- Buffer: Minibuffer ---------- |
| 751 | 3 M-x forward-word RET | 751 | 3 M-x forward-word @key{RET} |
| 752 | ---------- Buffer: Minibuffer ---------- | 752 | ---------- Buffer: Minibuffer ---------- |
| 753 | @result{} t | 753 | @result{} t |
| 754 | @end group | 754 | @end group |
diff --git a/doc/lispref/debugging.texi b/doc/lispref/debugging.texi index e69f95b9d1a..09692073bf9 100644 --- a/doc/lispref/debugging.texi +++ b/doc/lispref/debugging.texi | |||
| @@ -941,10 +941,10 @@ The profiler report buffer shows, on each line, a function that was | |||
| 941 | called, followed by how much resource (processor or memory) it used in | 941 | called, followed by how much resource (processor or memory) it used in |
| 942 | absolute and percentage times since profiling started. If a given | 942 | absolute and percentage times since profiling started. If a given |
| 943 | line has a @samp{+} symbol at the left-hand side, you can expand that | 943 | line has a @samp{+} symbol at the left-hand side, you can expand that |
| 944 | line by typing @key{RET}, in order to see the function(s) called by | 944 | line by typing @kbd{@key{RET}}, in order to see the function(s) called |
| 945 | the higher-level function. Use a prefix argument (@key{C-u RET}) to | 945 | by the higher-level function. Use a prefix argument (@kbd{C-u |
| 946 | see the whole call tree below a function. Pressing @key{RET} again | 946 | @key{RET}}) to see the whole call tree below a function. Pressing |
| 947 | will collapse back to the original state. | 947 | @kbd{@key{RET}} again will collapse back to the original state. |
| 948 | 948 | ||
| 949 | Press @kbd{j} or @kbd{mouse-2} to jump to the definition of a function. | 949 | Press @kbd{j} or @kbd{mouse-2} to jump to the definition of a function. |
| 950 | Press @kbd{d} to view a function's documentation. | 950 | Press @kbd{d} to view a function's documentation. |
diff --git a/doc/lispref/display.texi b/doc/lispref/display.texi index fbf943a08c7..bd1f671225c 100644 --- a/doc/lispref/display.texi +++ b/doc/lispref/display.texi | |||
| @@ -4599,7 +4599,7 @@ first character in the group of consecutive characters that have the | |||
| 4599 | same @code{display} property. The space width is the pixel width of | 4599 | same @code{display} property. The space width is the pixel width of |
| 4600 | that character, multiplied by @var{factor}. (On text-mode terminals, | 4600 | that character, multiplied by @var{factor}. (On text-mode terminals, |
| 4601 | the ``pixel width'' of a character is usually 1, but it could be more | 4601 | the ``pixel width'' of a character is usually 1, but it could be more |
| 4602 | for TABs and double-width CJK characters.) | 4602 | for @key{TAB}s and double-width CJK characters.) |
| 4603 | 4603 | ||
| 4604 | @item :align-to @var{hpos} | 4604 | @item :align-to @var{hpos} |
| 4605 | Specifies that the space should be wide enough to reach @var{hpos}. | 4605 | Specifies that the space should be wide enough to reach @var{hpos}. |
diff --git a/doc/lispref/modes.texi b/doc/lispref/modes.texi index efa14e5e2a6..f1a00e72f3d 100644 --- a/doc/lispref/modes.texi +++ b/doc/lispref/modes.texi | |||
| @@ -3545,10 +3545,11 @@ provided grammar is precise enough, @code{transpose-sexps} can correctly | |||
| 3545 | transpose the two arguments of a @code{+} operator, taking into account | 3545 | transpose the two arguments of a @code{+} operator, taking into account |
| 3546 | the precedence rules of the language. | 3546 | the precedence rules of the language. |
| 3547 | 3547 | ||
| 3548 | Calling @code{smie-setup} is also sufficient to make TAB indentation work in | 3548 | Calling @code{smie-setup} is also sufficient to make @key{TAB} |
| 3549 | the expected way, extends @code{blink-matching-paren} to apply to | 3549 | indentation work in the expected way, extends |
| 3550 | elements like @code{begin...end}, and provides some commands that you | 3550 | @code{blink-matching-paren} to apply to elements like |
| 3551 | can bind in the major mode keymap. | 3551 | @code{begin...end}, and provides some commands that you can bind in |
| 3552 | the major mode keymap. | ||
| 3552 | 3553 | ||
| 3553 | @deffn Command smie-close-block | 3554 | @deffn Command smie-close-block |
| 3554 | This command closes the most recently opened (and not yet closed) block. | 3555 | This command closes the most recently opened (and not yet closed) block. |
diff --git a/doc/lispref/nonascii.texi b/doc/lispref/nonascii.texi index 2fd2bbc1ce5..8bc7e209894 100644 --- a/doc/lispref/nonascii.texi +++ b/doc/lispref/nonascii.texi | |||
| @@ -1776,7 +1776,7 @@ affect it. | |||
| 1776 | Binding @code{coding-system-for-write} to a non-@code{nil} value | 1776 | Binding @code{coding-system-for-write} to a non-@code{nil} value |
| 1777 | prevents output primitives from calling the function specified by | 1777 | prevents output primitives from calling the function specified by |
| 1778 | @code{select-safe-coding-system-function} (@pxref{User-Chosen Coding | 1778 | @code{select-safe-coding-system-function} (@pxref{User-Chosen Coding |
| 1779 | Systems}). This is because @kbd{C-x RET c} | 1779 | Systems}). This is because @kbd{C-x @key{RET} c} |
| 1780 | (@code{universal-coding-system-argument}) works by binding | 1780 | (@code{universal-coding-system-argument}) works by binding |
| 1781 | @code{coding-system-for-write}, and Emacs should obey user selection. | 1781 | @code{coding-system-for-write}, and Emacs should obey user selection. |
| 1782 | If a Lisp program binds @code{coding-system-for-write} to a value that | 1782 | If a Lisp program binds @code{coding-system-for-write} to a value that |
diff --git a/doc/lispref/tips.texi b/doc/lispref/tips.texi index 0f883fe4b4d..0695d9b7b12 100644 --- a/doc/lispref/tips.texi +++ b/doc/lispref/tips.texi | |||
| @@ -17,14 +17,15 @@ should follow. | |||
| 17 | @findex checkdoc | 17 | @findex checkdoc |
| 18 | @findex checkdoc-current-buffer | 18 | @findex checkdoc-current-buffer |
| 19 | @findex checkdoc-file | 19 | @findex checkdoc-file |
| 20 | You can automatically check some of the conventions described below by | 20 | You can automatically check some of the conventions described below |
| 21 | running the command @kbd{M-x checkdoc RET} when visiting a Lisp file. | 21 | by running the command @kbd{M-x checkdoc @key{RET}} when visiting a |
| 22 | It cannot check all of the conventions, and not all the warnings it | 22 | Lisp file. It cannot check all of the conventions, and not all the |
| 23 | gives necessarily correspond to problems, but it is worth examining them | 23 | warnings it gives necessarily correspond to problems, but it is worth |
| 24 | all. Alternatively, use the command @kbd{M-x checkdoc-current-buffer RET} | 24 | examining them all. Alternatively, use the command @kbd{M-x |
| 25 | to check the conventions in the current buffer, or @code{checkdoc-file} | 25 | checkdoc-current-buffer @key{RET}} to check the conventions in the |
| 26 | when you want to check a file in batch mode, e.g., with a command run by | 26 | current buffer, or @code{checkdoc-file} when you want to check a file |
| 27 | @kbd{@w{M-x compile RET}}. | 27 | in batch mode, e.g., with a command run by @kbd{@w{M-x compile |
| 28 | @key{RET}}}. | ||
| 28 | 29 | ||
| 29 | @menu | 30 | @menu |
| 30 | * Coding Conventions:: Conventions for clean and robust programs. | 31 | * Coding Conventions:: Conventions for clean and robust programs. |
| @@ -1028,7 +1029,7 @@ but only the main one. | |||
| 1028 | @findex checkdoc-package-keywords | 1029 | @findex checkdoc-package-keywords |
| 1029 | This line lists keywords for the @code{finder-by-keyword} help command. | 1030 | This line lists keywords for the @code{finder-by-keyword} help command. |
| 1030 | Please use that command to see a list of the meaningful keywords. The | 1031 | Please use that command to see a list of the meaningful keywords. The |
| 1031 | command @kbd{M-x checkdoc-package-keywords RET} will find and display | 1032 | command @kbd{M-x checkdoc-package-keywords @key{RET}} will find and display |
| 1032 | any keywords that are not in @code{finder-known-keywords}. If you set | 1033 | any keywords that are not in @code{finder-known-keywords}. If you set |
| 1033 | the variable @code{checkdoc-package-keywords-flag} non-@code{nil}, | 1034 | the variable @code{checkdoc-package-keywords-flag} non-@code{nil}, |
| 1034 | checkdoc commands will include the keyword verification in its checks. | 1035 | checkdoc commands will include the keyword verification in its checks. |