From 8d4500087f547e203cfba03f61dcbe641bf650de Mon Sep 17 00:00:00 2001
From: Martin Rudalics <rudalics@gmx.at>
Date: Sun, 28 Jan 2018 19:27:39 +0100
Subject: [PATCH] Fix some issues in the emacs/lispref manuals

* doc/emacs/basic.texi (Continuation Lines):
* doc/emacs/building.texi (GDB User Interface Layout):
* doc/emacs/dired.texi (Misc Dired Features):
* doc/emacs/maintaining.texi (Identifier Search):
* doc/emacs/mark.texi (Using Region):
* doc/emacs/misc.texi (Document View, DocView Conversion):
* doc/emacs/modes.texi (Major Modes):
* doc/emacs/mule.texi (Input Methods, Unibyte Mode):
* doc/emacs/sending.texi (Mail Methods): Replace @code by
@kbd.
* doc/emacs/frames.texi (Text-Only Mouse):
* doc/lispref/maps.texi (Standard Keymaps): Replace @kbd by
@key.
* doc/lispref/compile.texi (Compiler Errors): Write
non-@code{nil} instead of non-nil.
* doc/lispref/debugging.texi (Internals of Debugger):
'backtrace' is not a command.  'debugger-stack-frame-as-list'
is an option.
* doc/lispref/display.texi (Size of Displayed Text):
'window-lines-pixel-dimensions' has a last argument 'left'.
* doc/lispref/display.texi (Attribute Functions):
'set-face-underline' and 'set-face-inverse-video' are
commands.
(Tooltips): 'tooltip-frame-parameters' is an option.
(Bidirectional Display): 'bidi-paragraph-direction' is an
option.
* doc/lispref/frames.texi (Cursor Parameters): 'cursor-type'
is an option.
(Input Focus): Argument FRAME of 'x-focus-frame' is not
optional.
(Child Frames): Both arguments of 'frame-ancestor-p' are
non-optional.  'iconify-child-frame' is an option.
* doc/lispref/os.texi (Killing Emacs):
'kill-emacs-query-functions' is an option.
* doc/lispref/windows.texi (Mouse Window Auto-selection):
'mouse-autoselect-window' is an option.
---
 doc/emacs/basic.texi       |  4 ++--
 doc/emacs/building.texi    |  4 ++--
 doc/emacs/dired.texi       |  2 +-
 doc/emacs/frames.texi      |  2 +-
 doc/emacs/maintaining.texi |  2 +-
 doc/emacs/mark.texi        |  2 +-
 doc/emacs/misc.texi        |  6 +++---
 doc/emacs/modes.texi       |  2 +-
 doc/emacs/mule.texi        | 27 ++++++++++++++-------------
 doc/emacs/sending.texi     |  4 ++--
 doc/lispref/compile.texi   |  2 +-
 doc/lispref/debugging.texi |  8 ++++----
 doc/lispref/display.texi   | 18 +++++++++---------
 doc/lispref/frames.texi    | 15 +++++++--------
 doc/lispref/maps.texi      |  2 +-
 doc/lispref/os.texi        |  4 ++--
 doc/lispref/windows.texi   |  4 ++--
 17 files changed, 54 insertions(+), 54 deletions(-)

diff --git a/doc/emacs/basic.texi b/doc/emacs/basic.texi
index dbcb8177a01..b59ccf6ccfa 100644
--- a/doc/emacs/basic.texi
+++ b/doc/emacs/basic.texi
@@ -608,8 +608,8 @@ newlines.  In that case, you can use Visual Line mode, which enables
 @dfn{word wrapping}: instead of wrapping long lines exactly at the
 right window edge, Emacs wraps them at the word boundaries (i.e.,
 space or tab characters) nearest to the right window edge.  Visual
-Line mode also redefines editing commands such as @code{C-a},
-@code{C-n}, and @code{C-k} to operate on screen lines rather than
+Line mode also redefines editing commands such as @kbd{C-a},
+@kbd{C-n}, and @kbd{C-k} to operate on screen lines rather than
 logical lines.  @xref{Visual Line Mode}.
 
 @node Position Info
