changeset 16736:981e116b4ac6

Minor cleanups for overfull hboxes.
author Richard M. Stallman <rms@gnu.org>
date Fri, 20 Dec 1996 00:09:23 +0000
parents 940b9fcc1da6
children f93f805e86da
files lispref/commands.texi lispref/compile.texi lispref/control.texi lispref/edebug.texi lispref/errors.texi lispref/files.texi lispref/help.texi lispref/internals.texi lispref/loading.texi lispref/minibuf.texi lispref/numbers.texi lispref/objects.texi lispref/searching.texi lispref/text.texi lispref/tips.texi lispref/windows.texi
diffstat 16 files changed, 68 insertions(+), 61 deletions(-) [+]
line wrap: on
line diff
--- a/lispref/commands.texi	Fri Dec 20 00:01:41 1996 +0000
+++ b/lispref/commands.texi	Fri Dec 20 00:09:23 1996 +0000
@@ -553,13 +553,13 @@
 @end deffn
 
 @defun interactive-p
-This function returns @code{t} if the containing function (the one that
-called @code{interactive-p}) was called interactively, with the function
-@code{call-interactively}.  (It makes no difference whether
-@code{call-interactively} was called from Lisp or directly from the
-editor command loop.)  If the containing function was called by Lisp
-evaluation (or with @code{apply} or @code{funcall}), then it was not
-called interactively.
+This function returns @code{t} if the containing function (the one whose
+code includes the call to @code{interactive-p}) was called
+interactively, with the function @code{call-interactively}.  (It makes
+no difference whether @code{call-interactively} was called from Lisp or
+directly from the editor command loop.)  If the containing function was
+called by Lisp evaluation (or with @code{apply} or @code{funcall}), then
+it was not called interactively.
 
 The most common use of @code{interactive-p} is for deciding whether to
 print an informative message.  As a special exception,
@@ -2187,8 +2187,8 @@
 
 @defvar current-prefix-arg
 This variable holds the raw prefix argument for the @emph{current}
-command.  Commands may examine it directly, but the usual way to access
-it is with @code{(interactive "P")}.
+command.  Commands may examine it directly, but the usual method for
+accessing it is with @code{(interactive "P")}.
 @end defvar
 
 @defvar prefix-arg
@@ -2197,9 +2197,9 @@
 the following command work by setting this variable.
 @end defvar
 
-  Do not call the functions @code{universal-argument},
-@code{digit-argument}, or @code{negative-argument} unless you intend to
-let the user enter the prefix argument for the @emph{next} command.
+  Do not call @code{universal-argument}, @code{digit-argument}, or
+@code{negative-argument} unless you intend to let the user enter the
+prefix argument for the @emph{next} command.
 
 @deffn Command universal-argument
 This command reads input and specifies a prefix argument for the
--- a/lispref/compile.texi	Fri Dec 20 00:01:41 1996 +0000
+++ b/lispref/compile.texi	Fri Dec 20 00:09:23 1996 +0000
@@ -94,9 +94,9 @@
 @code{byte-compile-file}, or several files with
 @code{byte-recompile-directory} or @code{batch-byte-compile}.
 
-  When you run the byte compiler, you may get warnings in a buffer
-called @samp{*Compile-Log*}.  These report things in your program that
-suggest a problem but are not necessarily erroneous.
+  The byte compiler produces error messages and warnings about each file
+in a buffer called @samp{*Compile-Log*}.  These report things in your
+program that suggest a problem but are not necessarily erroneous.
 
 @cindex macro compilation
   Be careful when byte-compiling code that uses macros.  Macro calls are
--- a/lispref/control.texi	Fri Dec 20 00:01:41 1996 +0000
+++ b/lispref/control.texi	Fri Dec 20 00:09:23 1996 +0000
@@ -821,10 +821,10 @@
 @code{unwind-protect} forms that are exited.  Once control arrives at
 the handler, the body of the handler is executed.
 
-  After execution of the handler body, execution continues by returning
-from the @code{condition-case} form.  Because the protected form is
-exited completely before execution of the handler, the handler cannot
-resume execution at the point of the error, nor can it examine variable
+  After execution of the handler body, execution returns from the
+@code{condition-case} form.  Because the protected form is exited
+completely before execution of the handler, the handler cannot resume
+execution at the point of the error, nor can it examine variable
 bindings that were made within the protected form.  All it can do is
 clean up and proceed.
 
