[Emacs-diffs] /srv/bzr/emacs/emacs-24 r107995: Some minor fixes of Elisp manual.

[martin rudalics]

------------------------------------------------------------
revno: 107995
committer: martin rudalics <address@hidden>
branch nick: emacs-24
timestamp: Tue 2012-05-15 11:38:50 +0200
message:
  Some minor fixes of Elisp manual.
  
  * commands.texi (Recursive Editing): recursive-edit is a
  command.
  * compile.texi (Docs and Compilation):
  byte-compile-dynamic-docstrings is an option.
  * debugging.texi (Invoking the Debugger): debug is a command.
  * display.texi (Progress): progress-reporter-update and
  progress-reporter-force-update have VALUE argument optional.
  (Animated Images): Use address@hidden instead of non-nil.
  * files.texi (Format Conversion Round-Trip): Use address@hidden
  instead of non-nil.
  * frames.texi (Creating Frames): make-frame is a command.
  (Input Focus): select-frame is a command.
  (Pointer Shape): void-text-area-pointer is an option.
  * help.texi (Describing Characters): read-kbd-macro is a
  command.
  (Help Functions): describe-prefix-bindings is a command.
  * markers.texi (Creating Markers): Both arguments of copy-marker
  are optional.
  * minibuf.texi (Reading File Names): Use @kbd instead of @code.
  * modes.texi (Mode Line Variables): mode-line-remote and
  mode-line-client are not options.
  (Imenu): imenu-add-to-menubar is a command.
  (SMIE Indentation Helpers): Use address@hidden instead of
  non-nil.
  * os.texi (Sound Output): play-sound-file is a command.
  * package.texi (Package Archives): Use @key{RET} instead of
  @kbd{RET}.
  * processes.texi (Signals to Processes): Use @key{RET} instead
  of @code{RET}.
  (Signals to Processes): signal-process is a command.
  * text.texi (Clickable Text): Use @key{RET} instead of
  @kbd{RET}.
  (Base 64): base64-encode-string is not a command while
  base64-decode-region is.
  * windows.texi (Switching Buffers): pop-to-buffer is a command.
modified:
  doc/lispref/ChangeLog
  doc/lispref/commands.texi
  doc/lispref/compile.texi
  doc/lispref/debugging.texi
  doc/lispref/display.texi
  doc/lispref/files.texi
  doc/lispref/frames.texi
  doc/lispref/help.texi
  doc/lispref/markers.texi
  doc/lispref/minibuf.texi
  doc/lispref/modes.texi
  doc/lispref/os.texi
  doc/lispref/package.texi
  doc/lispref/processes.texi
  doc/lispref/text.texi
  doc/lispref/windows.texi

=== modified file 'doc/lispref/ChangeLog'
--- a/doc/lispref/ChangeLog     2012-05-08 19:39:29 +0000
+++ b/doc/lispref/ChangeLog     2012-05-15 09:38:50 +0000
@@ -1,3 +1,55 @@
+2012-05-15  Martin Rudalics  <address@hidden>
+
+       * commands.texi (Recursive Editing): recursive-edit is a
+       command.
+
+       * compile.texi (Docs and Compilation):
+       byte-compile-dynamic-docstrings is an option.
+
+       * debugging.texi (Invoking the Debugger): debug is a command.
+
+       * display.texi (Progress): progress-reporter-update and
+       progress-reporter-force-update have VALUE argument optional.
+       (Animated Images): Use address@hidden instead of non-nil.
+
+       * files.texi (Format Conversion Round-Trip): Use address@hidden
+       instead of non-nil.
+
+       * frames.texi (Creating Frames): make-frame is a command.
+       (Input Focus): select-frame is a command.
+       (Pointer Shape): void-text-area-pointer is an option.
+
+       * help.texi (Describing Characters): read-kbd-macro is a
+       command.
+       (Help Functions): describe-prefix-bindings is a command.
+
+       * markers.texi (Creating Markers): Both arguments of copy-marker
+       are optional.
+
+       * minibuf.texi (Reading File Names): Use @kbd instead of @code.
+
+       * modes.texi (Mode Line Variables): mode-line-remote and
+       mode-line-client are not options.
+       (Imenu): imenu-add-to-menubar is a command.
+       (SMIE Indentation Helpers): Use address@hidden instead of
+       non-nil.
+
+       * os.texi (Sound Output): play-sound-file is a command.
+
+       * package.texi (Package Archives): Use @key{RET} instead of
+       @kbd{RET}.
+
+       * processes.texi (Signals to Processes): Use @key{RET} instead
+       of @code{RET}.
+       (Signals to Processes): signal-process is a command.
+
+       * text.texi (Clickable Text): Use @key{RET} instead of
+       @kbd{RET}.
+       (Base 64): base64-encode-string is not a command while
+       base64-decode-region is.
+
+       * windows.texi (Switching Buffers): pop-to-buffer is a command.
+
 2012-05-08  Glenn Morris  <address@hidden>
 
        * Makefile.in (clean, mostlyclean): Add some more vol1/2 items.