diff --git a/doc/emacs/building.texi b/doc/emacs/building.texi
index eb8d2027cf8..65669ada50e 100644
--- a/doc/emacs/building.texi
+++ b/doc/emacs/building.texi
@@ -926,8 +926,8 @@ premium.
 
   You may also specify additional GDB-related buffers to display,
 either in the same frame or a different one.  Select the buffers you
-want by typing @code{M-x gdb-display-@var{buffertype}-buffer} or
-@code{M-x gdb-frame-@var{buffertype}-buffer}, where @var{buffertype}
+want by typing @kbd{M-x gdb-display-@var{buffertype}-buffer} or
+@kbd{M-x gdb-frame-@var{buffertype}-buffer}, where @var{buffertype}
 is the relevant buffer type, such as @samp{breakpoints}.  You can do
 the same with the menu bar, with the @samp{GDB-Windows} and
 @samp{GDB-Frames} sub-menus of the @samp{GUD} menu.
diff --git a/doc/emacs/dired.texi b/doc/emacs/dired.texi
index b8450ce9982..e3241452c88 100644
--- a/doc/emacs/dired.texi
+++ b/doc/emacs/dired.texi
@@ -1515,7 +1515,7 @@ function @code{file-attributes}).  This expression is evaluated for
 each pair of like-named files, and files differ if the expression's
 value is non-@code{nil}.
 
-  For instance, the sequence @code{M-x dired-compare-directories
+  For instance, the sequence @kbd{M-x dired-compare-directories
 @key{RET} (> mtime1 mtime2) @key{RET}} marks files newer in this
 directory than in the other, and marks files older in the other
 directory than in this one.  It also marks files with no counterpart,
diff --git a/doc/emacs/frames.texi b/doc/emacs/frames.texi
index 1b63ee58de2..7a7e1fd5636 100644
--- a/doc/emacs/frames.texi
+++ b/doc/emacs/frames.texi
@@ -1381,7 +1381,7 @@ can use @kbd{M-x xterm-mouse-mode} to give Emacs control over simple
 uses of the mouse---basically, only non-modified single clicks are
 supported.  Newer versions of @command{xterm} also support
 mouse-tracking.  The normal @command{xterm} mouse functionality for
-such clicks is still available by holding down the @kbd{SHIFT} key
+such clicks is still available by holding down the @key{SHIFT} key
 when you press the mouse button.  Xterm Mouse mode is a global minor
 mode (@pxref{Minor Modes}).  Repeating the command turns the mode off
 again.
diff --git a/doc/emacs/maintaining.texi b/doc/emacs/maintaining.texi
index cb53529cea7..e61c7f90348 100644
--- a/doc/emacs/maintaining.texi
+++ b/doc/emacs/maintaining.texi
@@ -1957,7 +1957,7 @@ query-replace-regexp}.  It then performs the specified replacement in
 the names of the matching identifiers in all the places in all the
 files where these identifiers are referenced.  This is useful when you
 rename your identifiers as part of refactoring.  This command should
-be invoked in the @file{*xref*} buffer generated by @code{M-?}.
+be invoked in the @file{*xref*} buffer generated by @kbd{M-?}.
 
 @findex tags-search
   @kbd{M-x tags-search} reads a regexp using the minibuffer, then
diff --git a/doc/emacs/mark.texi b/doc/emacs/mark.texi
index 072a3bc4b11..7cb48a67e7c 100644
--- a/doc/emacs/mark.texi
+++ b/doc/emacs/mark.texi
@@ -273,7 +273,7 @@ active.  If you change the value to @code{kill}, these commands
 @vindex mark-even-if-inactive
   Other commands always operate on the region, and have no default
 behavior.  Such commands usually have the word @code{region} in their
-names, like @kbd{C-w} (@code{kill-region}) and @code{C-x C-u}
+names, like @kbd{C-w} (@code{kill-region}) and @kbd{C-x C-u}
 (@code{upcase-region}).  If the mark is inactive, they operate on the
 @dfn{inactive region}---that is, on the text between point and the
 position at which the mark was last set (@pxref{Mark Ring}).  To
