summaryrefslogtreecommitdiff
path: root/doc/lispref
diff options
context:
space:
mode:
Diffstat (limited to 'doc/lispref')
-rw-r--r--doc/lispref/ChangeLog8
-rw-r--r--doc/lispref/anti.texi2
-rw-r--r--doc/lispref/display.texi8
-rw-r--r--doc/lispref/files.texi5
-rw-r--r--doc/lispref/keymaps.texi4
-rw-r--r--doc/lispref/modes.texi8
-rw-r--r--doc/lispref/numbers.texi20
-rw-r--r--doc/lispref/os.texi17
-rw-r--r--doc/lispref/sequences.texi2
-rw-r--r--doc/lispref/text.texi4
10 files changed, 46 insertions, 32 deletions
diff --git a/doc/lispref/ChangeLog b/doc/lispref/ChangeLog
index 74557361eab..93128962c33 100644
--- a/doc/lispref/ChangeLog
+++ b/doc/lispref/ChangeLog
@@ -1,5 +1,13 @@
2014-06-08 Glenn Morris <rgm@gnu.org>
+ * os.texi (Startup Summary): Small fix for initial-buffer-choice.
+
+ * files.texi (Subroutines of Visiting): Mention uniquify.
+
+ * numbers.texi (Comparison of Numbers): Copyedits.
+
+2014-06-08 Glenn Morris <rgm@gnu.org>
+
* display.texi (Window Systems): Remove window-setup-hook.
* os.texi (Startup Summary, Init File):
Improve description of window-setup-hook.
diff --git a/doc/lispref/anti.texi b/doc/lispref/anti.texi
index 3de9f4ab9d1..2ca2290a022 100644
--- a/doc/lispref/anti.texi
+++ b/doc/lispref/anti.texi
@@ -30,7 +30,7 @@ minimum of fuss. But @xref{Dynamic Binding Tips}, for tips to avoid
making your programs hard to understand.
@item
-Calling a minor mode function from Lisp with a nil or omitted argument
+Calling a minor mode function from Lisp with a @code{nil} or omitted argument
does not enable the minor mode unconditionally; instead, it toggles
the minor mode---which is the straightforward thing to do, since that
is the behavior when invoked interactively. One downside is that it
diff --git a/doc/lispref/display.texi b/doc/lispref/display.texi
index b4f987bb2a8..e0349e4ca0c 100644
--- a/doc/lispref/display.texi
+++ b/doc/lispref/display.texi
@@ -1720,10 +1720,10 @@ Properties}.
@defun overlays-at pos &optional sorted
This function returns a list of all the overlays that cover the character at
-position @var{pos} in the current buffer. If @var{sorted} is non-nil, the list
-is in decreasing order of priority, otherwise it is in no particular order.
-An overlay contains position @var{pos} if it begins at or before @var{pos}, and
-ends after @var{pos}.
+position @var{pos} in the current buffer. If @var{sorted} is non-@code{nil},
+the list is in decreasing order of priority, otherwise it is in no particular
+order. An overlay contains position @var{pos} if it begins at or before
+@var{pos}, and ends after @var{pos}.
To illustrate usage, here is a Lisp function that returns a list of the
overlays that specify property @var{prop} for the character at point:
diff --git a/doc/lispref/files.texi b/doc/lispref/files.texi
index fcfd37e987d..ac77b94d8f6 100644
--- a/doc/lispref/files.texi
+++ b/doc/lispref/files.texi
@@ -254,11 +254,16 @@ is permanent local, so it is unaffected by changes of major modes.
which are sometimes useful in user Lisp code: @code{create-file-buffer}
and @code{after-find-file}. This section explains how to use them.
+@c FIXME This does not describe the default behavior, because
+@c uniquify is enabled by default and advises this function.
+@c This is confusing. uniquify should be folded into the function proper.
@defun create-file-buffer filename
This function creates a suitably named buffer for visiting
@var{filename}, and returns it. It uses @var{filename} (sans directory)
as the name if that name is free; otherwise, it appends a string such as
@samp{<2>} to get an unused name. See also @ref{Creating Buffers}.
+Note that the @file{uniquify} library affects the result of this
+function. @xref{Uniquify,,, emacs, The GNU Emacs Manual}.
@strong{Please note:} @code{create-file-buffer} does @emph{not}
associate the new buffer with a file and does not select the buffer.
diff --git a/doc/lispref/keymaps.texi b/doc/lispref/keymaps.texi
index a2168d3e53a..7cc2b393456 100644
--- a/doc/lispref/keymaps.texi
+++ b/doc/lispref/keymaps.texi
@@ -2901,7 +2901,7 @@ Documentation}).
@item :key-sequence @var{keys}
@var{keys} is a hint for speeding up Emacs's first display of the
-menu. It should be nil if you know that the menu item has no keyboard
+menu. It should be @code{nil} if you know that the menu item has no keyboard
equivalent; otherwise it should be a string or vector specifying a
keyboard equivalent for the menu item.
@@ -2929,7 +2929,7 @@ anything else (meaning an ordinary menu item).
@item :selected @var{selected}
@var{selected} is an expression; the checkbox or radio button is
-selected whenever the expression's value is non-nil.
+selected whenever the expression's value is non-@code{nil}.
@item :help @var{help}
@var{help} is a string describing the menu item.
diff --git a/doc/lispref/modes.texi b/doc/lispref/modes.texi
index c30547e65ab..e23e2685a7c 100644
--- a/doc/lispref/modes.texi
+++ b/doc/lispref/modes.texi
@@ -702,7 +702,7 @@ mode and minor modes. It uses the @code{documentation} function to
retrieve the documentation strings of the major and minor mode
commands (@pxref{Accessing Documentation}).
-If called from Lisp with a non-nil @var{buffer} argument, this
+If called from Lisp with a non-@code{nil} @var{buffer} argument, this
function displays the documentation for that buffer's major and minor
modes, rather than those of the current buffer.
@end deffn
@@ -3804,8 +3804,8 @@ expressions (not separated by any token) rather than an expression.
@end itemize
When @var{arg} is a token, the function is called with point just before
-that token. A return value of nil always means to fallback on the
-default behavior, so the function should return nil for arguments it
+that token. A return value of @code{nil} always means to fallback on the
+default behavior, so the function should return @code{nil} for arguments it
does not expect.
@var{offset} can be:
@@ -3904,7 +3904,7 @@ A few things to note:
@itemize
@item
The first case indicates the basic indentation increment to use.
-If @code{sample-indent-basic} is nil, then SMIE uses the global
+If @code{sample-indent-basic} is @code{nil}, then SMIE uses the global
setting @code{smie-indent-basic}. The major mode could have set
@code{smie-indent-basic} buffer-locally instead, but that
is discouraged.
diff --git a/doc/lispref/numbers.texi b/doc/lispref/numbers.texi
index 5da950e1601..8fcd77c009a 100644
--- a/doc/lispref/numbers.texi
+++ b/doc/lispref/numbers.texi
@@ -400,27 +400,23 @@ returns @code{t} if they are not, and @code{nil} if they are.
@end defun
@defun < number-or-marker &rest number-or-markers
-This function tests whether every argument is strictly less than the
-respective next argument. It returns @code{t} if so, @code{nil}
-otherwise.
+This function tests whether each argument is strictly less than the
+following argument. It returns @code{t} if so, @code{nil} otherwise.
@end defun
@defun <= number-or-marker &rest number-or-markers
-This function tests whether every argument is less than or equal to
-the respective next argument. It returns @code{t} if so, @code{nil}
-otherwise.
+This function tests whether each argument is less than or equal to
+the following argument. It returns @code{t} if so, @code{nil} otherwise.
@end defun
@defun > number-or-marker &rest number-or-markers
-This function tests whether every argument is strictly greater than
-the respective next argument. It returns @code{t} if so, @code{nil}
-otherwise.
+This function tests whether each argument is strictly greater than
+the following argument. It returns @code{t} if so, @code{nil} otherwise.
@end defun
@defun >= number-or-marker &rest number-or-markers
-This function tests whether every argument is greater than or equal to
-the respective next argument. It returns @code{t} if so, @code{nil}
-otherwise.
+This function tests whether each argument is greater than or equal to
+the following argument. It returns @code{t} if so, @code{nil} otherwise.
@end defun
@defun max number-or-marker &rest numbers-or-markers
diff --git a/doc/lispref/os.texi b/doc/lispref/os.texi
index 04c7adda24a..5cfbb9ff2ef 100644
--- a/doc/lispref/os.texi
+++ b/doc/lispref/os.texi
@@ -194,11 +194,16 @@ It processes any command-line options that were not handled earlier.
It now exits if the option @code{--batch} was specified.
@item
-If @code{initial-buffer-choice} is a string, it visits the file with
-that name. If it is a function, it calls the function and selects the
-buffer returned by the function. It it is @code{t}, it selects the
-@file{*scratch*} buffer. If the @file{*scratch*} buffer exists and is
-empty, it inserts @code{initial-scratch-message} into that buffer.
+If @code{initial-buffer-choice} is a string, it visits the file (or
+directory) with that name. If it is a function, it calls the function
+with no arguments and selects the buffer that it returns.
+@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 it is @code{t}, it selects the @file{*scratch*} buffer.
+@end ignore
+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
@c called from two places. If displaying a startup screen, they are
@@ -753,7 +758,7 @@ Here is an example of how you could use these hooks:
(add-hook 'suspend-resume-hook (lambda () (message "Resumed!")
(sit-for 2)))
@end smallexample
-@c The sit-for prevents the ``nil'' that suspend-emacs returns
+@c The sit-for prevents the @code{nil} that suspend-emacs returns
@c hiding the message.
Here is what you would see upon evaluating @code{(suspend-emacs "pwd")}:
diff --git a/doc/lispref/sequences.texi b/doc/lispref/sequences.texi
index cafdb7fc53d..8f17862d427 100644
--- a/doc/lispref/sequences.texi
+++ b/doc/lispref/sequences.texi
@@ -862,7 +862,7 @@ argument @var{b} is given, the result of this operation is stored into
@defun bool-vector-subsetp a b
Return @code{t} if every @code{t} value in @var{a} is also t in
-@var{b}, nil otherwise. All arguments should be bool vectors of the
+@var{b}, @code{nil} otherwise. All arguments should be bool vectors of the
same length.
@end defun
diff --git a/doc/lispref/text.texi b/doc/lispref/text.texi
index 4c3286adbfc..6665cc3e673 100644
--- a/doc/lispref/text.texi
+++ b/doc/lispref/text.texi
@@ -806,7 +806,7 @@ non-whitespace character in each line in the region.
If this command acts on the entire buffer (i.e. if called
interactively with the mark inactive, or called from Lisp with
-@var{end} nil), it also deletes all trailing lines at the end of the
+@var{end} @code{nil}), it also deletes all trailing lines at the end of the
buffer if the variable @code{delete-trailing-lines} is non-@code{nil}.
@end deffn
@@ -2865,7 +2865,7 @@ adding the face @var{face} to the @code{face} text property.
(@pxref{Special Properties}), such as a face name or an anonymous face
(@pxref{Faces}).
-If any text in the region already has a non-nil @code{face} property,
+If any text in the region already has a non-@code{nil} @code{face} property,
those face(s) are retained. This function sets the @code{face}
property to a list of faces, with @var{face} as the first element (by
default) and the pre-existing faces as the remaining elements. If the