[Emacs-diffs] /srv/bzr/emacs/emacs-24 r107799: In doc/lispref, use @file for buffers, per the Texinfo manual.

[Glenn Morris]

------------------------------------------------------------
revno: 107799
committer: Glenn Morris <address@hidden>
branch nick: emacs-24
timestamp: Tue 2012-04-10 00:11:23 -0700
message:
  In doc/lispref, use @file for buffers, per the Texinfo manual.
  It renders the same as @samp, so there is no visible change in most cases.
modified:
  doc/lispref/ChangeLog
  doc/lispref/buffers.texi
  doc/lispref/compile.texi
  doc/lispref/customize.texi
  doc/lispref/debugging.texi
  doc/lispref/display.texi
  doc/lispref/edebug.texi
  doc/lispref/eval.texi
  doc/lispref/help.texi
  doc/lispref/intro.texi
  doc/lispref/keymaps.texi
  doc/lispref/minibuf.texi
  doc/lispref/modes.texi
  doc/lispref/os.texi
  doc/lispref/processes.texi
  doc/lispref/text.texi

=== modified file 'doc/lispref/ChangeLog'
--- a/doc/lispref/ChangeLog     2012-04-10 07:04:40 +0000
+++ b/doc/lispref/ChangeLog     2012-04-10 07:11:23 +0000
@@ -1,5 +1,10 @@
 2012-04-10  Glenn Morris  <address@hidden>
 
+       * buffers.texi, compile.texi, customize.texi, debugging.texi:
+       * display.texi, edebug.texi, eval.texi, help.texi, intro.texi:
+       * keymaps.texi, minibuf.texi, modes.texi, os.texi, processes.texi:
+       * text.texi: Use @file for buffers, per the Texinfo manual.
+
        * compile.texi (Compiler Errors): Add missing space in buffer name.
 
 2012-04-08  Chong Yidong  <address@hidden>

=== modified file 'doc/lispref/buffers.texi'
--- a/doc/lispref/buffers.texi  2012-02-27 07:26:13 +0000
+++ b/doc/lispref/buffers.texi  2012-04-10 07:11:23 +0000
@@ -863,7 +863,7 @@
 resort.  If @var{visible-ok} is address@hidden, then it does not matter
 whether a buffer is displayed somewhere or not.
 
-If no suitable buffer exists, the buffer @samp{*scratch*} is returned
+If no suitable buffer exists, the buffer @file{*scratch*} is returned
 (and created, if necessary).
 @end defun
 
@@ -874,7 +874,7 @@
 
 The argument @var{visible-ok} is handled as with @code{other-buffer},
 see above.  If no suitable buffer can be found, the buffer
address@hidden is returned.
address@hidden is returned.
 @end defun
 
 @deffn Command bury-buffer &optional buffer-or-name

=== modified file 'doc/lispref/compile.texi'
--- a/doc/lispref/compile.texi  2012-04-10 07:04:40 +0000
+++ b/doc/lispref/compile.texi  2012-04-10 07:11:23 +0000
@@ -92,7 +92,7 @@
 
   Sometimes, the byte compiler produces warning and/or error messages
 (@pxref{Compiler Errors}, for details).  These messages are recorded
-in a buffer called @samp{*Compile-Log*}, which uses Compilation mode.
+in a buffer called @file{*Compile-Log*}, which uses Compilation mode.
 @xref{Compilation Mode,,,emacs, The GNU Emacs Manual}.
 
 @cindex macro compilation
@@ -443,14 +443,14 @@
 @cindex compiler errors
 
   Byte compilation outputs all errors and warnings into the buffer
address@hidden  The messages include file names and line
address@hidden  The messages include file names and line
 numbers that identify the location of the problem.  The usual Emacs
 commands for operating on compiler diagnostics work properly on these
 messages.
 
   When an error is due to invalid syntax in the program, the byte
 compiler might get confused about the errors' exact location.  One way
-to investigate is to switch to the buffer @address@hidden *Compiler Input*}}.
+to investigate is to switch to the buffer @address@hidden *Compiler Input*}}.
 (This buffer name starts with a space, so it does not show up in
 @kbd{M-x list-buffers}.)  This buffer contains the program being
 compiled, and point shows how far the byte compiler was able to read;
