From 56c37bbdb60f201791b57a3af2f47b7517de810c Mon Sep 17 00:00:00 2001 From: Michael Albinus Date: Wed, 31 Jan 2018 19:59:12 +0100 Subject: [PATCH] Use @key{} where it is missing in the manuals --- doc/emacs/display.texi | 6 +++--- doc/emacs/emacs.texi | 2 +- doc/emacs/killing.texi | 2 +- doc/emacs/maintaining.texi | 2 +- doc/emacs/programs.texi | 2 +- doc/emacs/search.texi | 4 ++-- doc/lispref/commands.texi | 2 +- doc/lispref/debugging.texi | 8 ++++---- doc/lispref/display.texi | 2 +- doc/lispref/modes.texi | 9 +++++---- doc/lispref/nonascii.texi | 2 +- doc/lispref/tips.texi | 19 ++++++++++--------- 12 files changed, 31 insertions(+), 29 deletions(-) diff --git a/doc/emacs/display.texi b/doc/emacs/display.texi index b2a4011b4a7..d0ab5486af1 100644 --- a/doc/emacs/display.texi +++ b/doc/emacs/display.texi @@ -1259,9 +1259,9 @@ Highlight empty lines. @item big-indent @vindex whitespace-big-indent-regexp Highlight too-deep indentation. By default any sequence of at least 4 -consecutive TAB characters or 32 consecutive SPC characters is -highlighted. To change that, customize the regular expression -@code{whitespace-big-indent-regexp}. +consecutive @key{TAB} characters or 32 consecutive @key{SPC} +characters is highlighted. To change that, customize the regular +expression @code{whitespace-big-indent-regexp}. @item space-mark Draw space and non-breaking characters with a special glyph. diff --git a/doc/emacs/emacs.texi b/doc/emacs/emacs.texi index 0051868fee6..b0539221b82 100644 --- a/doc/emacs/emacs.texi +++ b/doc/emacs/emacs.texi @@ -723,7 +723,7 @@ C and Related Modes * Motion in C:: Commands to move by C statements, etc. * Electric C:: Colon and other chars can automatically reindent. -* Hungry Delete:: A more powerful DEL command. +* Hungry Delete:: A more powerful @key{DEL} command. * Other C Commands:: Filling comments, viewing expansion of macros, and other neat features. diff --git a/doc/emacs/killing.texi b/doc/emacs/killing.texi index 6efcc9d35de..78203936c78 100644 --- a/doc/emacs/killing.texi +++ b/doc/emacs/killing.texi @@ -857,7 +857,7 @@ region is active. Unlike the standard region, the region-rectangle can have its corners extended past the end of buffer, or inside stretches of white space -that point normally cannot enter, like the TAB. +that point normally cannot enter, like the @key{TAB}. @findex rectangle-exchange-point-and-mark @findex exchange-point-and-mark@r{, in rectangle-mark-mode} diff --git a/doc/emacs/maintaining.texi b/doc/emacs/maintaining.texi index 158b04c9f2e..8acbb5317ed 100644 --- a/doc/emacs/maintaining.texi +++ b/doc/emacs/maintaining.texi @@ -1899,7 +1899,7 @@ Move to the previous reference and display it in the other window @findex xref-show-location-at-point Display the reference on the current line in the other window (@code{xref-show-location-at-point}). -@item TAB +@item @key{TAB} @findex xref-quit-and-goto-xref Display the reference on the current line and bury the @file{*xref*} buffer (@code{xref-quit-and-goto-xref}). diff --git a/doc/emacs/programs.texi b/doc/emacs/programs.texi index 42891245451..970647e1277 100644 --- a/doc/emacs/programs.texi +++ b/doc/emacs/programs.texi @@ -1587,7 +1587,7 @@ with Emacs. @menu * Motion in C:: Commands to move by C statements, etc. * Electric C:: Colon and other chars can automatically reindent. -* Hungry Delete:: A more powerful DEL command. +* Hungry Delete:: A more powerful @key{DEL} command. * Other C Commands:: Filling comments, viewing expansion of macros, and other neat features. @end menu diff --git a/doc/emacs/search.texi b/doc/emacs/search.texi index c7216128cd8..c0adab497ba 100644 --- a/doc/emacs/search.texi +++ b/doc/emacs/search.texi @@ -1675,8 +1675,8 @@ line. In particular, @kbd{C-g} simply exits the @code{query-replace}. To restart a @code{query-replace} once it is exited, use @kbd{C-x @key{ESC} @key{ESC}}, which repeats the @code{query-replace} because it -used the minibuffer to read its arguments. @xref{Repetition, C-x ESC -ESC}. +used the minibuffer to read its arguments. @xref{Repetition, C-x @key{ESC} +@key{ESC}}. @cindex invisible text, and query-replace The option @code{search-invisible} determines how @code{query-replace} 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. @group (execute-extended-command 3) ---------- Buffer: Minibuffer ---------- -3 M-x forward-word RET +3 M-x forward-word @key{RET} ---------- Buffer: Minibuffer ---------- @result{} t @end group diff --git a/doc/lispref/debugging.texi b/doc/lispref/debugging.texi index 2c757dd39d5..2b5f64827c4 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 called, followed by how much resource (processor or memory) it used in absolute and percentage times since profiling started. If a given line has a @samp{+} symbol at the left-hand side, you can expand that -line by typing @key{RET}, in order to see the function(s) called by -the higher-level function. Use a prefix argument (@key{C-u RET}) to -see the whole call tree below a function. Pressing @key{RET} again -will collapse back to the original state. +line by typing @kbd{@key{RET}}, in order to see the function(s) called +by the higher-level function. Use a prefix argument (@kbd{C-u +@key{RET}}) to see the whole call tree below a function. Pressing +@kbd{@key{RET}} again will collapse back to the original state. Press @kbd{j} or @kbd{mouse-2} to jump to the definition of a function. 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 same @code{display} property. The space width is the pixel width of that character, multiplied by @var{factor}. (On text-mode terminals, the ``pixel width'' of a character is usually 1, but it could be more -for TABs and double-width CJK characters.) +for @key{TAB}s and double-width CJK characters.) @item :align-to @var{hpos} 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 transpose the two arguments of a @code{+} operator, taking into account the precedence rules of the language. -Calling @code{smie-setup} is also sufficient to make TAB indentation work in -the expected way, extends @code{blink-matching-paren} to apply to -elements like @code{begin...end}, and provides some commands that you -can bind in the major mode keymap. +Calling @code{smie-setup} is also sufficient to make @key{TAB} +indentation work in the expected way, extends +@code{blink-matching-paren} to apply to elements like +@code{begin...end}, and provides some commands that you can bind in +the major mode keymap. @deffn Command smie-close-block 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. Binding @code{coding-system-for-write} to a non-@code{nil} value prevents output primitives from calling the function specified by @code{select-safe-coding-system-function} (@pxref{User-Chosen Coding -Systems}). This is because @kbd{C-x RET c} +Systems}). This is because @kbd{C-x @key{RET} c} (@code{universal-coding-system-argument}) works by binding @code{coding-system-for-write}, and Emacs should obey user selection. 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. @findex checkdoc @findex checkdoc-current-buffer @findex checkdoc-file - You can automatically check some of the conventions described below by -running the command @kbd{M-x checkdoc RET} when visiting a Lisp file. -It cannot check all of the conventions, and not all the warnings it -gives necessarily correspond to problems, but it is worth examining them -all. Alternatively, use the command @kbd{M-x checkdoc-current-buffer RET} -to check the conventions in the current buffer, or @code{checkdoc-file} -when you want to check a file in batch mode, e.g., with a command run by -@kbd{@w{M-x compile RET}}. + You can automatically check some of the conventions described below +by running the command @kbd{M-x checkdoc @key{RET}} when visiting a +Lisp file. It cannot check all of the conventions, and not all the +warnings it gives necessarily correspond to problems, but it is worth +examining them all. Alternatively, use the command @kbd{M-x +checkdoc-current-buffer @key{RET}} to check the conventions in the +current buffer, or @code{checkdoc-file} when you want to check a file +in batch mode, e.g., with a command run by @kbd{@w{M-x compile +@key{RET}}}. @menu * Coding Conventions:: Conventions for clean and robust programs. @@ -1028,7 +1029,7 @@ but only the main one. @findex checkdoc-package-keywords This line lists keywords for the @code{finder-by-keyword} help command. Please use that command to see a list of the meaningful keywords. The -command @kbd{M-x checkdoc-package-keywords RET} will find and display +command @kbd{M-x checkdoc-package-keywords @key{RET}} will find and display any keywords that are not in @code{finder-known-keywords}. If you set the variable @code{checkdoc-package-keywords-flag} non-@code{nil}, checkdoc commands will include the keyword verification in its checks. -- 2.39.2