--- a/lispref/edebug.texi	Fri Dec 20 00:01:41 1996 +0000
+++ b/lispref/edebug.texi	Fri Dec 20 00:09:23 1996 +0000
@@ -452,7 +452,7 @@
 breakpoint is temporary.
 
 @item B
-Move point to the next breakpoint in the definition
+Move point to the next breakpoint in the current definition
 (@code{edebug-next-breakpoint}).
 @end table
 
@@ -505,9 +505,9 @@
 
 @findex edebug-set-global-break-condition
 @vindex edebug-global-break-condition
-  You can set or edit the condition expression, stored in
-@code{edebug-global-break-condition}, using the @kbd{X} command
-(@code{edebug-set-global-break-condition}).
+  The condition expression is stored in
+@code{edebug-global-break-condition}.  You can specify a new expression
+using the @kbd{X} command (@code{edebug-set-global-break-condition}).
 
   The global break condition is the simplest way to find where in your
 code some event occurs, but it makes code run much more slowly.  So you
--- a/lispref/errors.texi	Fri Dec 20 00:01:41 1996 +0000
+++ b/lispref/errors.texi	Fri Dec 20 00:09:23 1996 +0000
@@ -53,7 +53,8 @@
 @xref{Read Only Buffers}.
 
 @item cyclic-function-indirection