diff --git a/doc/emacs/misc.texi b/doc/emacs/misc.texi
index fb39a78de96..aeb8560ea00 100644
--- a/doc/emacs/misc.texi
+++ b/doc/emacs/misc.texi
@@ -434,8 +434,8 @@ by typing @kbd{C-c C-c} you switch to the fallback mode.  With another
 also be displayed from within DocView mode by typing @kbd{C-c C-t}
 (@code{doc-view-open-text}).
 
-  You can explicitly enable DocView mode with the command @code{M-x
-doc-view-mode}.  You can toggle DocView minor mode with @code{M-x
+  You can explicitly enable DocView mode with the command @kbd{M-x
+doc-view-mode}.  You can toggle DocView minor mode with @kbd{M-x
 doc-view-minor-mode}.
 
   When DocView mode starts, it displays a welcome screen and begins
@@ -576,7 +576,7 @@ including its entire margins.
   For efficiency, DocView caches the images produced by @command{gs}.
 The name of this directory is given by the variable
 @code{doc-view-cache-directory}.  You can clear the cache directory by
-typing @code{M-x doc-view-clear-cache}.
+typing @kbd{M-x doc-view-clear-cache}.
 
 @findex doc-view-kill-proc
 @findex doc-view-kill-proc-and-buffer
diff --git a/doc/emacs/modes.texi b/doc/emacs/modes.texi
index 97fe4cb7083..f0986702d5a 100644
--- a/doc/emacs/modes.texi
+++ b/doc/emacs/modes.texi
@@ -104,7 +104,7 @@ value for the variable @code{comment-start}, which determines how
 source code comments are delimited (@pxref{Comments}).
 
   To view the documentation for the current major mode, including a
-list of its key bindings, type @code{C-h m} (@code{describe-mode}).
+list of its key bindings, type @kbd{C-h m} (@code{describe-mode}).
 @xref{Misc Help}.
 
 @cindex mode hook
diff --git a/doc/emacs/mule.texi b/doc/emacs/mule.texi
index be07bcc5bb2..fd25604c700 100644
--- a/doc/emacs/mule.texi
+++ b/doc/emacs/mule.texi
@@ -477,7 +477,7 @@ display the next row or the previous row.
 
     Type @kbd{C-f} and @kbd{C-b} to move forward and backward among
 the alternatives in the current row.  As you do this, Emacs highlights
-the current alternative with a special color; type @code{C-@key{SPC}}
+the current alternative with a special color; type @kbd{C-@key{SPC}}
 to select the current alternative and use it as input.  The
 alternatives in the row are also numbered; the number appears before
 the alternative.  Typing a number selects the associated alternative
@@ -1658,24 +1658,25 @@ characters:
 @cindex 8-bit input
 @item
 You can use an input method for the selected language environment.
-@xref{Input Methods}.  When you use an input method in a unibyte buffer,
-the non-@acronym{ASCII} character you specify with it is converted to unibyte.
+@xref{Input Methods}.  When you use an input method in a unibyte
+buffer, the non-@acronym{ASCII} character you specify with it is
+converted to unibyte.
 
 @item
 If your keyboard can generate character codes 128 (decimal) and up,
-representing non-@acronym{ASCII} characters, you can type those character codes
-directly.
+representing non-@acronym{ASCII} characters, you can type those
+character codes directly.
 
 On a graphical display, you should not need to do anything special to
 use these keys; they should simply work.  On a text terminal, you
-should use the command @code{M-x set-keyboard-coding-system} or customize the
-variable @code{keyboard-coding-system} to specify which coding system
-your keyboard uses (@pxref{Terminal Coding}).  Enabling this feature
-will probably require you to use @key{ESC} to type Meta characters;
-however, on a console terminal or in @code{xterm}, you can arrange for
-Meta to be converted to @key{ESC} and still be able type 8-bit
-characters present directly on the keyboard or using @key{Compose} or
-@key{AltGr} keys.  @xref{User Input}.
+should use the command @kbd{M-x set-keyboard-coding-system} or
+customize the variable @code{keyboard-coding-system} to specify which
+coding system your keyboard uses (@pxref{Terminal Coding}).  Enabling
+this feature will probably require you to use @key{ESC} to type Meta
+characters; however, on a console terminal or in @code{xterm}, you can
+arrange for Meta to be converted to @key{ESC} and still be able to
+type 8-bit characters present directly on the keyboard or using
+@key{Compose} or @key{AltGr} keys.  @xref{User Input}.
 
 @cindex @code{iso-transl} library
 @cindex compose character
diff --git a/doc/emacs/sending.texi b/doc/emacs/sending.texi
index 6f6ef5f3dab..299f7896172 100644
--- a/doc/emacs/sending.texi
+++ b/doc/emacs/sending.texi
@@ -676,8 +676,8 @@ such as MIME support.  Another available mode is MH-E
 
 @vindex mail-user-agent
   You can choose any of these @dfn{mail user agents} as your preferred
-method for editing and sending mail.  The commands @code{C-x m},
-@code{C-x 4 m} and @code{C-x 5 m} use whichever agent you have
+method for editing and sending mail.  The commands @kbd{C-x m},
+@kbd{C-x 4 m} and @kbd{C-x 5 m} use whichever agent you have
 specified; so do various other parts of Emacs that send mail, such as
 the bug reporter (@pxref{Bugs}).  To specify a mail user agent,
 customize the variable @code{mail-user-agent}.  Currently, legitimate
diff --git a/doc/lispref/compile.texi b/doc/lispref/compile.texi
index 212b5a45dc6..0e39866d349 100644
--- a/doc/lispref/compile.texi
+++ b/doc/lispref/compile.texi
@@ -527,7 +527,7 @@ string for details.
 @vindex byte-compile-error-on-warn
   Sometimes you may wish the byte-compiler warnings to be reported
 using @code{error}.  If so, set @code{byte-compile-error-on-warn} to a
-non-nil value.
+non-@code{nil} value.
 
 @node Byte-Code Objects
 @section Byte-Code Function Objects
diff --git a/doc/lispref/debugging.texi b/doc/lispref/debugging.texi
index fbc5238dc07..2c757dd39d5 100644
--- a/doc/lispref/debugging.texi
+++ b/doc/lispref/debugging.texi
@@ -619,7 +619,7 @@ was called.  The convention for arguments is detailed in the description
 of @code{debug} (@pxref{Invoking the Debugger}).
 @end defvar
 
-@deffn Command backtrace
+@defun backtrace
 @cindex run time stack
 @cindex call stack
 This function prints a trace of Lisp function calls currently active.
@@ -669,9 +669,9 @@ forms are elided.
 ----------- Buffer: backtrace-output ------------
 @end group
 @end smallexample
-@end deffn
+@end defun
 
-@defvar debugger-stack-frame-as-list
+@defopt debugger-stack-frame-as-list
 If this variable is non-@code{nil}, every stack frame of the backtrace
 is displayed as a list.  This aims at improving the backtrace
 readability at the cost of special forms no longer being visually
@@ -700,7 +700,7 @@ example would look as follows:
 ----------- Buffer: backtrace-output ------------
 @end group
 @end smallexample
-@end defvar
+@end defopt
 
 @defvar debug-on-next-call
 @cindex @code{eval}, and debugging
diff --git a/doc/lispref/display.texi b/doc/lispref/display.texi
index 921fd104547..fbf943a08c7 100644
--- a/doc/lispref/display.texi
+++ b/doc/lispref/display.texi
@@ -1980,7 +1980,7 @@ height of both, if present, in the return value.
 whole and does not care about the size of individual lines.  The
 following function does.
 
-@defun window-lines-pixel-dimensions &optional window first last body inverse
+@defun window-lines-pixel-dimensions &optional window first last body inverse left
 This function calculates the pixel dimensions of each line displayed in
 the specified @var{window}.  It does so by walking @var{window}'s
 current glyph matrix---a matrix storing the glyph (@pxref{Glyphs}) of
@@ -2775,15 +2775,15 @@ This sets the @code{:slant} attribute of @var{face} to @var{normal} if
 @var{italic-p} is @code{nil}, and to @var{italic} otherwise.
 @end defun
 
-@defun set-face-underline face underline &optional frame
+@deffn Command set-face-underline face underline &optional frame
 This sets the @code{:underline} attribute of @var{face} to
 @var{underline}.
-@end defun
+@end deffn
 
-@defun set-face-inverse-video face inverse-video-p &optional frame
+@deffn Command set-face-inverse-video face inverse-video-p &optional frame
 This sets the @code{:inverse-video} attribute of @var{face} to
 @var{inverse-video-p}.
-@end defun
+@end deffn
 
 @deffn Command invert-face face &optional frame
 This swaps the foreground and background colors of face @var{face}.
@@ -7362,7 +7362,7 @@ have their own frame parameters (@pxref{Frame Parameters}).  Unlike
 other frames, the default parameters for tooltip frames are stored in a
 special variable.
 
-@defvar tooltip-frame-parameters
+@defopt tooltip-frame-parameters
 This customizable option holds the default frame parameters used for
 displaying tooltips.  Any font and color parameters are ignored, and the
 corresponding attributes of the @code{tooltip} face are used instead.
@@ -7372,7 +7372,7 @@ absolute frame-relative coordinates where the tooltip should be shown.
 variables described in @ref{Tooltips,,, emacs, The GNU Emacs Manual}.)
 Note that the @code{left} and @code{top} parameters, if present,
 override the values of mouse-relative offsets.