@@ -602,7 +602,7 @@
 @deffn Command disassemble object &optional buffer-or-name
 This command displays the disassembled code for @var{object}.  In
 interactive use, or if @var{buffer-or-name} is @code{nil} or omitted,
-the output goes in a buffer named @samp{*Disassemble*}.  If
+the output goes in a buffer named @file{*Disassemble*}.  If
 @var{buffer-or-name} is address@hidden, it must be a buffer or the
 name of an existing buffer.  Then the output goes there, at point, and
 point is left before the output.

=== modified file 'doc/lispref/customize.texi'
--- a/doc/lispref/customize.texi        2012-02-05 14:27:06 +0000
+++ b/doc/lispref/customize.texi        2012-04-10 07:11:23 +0000
@@ -596,7 +596,7 @@
 @item color
 The value must be a valid color name.  The widget provides completion
 for color names, as well as a sample and a button for selecting a
-color name from a list of color names shown in a @samp{*Colors*}
+color name from a list of color names shown in a @file{*Colors*}
 buffer.
 @end table
 

=== modified file 'doc/lispref/debugging.texi'
--- a/doc/lispref/debugging.texi        2012-02-12 09:51:03 +0000
+++ b/doc/lispref/debugging.texi        2012-04-10 07:11:23 +0000
@@ -303,7 +303,7 @@
 @subsection Using the Debugger
 
   When the debugger is entered, it displays the previously selected