=== modified file 'doc/lispref/commands.texi'
--- a/doc/lispref/commands.texi 2012-05-04 07:27:29 +0000
+++ b/doc/lispref/commands.texi 2012-05-15 09:38:50 +0000
@@ -3211,7 +3211,7 @@
   Recursive editing levels are also used when you type @kbd{C-r} in
 @code{query-replace} or use @kbd{C-x q} (@code{kbd-macro-query}).
 
address@hidden recursive-edit
address@hidden Command recursive-edit
 @cindex suspend evaluation
 This function invokes the editor command loop.  It is called
 automatically by the initialization of Emacs, to let the user begin
@@ -3238,7 +3238,7 @@
 (simple-rec)
      @result{} nil
 @end example
address@hidden defun
address@hidden deffn
 
 @deffn Command exit-recursive-edit
 This function exits from the innermost recursive edit (including

=== modified file 'doc/lispref/compile.texi'
--- a/doc/lispref/compile.texi  2012-05-05 01:05:12 +0000
+++ b/doc/lispref/compile.texi  2012-05-15 09:38:50 +0000
@@ -291,10 +291,10 @@
 -*-byte-compile-dynamic-docstrings: nil;-*-
 @end example
 
address@hidden byte-compile-dynamic-docstrings
address@hidden byte-compile-dynamic-docstrings
 If this is address@hidden, the byte compiler generates compiled files
 that are set up for dynamic loading of documentation strings.
address@hidden defvar
address@hidden defopt
 
 @node Dynamic Loading
 @section Dynamic Loading of Individual Functions

=== modified file 'doc/lispref/debugging.texi'
--- a/doc/lispref/debugging.texi        2012-04-10 07:11:23 +0000
+++ b/doc/lispref/debugging.texi        2012-05-15 09:38:50 +0000
@@ -448,7 +448,7 @@
   Here we describe in full detail the function @code{debug} that is used
 to invoke the debugger.
 
address@hidden debug &rest debugger-args
address@hidden Command debug &rest debugger-args
 This function enters the debugger.  It switches buffers to a buffer
 named @file{*Backtrace*} (or @file{*Backtrace*<2>} if it is the second
 recursive entry to the debugger, etc.), and fills it with information
@@ -535,7 +535,7 @@
 display messages---for example, to remind yourself of the conditions
 under which @code{debug} is called.
 @end table
address@hidden defun
address@hidden deffn
 
 @node Internals of Debugger
 @subsection Internals of the Debugger

=== modified file 'doc/lispref/display.texi'
--- a/doc/lispref/display.texi  2012-04-26 00:31:47 +0000
+++ b/doc/lispref/display.texi  2012-05-15 09:38:50 +0000
@@ -414,7 +414,7 @@
 message is printed immediately.
 @end defun
 
address@hidden progress-reporter-update reporter value
address@hidden progress-reporter-update reporter &optional value
 This function does the main work of reporting progress of your
 operation.  It displays the message of @var{reporter}, followed by
 progress percentage determined by @var{value}.  If percentage is zero,
@@ -435,7 +435,7 @@
 likely negate your effort.
 @end defun
 
address@hidden progress-reporter-force-update reporter value &optional 
new-message
address@hidden progress-reporter-force-update reporter &optional value 
new-message
 This function is similar to @code{progress-reporter-update} except
 that it prints a message in the echo area unconditionally.
 
@@ -4905,7 +4905,7 @@
 The following functions related to animated images are available.
 
 @defun image-animated-p image
-This function returns non-nil if @var{image} can be animated.
+This function returns address@hidden if @var{image} can be animated.
 The actual return value is a cons @code{(@var{nimages} . @var{delay})}, 
 where @var{nimages} is the number of frames and @var{delay} is the
 delay in seconds between them.

=== modified file 'doc/lispref/files.texi'
--- a/doc/lispref/files.texi    2012-04-28 08:05:01 +0000
+++ b/doc/lispref/files.texi    2012-05-15 09:38:50 +0000
@@ -3129,10 +3129,10 @@
 This command writes the current buffer contents into the file @var{file}
 in a format based on @var{format}, which is a list of format names.  It
 constructs the actual format starting from @var{format}, then appending
-any elements from the value of @code{buffer-file-format} with a non-nil
address@hidden flag (see above), if they are not already present in
address@hidden  It then updates @code{buffer-file-format} with this
-format, making it the default for future saves.  Except for the
+any elements from the value of @code{buffer-file-format} with a
address@hidden @var{preserve} flag (see above), if they are not already
+present in @var{format}.  It then updates @code{buffer-file-format} with
+this format, making it the default for future saves.  Except for the
 @var{format} argument, this command is similar to @code{write-file}.  In
 particular, @var{confirm} has the same meaning and interactive treatment
 as the corresponding argument to @code{write-file}.  @xref{Definition of

=== modified file 'doc/lispref/frames.texi'
--- a/doc/lispref/frames.texi   2012-04-26 00:31:47 +0000
+++ b/doc/lispref/frames.texi   2012-05-15 09:38:50 +0000
@@ -109,7 +109,7 @@
 
 To create a new frame, call the function @code{make-frame}.
 
address@hidden make-frame &optional alist
address@hidden Command make-frame &optional alist
 This function creates and returns a new frame, displaying the current
 buffer.
 
@@ -135,7 +135,7 @@
 @xref{Input Focus}.  The previously selected frame remains selected.
 On graphical terminals, however, the windowing system may select the
 new frame for its own reasons.
address@hidden defun
address@hidden deffn
 
 @defvar before-make-frame-hook
 A normal hook run by @code{make-frame} before it creates the frame.
@@ -1396,7 +1396,7 @@
 of this function is not significant.
 @end defun
 
address@hidden select-frame frame &optional norecord
address@hidden Command select-frame frame &optional norecord
 This function selects frame @var{frame}, temporarily disregarding the
 focus of the X server if any.  The selection of @var{frame} lasts until
 the next time the user does something to select a different frame, or
@@ -1419,7 +1419,7 @@
 In general, you should never use @code{select-frame} in a way that
 could switch to a different terminal without switching back when
 you're done.
address@hidden defun
address@hidden deffn
 
 Emacs cooperates with the window system by arranging to select frames as
 the server and window manager request.  It does so by generating a
@@ -1882,12 +1882,12 @@
 @code{arrow} style, but you can specify a different style (one of
 those above) by setting @code{void-text-area-pointer}.
 
address@hidden void-text-area-pointer
address@hidden void-text-area-pointer
 This variable specifies the mouse pointer style for void text areas.
 These include the areas after the end of a line or below the last line
 in the buffer.  The default is to use the @code{arrow} (non-text)
 pointer style.
address@hidden defvar
address@hidden defopt
 
   When using X, you can specify what the @code{text} pointer style
 really looks like by setting the variable @code{x-pointer-shape}.

=== modified file 'doc/lispref/help.texi'
--- a/doc/lispref/help.texi     2012-04-26 00:31:47 +0000
+++ b/doc/lispref/help.texi     2012-05-15 09:38:50 +0000
@@ -512,7 +512,7 @@
 @end smallexample
 @end defun
 
address@hidden read-kbd-macro string &optional need-vector
address@hidden Command read-kbd-macro string &optional need-vector
 This function is used mainly for operating on keyboard macros, but it
 can also be used as a rough inverse for @code{key-description}.  You
 call it with a string containing key descriptions, separated by spaces;
@@ -520,7 +520,7 @@
 (This may or may not be a single valid key sequence, depending on what
 events you use; @pxref{Key Sequences}.)  If @var{need-vector} is
 address@hidden, the return value is always a vector.
address@hidden defun
address@hidden deffn
 
 @node Help Functions
 @section Help Functions
@@ -627,12 +627,12 @@
 variable's default value is @code{describe-prefix-bindings}.
 @end defvar
 
address@hidden describe-prefix-bindings
address@hidden Command describe-prefix-bindings
 This function calls @code{describe-bindings} to display a list of all
 the subcommands of the prefix key of the most recent key sequence.  The
 prefix described consists of all but the last event of that key
 sequence.  (The last event is, presumably, the help character.)
address@hidden defun
address@hidden deffn
 
   The following two functions are meant for modes that want to provide
 help without relinquishing control, such as the ``electric'' modes.

=== modified file 'doc/lispref/markers.texi'
--- a/doc/lispref/markers.texi  2012-03-07 08:33:11 +0000
+++ b/doc/lispref/markers.texi  2012-05-15 09:38:50 +0000
@@ -206,7 +206,7 @@
 @end example
 @end defun
 
address@hidden copy-marker marker-or-integer &optional insertion-type
address@hidden copy-marker &optional marker-or-integer insertion-type
 If passed a marker as its argument, @code{copy-marker} returns a
 new marker that points to the same place and the same buffer as does
 @var{marker-or-integer}.  If passed an integer as its argument,

=== modified file 'doc/lispref/minibuf.texi'
--- a/doc/lispref/minibuf.texi  2012-05-05 02:49:19 +0000
+++ b/doc/lispref/minibuf.texi  2012-05-15 09:38:50 +0000
@@ -1404,7 +1404,7 @@
 If the user types @key{RET} in an empty minibuffer, this function
 returns an empty string, regardless of the value of
 @var{require-match}.  This is, for instance, how the user can make the
-current buffer visit no file using @code{M-x set-visited-file-name}.
+current buffer visit no file using @kbd{M-x set-visited-file-name}.
 
 If @var{predicate} is address@hidden, it specifies a function of one
 argument that decides which file names are acceptable completion

=== modified file 'doc/lispref/modes.texi'
--- a/doc/lispref/modes.texi    2012-04-26 17:56:38 +0000
+++ b/doc/lispref/modes.texi    2012-05-15 09:38:50 +0000
@@ -1991,14 +1991,14 @@
 on the process status, and whether narrowing is in effect.
 @end defopt
 
address@hidden mode-line-remote
address@hidden mode-line-remote
 This variable is used to show whether @code{default-directory} for the
 current buffer is remote.
address@hidden defopt
address@hidden defvar
 
address@hidden mode-line-client
address@hidden mode-line-client
 This variable is used to identify @code{emacsclient} frames.
address@hidden defopt
address@hidden defvar
 
   The following three variables are used in @code{mode-line-modes}:
 
@@ -2316,10 +2316,10 @@
 choose one of them and move point to it.  Major modes can add a menu
 bar item to use Imenu using @code{imenu-add-to-menubar}.
 
address@hidden imenu-add-to-menubar name
address@hidden Command imenu-add-to-menubar name
 This function defines a local menu bar item named @var{name}
 to run Imenu.
address@hidden defun
address@hidden deffn
 
   The user-level commands for using Imenu are described in the Emacs
 Manual (@pxref{Imenu,, Imenu, emacs, the Emacs Manual}).  This section
@@ -3861,9 +3861,9 @@
 @end defun
 
 @defun smie-rule-sibling-p
-Return non-nil if the current token's parent is actually a sibling.
-This is the case for example when the parent of a @code{","} is just the
-previous @code{","}.
+Return address@hidden if the current token's parent is actually a
+sibling.  This is the case for example when the parent of a @code{","}
+is just the previous @code{","}.
 @end defun
 
 @defun smie-rule-parent &optional offset

=== modified file 'doc/lispref/os.texi'
--- a/doc/lispref/os.texi       2012-04-12 14:50:58 +0000
+++ b/doc/lispref/os.texi       2012-05-15 09:38:50 +0000
@@ -2106,10 +2106,10 @@
 Each function is called with one argument, @var{sound}.
 @end defun
 
address@hidden play-sound-file file &optional volume device
address@hidden Command play-sound-file file &optional volume device
 This function is an alternative interface to playing a sound @var{file}
 specifying an optional @var{volume} and @var{device}.
address@hidden defun
address@hidden deffn
 
 @defvar play-sound-functions
 A list of functions to be called before playing a sound.  Each function

=== modified file 'doc/lispref/package.texi'
--- a/doc/lispref/package.texi  2012-04-28 08:05:01 +0000
+++ b/doc/lispref/package.texi  2012-05-15 09:38:50 +0000
@@ -295,8 +295,8 @@
 
   A convenient way to set up and update a package archive is via the
 @code{package-x} library.  This is included with Emacs, but not loaded
-by default; type @kbd{M-x load-library @kbd{RET} package-x @kbd{RET}}
-to load it, or add @code{(require 'package-x)} to your init file.
+by default; type @kbd{M-x load-library @key{RET} package-x @key{RET}} to
+load it, or add @code{(require 'package-x)} to your init file.
 @xref{Lisp Libraries,, Lisp Libraries, emacs, The GNU Emacs Manual}.
 Once loaded, you can make use of the following:
 

=== modified file 'doc/lispref/processes.texi'
--- a/doc/lispref/processes.texi        2012-04-20 06:39:29 +0000
+++ b/doc/lispref/processes.texi        2012-05-15 09:38:50 +0000
@@ -1071,7 +1071,7 @@
 @defun interrupt-process &optional process current-group
 This function interrupts the process @var{process} by sending the
 signal @code{SIGINT}.  Outside of Emacs, typing the ``interrupt
-character'' (normally @kbd{C-c} on some systems, and @code{DEL} on
+character'' (normally @kbd{C-c} on some systems, and @key{DEL} on
 others) sends this signal.  When the argument @var{current-group} is
 address@hidden, you can think of this function as ``typing @kbd{C-c}''
 on the terminal by which Emacs talks to the subprocess.
@@ -1110,7 +1110,7 @@
 stopped previously.
 @end defun
 
address@hidden signal-process process signal
address@hidden Command signal-process process signal
 This function sends a signal to process @var{process}.  The argument
 @var{signal} specifies which signal to send; it should be an integer,
 or a symbol whose name is a signal.
@@ -1118,7 +1118,7 @@
 The @var{process} argument can be a system process @acronym{ID} (an
 integer); that allows you to send signals to processes that are not
 children of Emacs.  @xref{System Processes}.
address@hidden defun
address@hidden deffn
 
 @node Output from Processes
 @section Receiving Output from Processes

=== modified file 'doc/lispref/text.texi'
--- a/doc/lispref/text.texi     2012-05-04 07:29:52 +0000
+++ b/doc/lispref/text.texi     2012-05-15 09:38:50 +0000
@@ -3531,7 +3531,7 @@
 @dfn{link}.
 
   Implementing a link involves three separate steps: (1) indicating
-clickability when the mouse moves over the link; (2) making @kbd{RET}
+clickability when the mouse moves over the link; (2) making @key{RET}
 or @kbd{Mouse-2} on that link do something; and (3) setting up a
 @code{follow-link} condition so that the link obeys
 @code{mouse-1-click-follows-link}.
@@ -4069,7 +4069,7 @@
 the output is just one long line.
 @end deffn
 
address@hidden Command base64-encode-string string &optional no-line-break
address@hidden base64-encode-string string &optional no-line-break
 This function converts the string @var{string} into base 64 code.  It
 returns a string containing the encoded text.  As for
 @code{base64-encode-region}, an error is signaled if a character in the
@@ -4079,15 +4079,15 @@
 text, to avoid overlong lines.  However, if the optional argument
 @var{no-line-break} is address@hidden, these newlines are not added, so
 the result string is just one long line.
address@hidden deffn
address@hidden defun
 
address@hidden base64-decode-region beg end
address@hidden Command base64-decode-region beg end
 This function converts the region from @var{beg} to @var{end} from base
 64 code into the corresponding decoded text.  It returns the length of
 the decoded text.
 
 The decoding functions ignore newline characters in the encoded text.
address@hidden defun
address@hidden deffn
 
 @defun base64-decode-string string
 This function converts the string @var{string} from base 64 code into

=== modified file 'doc/lispref/windows.texi'
--- a/doc/lispref/windows.texi  2012-04-21 19:31:05 +0000
+++ b/doc/lispref/windows.texi  2012-05-15 09:38:50 +0000
@@ -1559,7 +1559,7 @@
 @code{display-buffer} will affect it as well.  @xref{Choosing Window},
 for the documentation of @code{display-buffer}.
 
address@hidden pop-to-buffer buffer-or-name &optional action norecord
address@hidden Command pop-to-buffer buffer-or-name &optional action norecord
 This function makes @var{buffer-or-name} the current buffer and
 displays it in some window, preferably not the window previously
 selected.  It then selects the displaying window.  If that window is
@@ -1582,7 +1582,7 @@
 
 Like @code{switch-to-buffer}, this function updates the buffer list
 unless @var{norecord} is address@hidden
address@hidden defun
address@hidden deffn
 
 @node Choosing Window
 @section Choosing a Window for Display