From fc7db7066bc611ce95fc44492371dea6a8a3e5bd Mon Sep 17 00:00:00 2001 From: Glenn Morris Date: Fri, 3 Oct 2014 23:35:55 -0700 Subject: [PATCH] Small doc/ fixes re @var usage. * doc/emacs/cmdargs.texi (Misc X): * doc/emacs/display.texi (Optional Mode Line): * doc/emacs/misc.texi (emacsclient Options): * doc/emacs/vc1-xtra.texi (VC Delete/Rename): * doc/lispref/buffers.texi (Buffer List): * doc/lispref/display.texi (Image Descriptors, Defining Images): * doc/lispref/functions.texi (Core Advising Primitives): Small fixes re @var usage. --- doc/emacs/ChangeLog | 5 +++++ doc/emacs/cmdargs.texi | 4 ++-- doc/emacs/display.texi | 4 ++-- doc/emacs/misc.texi | 4 ++-- doc/emacs/vc1-xtra.texi | 2 +- doc/lispref/ChangeLog | 4 ++++ doc/lispref/buffers.texi | 2 +- doc/lispref/display.texi | 4 ++-- doc/lispref/functions.texi | 2 +- 9 files changed, 20 insertions(+), 11 deletions(-) diff --git a/doc/emacs/ChangeLog b/doc/emacs/ChangeLog index c0bd8979631..a712d26fa28 100644 --- a/doc/emacs/ChangeLog +++ b/doc/emacs/ChangeLog @@ -1,5 +1,10 @@ 2014-10-04 Glenn Morris + * cmdargs.texi (Misc X): + * display.texi (Optional Mode Line): + * misc.texi (emacsclient Options): + * vc1-xtra.texi (VC Delete/Rename): Small fixes re @var usage. + * killing.texi (Rectangles): Copyedits re rectangle-mark-mode. (CUA Bindings): Mention rectangle-mark-mode. diff --git a/doc/emacs/cmdargs.texi b/doc/emacs/cmdargs.texi index 3443f0b1627..b438281b2a2 100644 --- a/doc/emacs/cmdargs.texi +++ b/doc/emacs/cmdargs.texi @@ -1106,8 +1106,8 @@ rectangle containing the frame's title. @c Enable horizontal scroll bars. Since horizontal scroll bars @c are not yet implemented, this actually does nothing. -@item --parent-id @var{ID} -Open Emacs as a client X window via the XEmbed protocol, with @var{ID} +@item --parent-id @var{id} +Open Emacs as a client X window via the XEmbed protocol, with @var{id} as the parent X window id. Currently, this option is mainly useful for developers. diff --git a/doc/emacs/display.texi b/doc/emacs/display.texi index bdcb185a5f3..0a77e722d32 100644 --- a/doc/emacs/display.texi +++ b/doc/emacs/display.texi @@ -1245,11 +1245,11 @@ Size Indication mode. The size will be displayed immediately following the buffer percentage like this: @example -@var{POS} of @var{SIZE} +@var{pos} of @var{size} @end example @noindent -Here @var{SIZE} is the human readable representation of the number of +Here @var{size} is the human readable representation of the number of characters in the buffer, which means that @samp{k} for 10^3, @samp{M} for 10^6, @samp{G} for 10^9, etc., are used to abbreviate. diff --git a/doc/emacs/misc.texi b/doc/emacs/misc.texi index f09f23e6a4b..09e606fe2fe 100644 --- a/doc/emacs/misc.texi +++ b/doc/emacs/misc.texi @@ -1610,9 +1610,9 @@ all server buffers are finished. You can take as long as you like to edit the server buffers within Emacs, and they are @emph{not} killed when you type @kbd{C-x #} in them. -@item --parent-id @var{ID} +@item --parent-id @var{id} Open an @command{emacsclient} frame as a client frame in the parent X -window with id @var{ID}, via the XEmbed protocol. Currently, this +window with id @var{id}, via the XEmbed protocol. Currently, this option is mainly useful for developers. @item -q diff --git a/doc/emacs/vc1-xtra.texi b/doc/emacs/vc1-xtra.texi index 07f956c488d..dd52d97780d 100644 --- a/doc/emacs/vc1-xtra.texi +++ b/doc/emacs/vc1-xtra.texi @@ -113,7 +113,7 @@ Prompt for a file name, delete the file from the working tree, and schedule the deletion for committing. @item M-x vc-rename-file -Prompt for two file names, @var{VAR} and @var{OLD}, rename them in the +Prompt for two file names, @var{var} and @var{old}, rename them in the working tree, and schedule the renaming for committing. @end table diff --git a/doc/lispref/ChangeLog b/doc/lispref/ChangeLog index 93edec8d4fd..e481ea3314d 100644 --- a/doc/lispref/ChangeLog +++ b/doc/lispref/ChangeLog @@ -1,5 +1,9 @@ 2014-10-04 Glenn Morris + * buffers.texi (Buffer List): + * display.texi (Image Descriptors, Defining Images): + * functions.texi (Core Advising Primitives): Small fixes re @var usage. + * windows.texi (Window Sizes, Resizing Windows): Copyedits. * frames.texi (Multiple Terminals): Copyedits re multiple monitors. diff --git a/doc/lispref/buffers.texi b/doc/lispref/buffers.texi index 1293a03082c..5ac2d6786e8 100644 --- a/doc/lispref/buffers.texi +++ b/doc/lispref/buffers.texi @@ -863,7 +863,7 @@ If no suitable buffer exists, the buffer @file{*scratch*} is returned @defun last-buffer &optional buffer visible-ok frame This function returns the last buffer in @var{frame}'s buffer list other -than @var{BUFFER}. If @var{frame} is omitted or @code{nil}, it uses the +than @var{buffer}. If @var{frame} is omitted or @code{nil}, it uses the selected frame's buffer list. The argument @var{visible-ok} is handled as with @code{other-buffer}, diff --git a/doc/lispref/display.texi b/doc/lispref/display.texi index e88eadb5ca7..032d9129c88 100644 --- a/doc/lispref/display.texi +++ b/doc/lispref/display.texi @@ -4503,7 +4503,7 @@ functions to insert images into buffers. Each image descriptor has the form @code{(image . @var{props})}, where @var{props} is a property list of alternating keyword symbols -and values, including at least the pair @code{:type @var{TYPE}} which +and values, including at least the pair @code{:type @var{type}} that specifies the image type. The following is a list of properties that are meaningful for all @@ -4995,7 +4995,7 @@ of a list of image specifications @var{specs}. Each specification in @var{specs} is a property list with contents depending on image type. All specifications must at least contain the properties @code{:type @var{type}} and either @w{@code{:file @var{file}}} -or @w{@code{:data @var{DATA}}}, where @var{type} is a symbol specifying +or @w{@code{:data @var{data}}}, where @var{type} is a symbol specifying the image type, e.g., @code{xbm}, @var{file} is the file to load the image from, and @var{data} is a string containing the actual image data. The first specification in the list whose @var{type} is supported, and diff --git a/doc/lispref/functions.texi b/doc/lispref/functions.texi index a5e81547d9a..f551a6c749d 100644 --- a/doc/lispref/functions.texi +++ b/doc/lispref/functions.texi @@ -1232,7 +1232,7 @@ global value of @var{place}. Whereas if @var{place} is of the form @code{(local @var{symbol})}, where @var{symbol} is an expression which returns the variable name, then @var{function} will only be added in the current buffer. Finally, if you want to modify a lexical variable, you will -have to use @code{(var @var{VARIABLE})}. +have to use @code{(var @var{variable})}. Every function added with @code{add-function} can be accompanied by an association list of properties @var{props}. Currently only two of those -- 2.39.2