-@end defvar
+@end defopt
 
 @vindex tooltip@r{ face}
 The @code{tooltip} face determines the appearance of text shown in
@@ -7547,7 +7547,7 @@ for its paragraphs.  For example, buffers containing program source
 code should force all paragraphs to be displayed left-to-right.  You
 can use following variable to do this:
 
-@defvar bidi-paragraph-direction
+@defopt bidi-paragraph-direction
 If the value of this buffer-local variable is the symbol
 @code{right-to-left} or @code{left-to-right}, all paragraphs in the
 buffer are assumed to have that specified direction.  Any other value
@@ -7558,7 +7558,7 @@ the base direction of each paragraph from its contents.
 Modes for program source code should set this to @code{left-to-right}.
 Prog mode does this by default, so modes derived from Prog mode do not
 need to set this explicitly (@pxref{Basic Major Modes}).
-@end defvar
+@end defopt
 
 @defun current-bidi-paragraph-direction &optional buffer
 This function returns the paragraph direction at point in the named
diff --git a/doc/lispref/frames.texi b/doc/lispref/frames.texi
index 9c25f4da4d4..43fdd8f9d54 100644
--- a/doc/lispref/frames.texi
+++ b/doc/lispref/frames.texi
@@ -2201,13 +2201,13 @@ The @code{cursor-type} frame parameter may be overridden by the
 variables @code{cursor-type} and
 @code{cursor-in-non-selected-windows}:
 