-@code{"Symbol's chain of function indirections contains a loop"}@*
+@code{"Symbol's chain of function indirections contains a@*
+loop"}@*
 @xref{Function Indirection}.
 
 @item end-of-buffer
--- a/lispref/files.texi	Fri Dec 20 00:01:41 1996 +0000
+++ b/lispref/files.texi	Fri Dec 20 00:09:23 1996 +0000
@@ -1081,9 +1081,9 @@
 @end group
 @end example
 
-Then we evaluate the form @code{(add-name-to-file "~/lewis/foo"
-"~/lewis/foo2")}.  Again we list the files.  This shows two names,
-@file{foo} and @file{foo2}.
+Now we create a hard link, by calling @code{add-name-to-file}, then list
+the files again.  This shows two names for one file, @file{foo} and
+@file{foo2}.
 
 @example
 @group
@@ -1683,8 +1683,8 @@
 directory part and no slash.  The current buffer's default directory is
 prepended to @var{directory}, if @var{directory} is not absolute.
 
-In the following example, suppose that the current default directory,
-@file{~rms/lewis}, has five files whose names begin with @samp{f}:
+In the following example, suppose that @file{~rms/lewis} is the current
+default directory, and has five files whose names begin with @samp{f}:
 @file{foo}, @file{file~}, @file{file.c}, @file{file.c.~1~}, and
 @file{file.c.~2~}.@refill
 
@@ -1948,26 +1948,30 @@
 @code{delete-file},@*
 @code{diff-latest-backup-file},
 @code{directory-file-name},
-@code{directory-files}, @code{dired-call-process},
+@code{directory-files},@*
+@code{dired-call-process},
 @code{dired-compress-file}, @code{dired-uncache},
 @code{expand-file-name},@*
 @code{file-accessible-directory-p},
-@code{file-attributes}, @code{file-directory-p},
+@code{file-attributes}, @code{file-directory-p},@*
 @code{file-executable-p}, @code{file-exists-p}, @code{file-local-copy},
 @code{file-modes}, @code{file-name-all-completions},
-@code{file-name-as-directory}, @code{file-name-completion},
-@code{file-name-directory}, @code{file-name-nondirectory},
+@code{file-name-as-directory}, @code{file-name-completion},@*
+@code{file-name-directory},
+@code{file-name-nondirectory},
 @code{file-name-sans-versions}, @code{file-newer-than-file-p},
 @code{file-ownership-preserved-p},
 @code{file-readable-p}, @code{file-regular-p}, @code{file-symlink-p},
 @code{file-truename}, @code{file-writable-p},
 @code{find-backup-file-name},
 @code{get-file-buffer},
-@code{insert-directory}, @code{insert-file-contents},
+@code{insert-directory},@*
+@code{insert-file-contents},
 @code{load}, @code{make-directory},
 @code{make-symbolic-link}, @code{rename-file}, @code{set-file-modes},
 @code{set-visited-file-modtime}, @code{shell-command}.
-@code{unhandled-file-name-directory}, @code{vc-registered},
+@code{unhandled-file-name-directory},@*
+@code{vc-registered},
 @code{verify-visited-file-modtime}, @code{write-region}.
 
 Handlers for @code{insert-file-contents} typically need to clear the
--- a/lispref/help.texi	Fri Dec 20 00:01:41 1996 +0000
+++ b/lispref/help.texi	Fri Dec 20 00:09:23 1996 +0000
@@ -213,7 +213,7 @@
 
 ---------- Buffer: *Help* ----------
 goal-column     Option 
-*Semipermanent goal column for vertical motion, as set by C-x C-n, or nil.
+*Semipermanent goal column for vertical motion, as set by @dots{}
 @end group
 @c Do not blithely break or fill these lines.
 @c That makes them incorrect.
--- a/lispref/internals.texi	Fri Dec 20 00:01:41 1996 +0000
+++ b/lispref/internals.texi	Fri Dec 20 00:09:23 1996 +0000
@@ -400,7 +400,7 @@
 @smallexample
 @group
 DEFUN ("or", For, Sor, 0, UNEVALLED, 0,
-  "Eval args until one of them yields non-nil, then return that value.\n\
+  "Eval args until one of them yields non-nil; return that value.\n\
 The remaining args are not evalled at all.\n\
 @end group
 @group
--- a/lispref/loading.texi	Fri Dec 20 00:01:41 1996 +0000
+++ b/lispref/loading.texi	Fri Dec 20 00:09:23 1996 +0000
@@ -474,7 +474,7 @@
 
 @smallexample
 (defun run-prolog ()
-  "Run an inferior Prolog process, input and output via buffer *prolog*."
+  "Run an inferior Prolog process, with I/O via buffer *prolog*."
   (interactive)
   (require 'comint)
   (switch-to-buffer (make-comint "prolog" prolog-program-name))
--- a/lispref/minibuf.texi	Fri Dec 20 00:01:41 1996 +0000
+++ b/lispref/minibuf.texi	Fri Dec 20 00:09:23 1996 +0000
@@ -861,9 +861,9 @@
 If the user types @kbd{forward-c @key{RET}}, then this function returns
 @code{forward-char}.
 
-The @code{read-command} function is a simplified interface to the
-function @code{completing-read}.  It uses the variable @code{obarray} so
-as to complete in the set of extant Lisp symbols, and it uses the
+The @code{read-command} function is a simplified interface to
+@code{completing-read}.  It uses the variable @code{obarray} so as to
+complete in the set of extant Lisp symbols, and it uses the
 @code{commandp} predicate so as to accept only command names:
 
 @cindex @code{commandp} example
--- a/lispref/numbers.texi	Fri Dec 20 00:01:41 1996 +0000
+++ b/lispref/numbers.texi	Fri Dec 20 00:09:23 1996 +0000
@@ -103,8 +103,8 @@
 1111  1111 1111  1111 1111  1111 1011
 @end example
 
-  In this implementation, the largest 28-bit binary integer is the
-decimal integer 134,217,727.  In binary, it looks like this:
+  In this implementation, the largest 28-bit binary integer value is
+134,217,727 in decimal.  In binary, it looks like this:
 
 @example
 0111  1111 1111  1111 1111  1111 1111
--- a/lispref/objects.texi	Fri Dec 20 00:01:41 1996 +0000
+++ b/lispref/objects.texi	Fri Dec 20 00:09:23 1996 +0000
@@ -1158,9 +1158,10 @@
 sizes, and contents of the windows in a frame, so you can recreate the
 same arrangement of windows later.
 
-  Window configurations do not have a read syntax.  They print as
-@samp{#<window-configuration>}.  @xref{Window Configurations}, for a
-description of several functions related to window configurations.
+  Window configurations do not have a read syntax; their print syntax
+looks like @samp{#<window-configuration>}.  @xref{Window
+Configurations}, for a description of several functions related to
+window configurations.
 
 @node Process Type
 @subsection Process Type
@@ -1427,11 +1428,11 @@
 
 @defun type-of object
 This function returns a symbol naming the primitive type of
-@var{object}.  The value is one of @code{symbol}, @code{integer},
-@code{float}, @code{string}, @code{cons}, @code{vector}, @code{marker},
-@code{overlay}, @code{window}, @code{buffer}, @code{subr},
-@code{compiled-function}, @code{window-configuration}, or
-@code{process}.
+@var{object}.  The value is one of the symbols @code{symbol},
+@code{integer}, @code{float}, @code{string}, @code{cons}, @code{vector},
+@code{marker}, @code{overlay}, @code{window}, @code{buffer},
+@code{subr}, @code{compiled-function}, @code{process}, or
+@code{window-configuration}.
 
 @example
 (type-of 1)
--- a/lispref/searching.texi	Fri Dec 20 00:01:41 1996 +0000
+++ b/lispref/searching.texi	Fri Dec 20 00:09:23 1996 +0000
@@ -370,8 +370,9 @@
 
 @enumerate
 @item
-To enclose a set of @samp{\|} alternatives for other operations.
-Thus, @samp{\(foo\|bar\)x} matches either @samp{foox} or @samp{barx}.
+To enclose a set of @samp{\|} alternatives for other operations.  Thus,
+the regular expression @samp{\(foo\|bar\)x} matches either @samp{foox}
+or @samp{barx}.
 
 @item
 To enclose an expression for a suffix operator such as @samp{*} to act
--- a/lispref/text.texi	Fri Dec 20 00:01:41 1996 +0000
+++ b/lispref/text.texi	Fri Dec 20 00:09:23 1996 +0000
@@ -1183,7 +1183,7 @@
 
 In an interactive call, any prefix argument requests justification.
 
-In Adaptive Fill mode, which is enabled by default,
+In Adaptive Fill mode, which is enabled by default, calling the function
 @code{fill-region-as-paragraph} on an indented paragraph when there is
 no fill prefix uses the indentation of the second line of the paragraph
 as the fill prefix.
@@ -1200,7 +1200,7 @@
 follow specified justification style (see @code{current-justification},
 below).  @code{nil} means to do full justification.
 
-If @var{eop} is non-@code{nil}, that means do left-justification when
+If @var{eop} is non-@code{nil}, that means do left-justification if
 @code{current-justification} specifies full justification.  This is used
 for the last line of a paragraph; even if the paragraph as a whole is
 fully justified, the last line should not be.
--- a/lispref/tips.texi	Fri Dec 20 00:01:41 1996 +0000
+++ b/lispref/tips.texi	Fri Dec 20 00:09:23 1996 +0000
@@ -450,11 +450,11 @@
 @item
 Don't write key sequences directly in documentation strings.  Instead,
 use the @samp{\\[@dots{}]} construct to stand for them.  For example,
-instead of writing @samp{C-f}, write @samp{\\[forward-char]}.  When
-Emacs displays the documentation string, it substitutes whatever key is
-currently bound to @code{forward-char}.  (This is normally @samp{C-f},
-but it may be some other character if the user has moved key bindings.)
-@xref{Keys in Documentation}.
+instead of writing @samp{C-f}, write the construct
+@samp{\\[forward-char]}.  When Emacs displays the documentation string,
+it substitutes whatever key is currently bound to @code{forward-char}.
+(This is normally @samp{C-f}, but it may be some other character if the
+user has moved key bindings.)  @xref{Keys in Documentation}.
 
 @item
 In documentation strings for a major mode, you will want to refer to the
--- a/lispref/windows.texi	Fri Dec 20 00:01:41 1996 +0000
+++ b/lispref/windows.texi	Fri Dec 20 00:09:23 1996 +0000
@@ -259,7 +259,7 @@
 @smallexample
 @group
 (defun split-window-vertically (&optional arg)
-  "Split current window into two windows, one above the other."
+  "Split current window into two windows, @dots{}"
   (interactive "P")
   (split-window nil (and arg (prefix-numeric-value arg))))
 @end group