-buffer in one window and a buffer named @samp{*Backtrace*} in another
+buffer in one window and a buffer named @file{*Backtrace*} in another
 window.  The backtrace buffer contains one line for each level of Lisp
 function execution currently going on.  At the beginning of this buffer
 is a message describing the reason that the debugger was invoked (such
@@ -412,7 +412,7 @@
 
 @item R
 Like @kbd{e}, but also save the result of evaluation in the
-buffer @samp{*Debugger-record*}.
+buffer @file{*Debugger-record*}.
 
 @item q
 Terminate the program being debugged; return to top-level Emacs
@@ -450,7 +450,7 @@
 
 @defun debug &rest debugger-args
 This function enters the debugger.  It switches buffers to a buffer
-named @samp{*Backtrace*} (or @samp{*Backtrace*<2>} if it is the second
+named @file{*Backtrace*} (or @file{*Backtrace*<2>} if it is the second
 recursive entry to the debugger, etc.), and fills it with information
 about the stack of Lisp function calls.  It then enters a recursive
 edit, showing the backtrace buffer in Debugger mode.
@@ -461,7 +461,7 @@
 way the function @code{debug} can return to its caller.
 
 The use of the @var{debugger-args} is that @code{debug} displays the
-rest of its arguments at the top of the @samp{*Backtrace*} buffer, so
+rest of its arguments at the top of the @file{*Backtrace*} buffer, so
 that the user can see them.  Except as described below, this is the
 @emph{only} way these arguments are used.
 
@@ -560,7 +560,7 @@
 @cindex call stack
 This function prints a trace of Lisp function calls currently active.
 This is the function used by @code{debug} to fill up the
address@hidden buffer.  It is written in C, since it must have access
address@hidden buffer.  It is written in C, since it must have access
 to the stack to determine which function calls are active.  The return
 value is always @code{nil}.
 

=== modified file 'doc/lispref/display.texi'
--- a/doc/lispref/display.texi  2012-04-04 07:54:02 +0000
+++ b/doc/lispref/display.texi  2012-04-10 07:11:23 +0000
@@ -268,7 +268,7 @@
 function (@pxref{Formatting Strings}).  The resulting formatted string
 is displayed in the echo area; if it contains @code{face} text
 properties, it is displayed with the specified faces (@pxref{Faces}).
-The string is also added to the @samp{*Messages*} buffer, but without
+The string is also added to the @file{*Messages*} buffer, but without
 text properties (@pxref{Logging Messages}).
 
 In batch mode, the message is printed to the standard error stream,
@@ -341,7 +341,7 @@
 
 If @var{message} is a string, then the optional argument
 @var{buffer-name} is the name of the buffer used to display it when a
-pop-up buffer is used, defaulting to @samp{*Message*}.  In the case
+pop-up buffer is used, defaulting to @file{*Message*}.  In the case
 where @var{message} is a string and displayed in the echo area, it is
 not specified whether the contents are inserted into the buffer anyway.
 
@@ -474,16 +474,16 @@
 @end defmac
 
 @node Logging Messages
address@hidden Logging Messages in @samp{*Messages*}
address@hidden Logging Messages in @file{*Messages*}
 @cindex logging echo-area messages
 
   Almost all the messages displayed in the echo area are also recorded
-in the @samp{*Messages*} buffer so that the user can refer back to
+in the @file{*Messages*} buffer so that the user can refer back to
 them.  This includes all the messages that are output with
 @code{message}.
 
 @defopt message-log-max
-This variable specifies how many lines to keep in the @samp{*Messages*}
+This variable specifies how many lines to keep in the @file{*Messages*}
 buffer.  The value @code{t} means there is no limit on how many lines to
 keep.  The value @code{nil} disables message logging entirely.  Here's
 how to display a message and prevent it from being logged:
@@ -494,7 +494,7 @@
 @end example
 @end defopt
 
-  To make @samp{*Messages*} more convenient for the user, the logging
+  To make @file{*Messages*} more convenient for the user, the logging
 facility combines successive identical messages.  It also combines
 successive related messages for the sake of two cases: question
 followed by answer, and a series of progress messages.
@@ -624,7 +624,7 @@
 severity level, with @code{:warning} being the default.
 
 @var{buffer-name}, if address@hidden, specifies the name of the buffer
-for logging the warning.  By default, it is @samp{*Warnings*}.
+for logging the warning.  By default, it is @file{*Warnings*}.
 @end defun
 
 @defun lwarn type level message &rest args
@@ -2752,7 +2752,7 @@
 @itemx warning
 @itemx success
 For text concerning errors, warnings, or successes.  For example,
-these are used for messages in @samp{*Compilation*} buffers.
+these are used for messages in @file{*Compilation*} buffers.
 @end table
 
 @node Font Selection

=== modified file 'doc/lispref/edebug.texi'
--- a/doc/lispref/edebug.texi   2012-03-31 19:58:05 +0000
+++ b/doc/lispref/edebug.texi   2012-04-10 07:11:23 +0000
@@ -622,7 +622,7 @@
 saved outside window configuration---so that even if you turn saving
 back @emph{on}, the current window configuration remains unchanged when
 you next exit Edebug (by continuing the program).  However, the
-automatic redisplay of @samp{*edebug*} and @samp{*edebug-trace*} may
+automatic redisplay of @file{*edebug*} and @file{*edebug-trace*} may
 conflict with the buffers you wish to see unless you have enough windows
 open.
 
@@ -661,18 +661,18 @@
 @node Eval List
 @subsection Evaluation List Buffer
 
-  You can use the @dfn{evaluation list buffer}, called @samp{*edebug*}, to
+  You can use the @dfn{evaluation list buffer}, called @file{*edebug*}, to
 evaluate expressions interactively.  You can also set up the
 @dfn{evaluation list} of expressions to be evaluated automatically each
 time Edebug updates the display.
 
 @table @kbd
 @item E
-Switch to the evaluation list buffer @samp{*edebug*}
+Switch to the evaluation list buffer @file{*edebug*}
 (@code{edebug-visit-eval-list}).
 @end table
 
-  In the @samp{*edebug*} buffer you can use the commands of Lisp
+  In the @file{*edebug*} buffer you can use the commands of Lisp
 Interaction mode (@pxref{Lisp Interaction,,, emacs, The GNU Emacs
 Manual}) as well as these special commands:
 
@@ -699,7 +699,7 @@
 @end table
 
   You can evaluate expressions in the evaluation list window with
address@hidden or @kbd{C-x C-e}, just as you would in @samp{*scratch*};
address@hidden or @kbd{C-x C-e}, just as you would in @file{*scratch*};
 but they are evaluated in the context outside of Edebug.
 
   The expressions you enter interactively (and their results) are lost
@@ -758,8 +758,8 @@
 @kbd{C-c C-u}.  You need not insert dashes in the comment line---its
 contents don't matter.
 
-After selecting @samp{*edebug*}, you can return to the source code
-buffer with @kbd{C-c C-w}.  The @samp{*edebug*} buffer is killed when
+After selecting @file{*edebug*}, you can return to the source code
+buffer with @kbd{C-c C-w}.  The @file{*edebug*} buffer is killed when
 you continue execution, and recreated next time it is needed.
 
 @node Printing in Edebug
@@ -819,7 +819,7 @@
 @cindex trace buffer
 
   Edebug can record an execution trace, storing it in a buffer named
address@hidden  This is a log of function calls and returns,
address@hidden  This is a log of function calls and returns,
 showing the function names and their arguments and values.  To enable
 trace recording, set @code{edebug-trace} to a address@hidden value.
 
@@ -1567,7 +1567,7 @@
 
 @defopt edebug-trace
 If this is address@hidden, trace each function entry and exit.
-Tracing output is displayed in a buffer named @samp{*edebug-trace*}, one
+Tracing output is displayed in a buffer named @file{*edebug-trace*}, one
 function entry or exit per line, indented by the recursion level.
 
 Also see @code{edebug-tracing}, in @ref{Trace Buffer}.

=== modified file 'doc/lispref/eval.texi'
--- a/doc/lispref/eval.texi     2012-03-10 09:30:21 +0000
+++ b/doc/lispref/eval.texi     2012-04-10 07:11:23 +0000
@@ -807,7 +807,7 @@
 expressions that were read, evaluated, and printed from buffers
 (including the minibuffer) by the standard Emacs commands which do
 this.  (Note that this does @emph{not} include evaluation in
address@hidden buffers, nor evaluation using @kbd{C-j} in
address@hidden buffers, nor evaluation using @kbd{C-j} in
 @code{lisp-interaction-mode}.)  The elements are ordered most recent
 first.
 

=== modified file 'doc/lispref/help.texi'
--- a/doc/lispref/help.texi     2012-03-01 07:29:48 +0000
+++ b/doc/lispref/help.texi     2012-04-10 07:11:23 +0000
@@ -180,7 +180,7 @@
 @c Wordy to prevent overfull hboxes.  --rjc 15mar92
 Here is an example of using the two functions, @code{documentation} and
 @code{documentation-property}, to display the documentation strings for
-several symbols in a @samp{*Help*} buffer.
+several symbols in a @file{*Help*} buffer.
 
 @anchor{describe-symbols example}
 @smallexample
@@ -535,7 +535,7 @@
 documentation string, or @code{nil}, for @var{symbol} as a function,
 variable, etc.
 
-It also displays the symbols in a buffer named @samp{*Apropos*}, each
+It also displays the symbols in a buffer named @file{*Apropos*}, each
 with a one-line description taken from the beginning of its
 documentation string.
 
@@ -648,7 +648,7 @@
 
 @defun help-buffer
 This function returns the name of the help buffer, which is normally
address@hidden; if such a buffer does not exist, it is first created.
address@hidden; if such a buffer does not exist, it is first created.
 @end defun
 
 @defmac with-help-window buffer-name address@hidden
@@ -662,16 +662,16 @@
 @end defmac
 
 @defun help-setup-xref item interactive-p
-This function updates the cross reference data in the @samp{*Help*}
+This function updates the cross reference data in the @file{*Help*}
 buffer, which is used to regenerate the help information when the user
 clicks on the @samp{Back} or @samp{Forward} buttons.  Most commands
-that use the @samp{*Help*} buffer should invoke this function before
+that use the @file{*Help*} buffer should invoke this function before
 clearing the buffer.  The @var{item} argument should have the form
 @code{(@var{function} . @var{args})}, where @var{function} is a function
 to call, with argument list @var{args}, to regenerate the help buffer.
 The @var{interactive-p} argument is address@hidden if the calling
 command was invoked interactively; in that case, the stack of items
-for the @samp{*Help*} buffer's @samp{Back} buttons is cleared.
+for the @file{*Help*} buffer's @samp{Back} buttons is cleared.
 @end defun
 
 @xref{describe-symbols example}, for an example of using

=== modified file 'doc/lispref/intro.texi'
--- a/doc/lispref/intro.texi    2012-02-26 02:25:07 +0000
+++ b/doc/lispref/intro.texi    2012-04-10 07:11:23 +0000
@@ -247,7 +247,7 @@
 
   Many of the examples in this manual print text when they are
 evaluated.  If you execute example code in a Lisp Interaction buffer
-(such as the buffer @samp{*scratch*}), the printed text is inserted into
+(such as the buffer @file{*scratch*}), the printed text is inserted into
 the buffer.  If you execute the example by other means (such as by
 evaluating the function @code{eval-region}), the printed text is
 displayed in the echo area.

=== modified file 'doc/lispref/keymaps.texi'
--- a/doc/lispref/keymaps.texi  2012-03-10 03:27:10 +0000
+++ b/doc/lispref/keymaps.texi  2012-04-10 07:11:23 +0000
@@ -808,7 +808,7 @@
 @defun current-local-map
 This function returns the current buffer's local keymap, or @code{nil}
 if it has none.  In the following example, the keymap for the
address@hidden buffer (using Lisp Interaction mode) is a sparse keymap
address@hidden buffer (using Lisp Interaction mode) is a sparse keymap
 in which the entry for @key{ESC}, @acronym{ASCII} code 27, is another sparse
 keymap.
 
@@ -1922,7 +1922,7 @@
 
 @deffn Command describe-bindings &optional prefix buffer-or-name
 This function creates a listing of all current key bindings, and
-displays it in a buffer named @samp{*Help*}.  The text is grouped by
+displays it in a buffer named @file{*Help*}.  The text is grouped by
 modes---minor modes first, then the major mode, then global bindings.
 
 If @var{prefix} is address@hidden, it should be a prefix key; then the

=== modified file 'doc/lispref/minibuf.texi'
--- a/doc/lispref/minibuf.texi  2012-04-06 06:39:35 +0000
+++ b/doc/lispref/minibuf.texi  2012-04-10 07:11:23 +0000
@@ -1062,7 +1062,7 @@
 the @var{collection} argument, and the value of
 @code{minibuffer-completion-predicate} as the @var{predicate} argument.
 The list of completions is displayed as text in a buffer named
address@hidden
address@hidden
 @end deffn
 
 @defun display-completion-list completions &optional common-substring
@@ -1756,7 +1756,7 @@
 The value should be a function for @dfn{annotating} completions.  The
 function should take one argument, @var{string}, which is a possible
 completion.  It should return a string, which is displayed after the
-completion @var{string} in the @samp{*Completions*} buffer.
+completion @var{string} in the @file{*Completions*} buffer.
 
 @item display-sort-function
 The value should be a function for sorting completions.  The function

=== modified file 'doc/lispref/modes.texi'
--- a/doc/lispref/modes.texi    2012-03-16 01:40:20 +0000
+++ b/doc/lispref/modes.texi    2012-04-10 07:11:23 +0000
@@ -628,7 +628,7 @@
 This function sets the major mode of @var{buffer} to the default value of
 @code{major-mode}; if that is @code{nil}, it uses the
 current buffer's major mode (if that is suitable).  As an exception,
-if @var{buffer}'s name is @samp{*scratch*}, it sets the mode to
+if @var{buffer}'s name is @file{*scratch*}, it sets the mode to
 @code{initial-major-mode}.
 
 The low-level primitives for creating buffers do not use this function,
@@ -637,9 +637,9 @@
 @end defun
 
 @defopt initial-major-mode
address@hidden @samp{*scratch*}
address@hidden @file{*scratch*}
 The value of this variable determines the major mode of the initial
address@hidden buffer.  The value should be a symbol that is a major
address@hidden buffer.  The value should be a symbol that is a major
 mode command.  The default value is @code{lisp-interaction-mode}.
 @end defopt
 
@@ -908,7 +908,7 @@
 (@pxref{Reverting}).
 
 An example of a major mode derived from Special mode is Buffer Menu
-mode, which is used by the @samp{*Buffer List*} buffer.  @xref{List
+mode, which is used by the @file{*Buffer List*} buffer.  @xref{List
 Buffers,,Listing Existing Buffers, emacs, The GNU Emacs Manual}.
 @end deffn
 
@@ -2016,7 +2016,7 @@
 This buffer-local variable contains the mode line information on process
 status in modes used for communicating with subprocesses.  It is
 displayed immediately following the major mode name, with no intervening
-space.  For example, its value in the @samp{*shell*} buffer is
+space.  For example, its value in the @file{*shell*} buffer is
 @code{(":%s")}, which allows the shell to display its status along
 with the major mode as: @samp{(Shell:run)}.  Normally this variable
 is @code{nil}.

=== modified file 'doc/lispref/os.texi'
--- a/doc/lispref/os.texi       2012-04-08 02:07:16 +0000
+++ b/doc/lispref/os.texi       2012-04-10 07:11:23 +0000
@@ -170,7 +170,7 @@
 It runs the normal hook @code{after-init-hook}.
 
 @item
-If the buffer @samp{*scratch*} exists and is still in Fundamental mode
+If the buffer @file{*scratch*} exists and is still in Fundamental mode
 (as it should be by default), it sets its major mode according to
 @code{initial-major-mode}.
 
@@ -196,7 +196,7 @@
 
 @item
 If @code{initial-buffer-choice} is a string, it visits the file with
-that name.  If the @samp{*scratch*} buffer exists and is
+that name.  If the @file{*scratch*} buffer exists and is
 empty, it inserts @code{initial-scratch-message} into that buffer.
 
 @c To make things nice and confusing, the next three items can be
@@ -254,7 +254,7 @@
 
 @defopt inhibit-startup-screen
 This variable, if address@hidden, inhibits the startup screen.  In
-that case, Emacs typically displays the @samp{*scratch*} buffer; but
+that case, Emacs typically displays the @file{*scratch*} buffer; but
 see @code{initial-buffer-choice}, below.
 
 Do not set this variable in the init file of a new user, or in a way
@@ -274,7 +274,7 @@
 @ignore
 @c I do not think this should be mentioned.  AFAICS it is just a dodge
 @c around inhibit-startup-screen not being settable on a site-wide basis.
-If its value is @code{t}, Emacs displays the @samp{*scratch*} buffer.
+If its value is @code{t}, Emacs displays the @file{*scratch*} buffer.
 @end ignore
 @end defopt
 
@@ -299,8 +299,8 @@
 
 @defopt initial-scratch-message
 This variable, if address@hidden, should be a string, which is
-inserted into the @samp{*scratch*} buffer when Emacs starts up.  If it
-is @code{nil}, the @samp{*scratch*} buffer is empty.
+inserted into the @file{*scratch*} buffer when Emacs starts up.  If it
+is @code{nil}, the @file{*scratch*} buffer is empty.
 @end defopt
 
 @noindent
@@ -2233,7 +2233,7 @@
 shutdown.
 @end defvar
 
-Here is an example that just inserts some text into @samp{*scratch*} when
+Here is an example that just inserts some text into @file{*scratch*} when
 Emacs is restarted by the session manager.
 
 @example

=== modified file 'doc/lispref/processes.texi'
--- a/doc/lispref/processes.texi        2012-04-08 13:30:26 +0000
+++ b/doc/lispref/processes.texi        2012-04-10 07:11:23 +0000
@@ -714,7 +714,7 @@
 it finally deletes any process whose status was @samp{Exited} or
 @samp{Signaled}.  It returns @code{nil}.
 
-The processes are shown in a buffer named @samp{*Process List*}, whose
+The processes are shown in a buffer named @file{*Process List*}, whose
 major mode is named Process Menu mode.
 
 If @var{query-only} is address@hidden then it lists only processes

=== modified file 'doc/lispref/text.texi'
--- a/doc/lispref/text.texi     2012-03-31 10:27:04 +0000
+++ b/doc/lispref/text.texi     2012-04-10 07:11:23 +0000
@@ -4345,7 +4345,7 @@
 arguments.
 @end defvar
 
-  Output of messages into the @samp{*Messages*} buffer does not
+  Output of messages into the @file{*Messages*} buffer does not
 call these functions.
 
 @defmac combine-after-change-calls address@hidden