-@defvar cursor-type
+@defopt cursor-type
 This buffer-local variable controls how the cursor looks in a selected
 window showing the buffer.  If its value is @code{t}, that means to
 use the cursor specified by the @code{cursor-type} frame parameter.
 Otherwise, the value should be one of the cursor types listed above,
 and it overrides the @code{cursor-type} frame parameter.
-@end defvar
+@end defopt
 
 @defopt cursor-in-non-selected-windows
 This buffer-local variable controls how the cursor looks in a window
@@ -2725,7 +2725,7 @@ Ideally, the function described next should focus a frame without also
 raising it above other frames.  Unfortunately, many window-systems or
 window managers may refuse to comply.
 
-@defun x-focus-frame &optional frame noactivate
+@defun x-focus-frame frame &optional noactivate
 This function gives @var{frame} the focus of the X server without
 necessarily raising it.  @var{frame} @code{nil} means use the selected
 frame.  Under X, the optional argument @var{noactivate}, if
@@ -3261,13 +3261,12 @@ exists, @var{frame} is considered a child frame of that frame.
 This function returns @code{nil} if @var{frame} has no parent frame.
 @end defun
 
-@defun frame-ancestor-p &optional ancestor descendant
+@defun frame-ancestor-p ancestor descendant
 This functions returns non-@code{nil} if @var{ancestor} is an ancestor
 of @var{descendant}.  @var{ancestor} is an ancestor of @var{descendant}
 when it is either @var{descendant}'s parent frame or it is an ancestor
 of @var{descendant}'s parent frame.  Both, @var{ancestor} and
-@var{descendant} must specify live frames and default to the selected
-frame.
+@var{descendant} must specify live frames.
 @end defun
 
 Note also the function @code{window-largest-empty-rectangle}
@@ -3279,7 +3278,7 @@ window.
 Customizing the following option can be useful to tweak the behavior of
 @code{iconify-frame} for child frames.
 
-@defvar iconify-child-frame
+@defopt iconify-child-frame
 This option tells Emacs how to proceed when it is asked to iconify a
 child frame.  If it is @code{nil}, @code{iconify-frame} will do nothing
 when invoked on a child frame.  If it is @code{iconify-top-level}, Emacs
@@ -3291,7 +3290,7 @@ Any other value means to try iconifying the child frame.  Since such an
 attempt may not be honored by all window managers and can even lead to
 making the child frame unresponsive to user actions, the default is to
 iconify the top level frame instead.
-@end defvar
+@end defopt
 
 
 @node Mouse Tracking
diff --git a/doc/lispref/maps.texi b/doc/lispref/maps.texi
index 275b018b15a..fc40f28ded8 100644
--- a/doc/lispref/maps.texi
+++ b/doc/lispref/maps.texi
@@ -51,7 +51,7 @@ A sparse keymap for subcommands of the prefix @kbd{C-x r}.@*
 @xref{Registers,,, emacs, The GNU Emacs Manual}.
 
 @item esc-map
-A full keymap for @kbd{ESC} (or @kbd{Meta}) commands.
+A full keymap for @key{ESC} (or @key{Meta}) commands.
 
 @item facemenu-keymap
 A sparse keymap used for the @kbd{M-o} prefix key.
diff --git a/doc/lispref/os.texi b/doc/lispref/os.texi
index 08544688350..1a4e2db44a6 100644
--- a/doc/lispref/os.texi
+++ b/doc/lispref/os.texi
@@ -699,7 +699,7 @@ inadvertently can lose a lot of work, the
 you have buffers that need saving or subprocesses that are running.
 It also runs the abnormal hook @code{kill-emacs-query-functions}:
 
-@defvar kill-emacs-query-functions
+@defopt kill-emacs-query-functions
 When @code{save-buffers-kill-terminal} is killing Emacs, it calls the
 functions in this hook, after asking the standard questions and before
 calling @code{kill-emacs}.  The functions are called in order of
@@ -708,7 +708,7 @@ confirmation from the user.  If any of them returns @code{nil},
 @code{save-buffers-kill-emacs} does not kill Emacs, and does not run
 the remaining functions in this hook.  Calling @code{kill-emacs}
 directly does not run this hook.
-@end defvar
+@end defopt
 
 @node Suspending Emacs
 @subsection Suspending Emacs
diff --git a/doc/lispref/windows.texi b/doc/lispref/windows.texi
index 170924f6060..3691a2c04f4 100644
--- a/doc/lispref/windows.texi
+++ b/doc/lispref/windows.texi
@@ -4701,7 +4701,7 @@ managers that give focus to a frame (and thus trigger its subsequent
 selection) whenever the mouse pointer enters its window-system window
 (@pxref{Input Focus}).
 
-@defvar mouse-autoselect-window
+@defopt mouse-autoselect-window
 If this variable is non-@code{nil}, Emacs will try to automatically
 select the window under the mouse pointer.  The following values are
 meaningful:
@@ -4729,7 +4729,7 @@ mode line of a window conceptually should not cause its auto-selection.
 
 Mouse auto-selection selects the minibuffer window only if it is active,
 and never deselects the active minibuffer window.
-@end defvar
+@end defopt
 
 Mouse auto-selection can be used to emulate a focus follows mouse policy
 for child frames (@pxref{Child Frames}) which usually are not tracked by
-- 
2.39.2