master: doc: tweaks

The branch "master" has been updated in SBCL:
       via  02bd195c1ab97edbb6b59593c92bb8e05e3e4a5e (commit)
      from  39ea7adbefe5d6d4b0cad3cfdf0b3dca349506b1 (commit)

- Log -----------------------------------------------------------------
commit 02bd195c1ab97edbb6b59593c92bb8e05e3e4a5e
Author: Gabor Melis <[email protected]>
Date:   Fri May 29 09:40:47 2026 +0200

    doc: tweaks
---
 contrib/sb-posix/sb-posix.texinfo | 23 ---------------
 doc/manual/docstrings.lisp        |  2 +-
 doc/manual/start-stop.texinfo     | 59 ++++++++++++++++++++-------------------
 3 files changed, 31 insertions(+), 53 deletions(-)

diff --git a/contrib/sb-posix/sb-posix.texinfo b/contrib/sb-posix/sb-posix.texinfo
index 2f851eb5b..2b6dfd32a 100644
--- a/contrib/sb-posix/sb-posix.texinfo
+++ b/contrib/sb-posix/sb-posix.texinfo
@@ -179,26 +179,12 @@ implementation-dependent members of all structure types on your system
 objects corresponding to supported POSIX structures, and the supported
 slots for those structures.
 
-@itemize
-
-@item flock
 @include class-sb-posix-flock.texinfo
-
-@item passwd
 @include class-sb-posix-passwd.texinfo
-
-@item passwd
 @include class-sb-posix-group.texinfo
-
-@item stat
 @include class-sb-posix-stat.texinfo
-
-@item termios
 @include class-sb-posix-termios.texinfo
-
-@item timeval
 @include class-sb-posix-timeval.texinfo
-@end itemize
 
 @node Functions with idiosyncratic bindings
 @subsection Functions with idiosyncratic bindings
@@ -206,14 +192,9 @@ slots for those structures.
 A few functions in sb-posix don't correspond directly to their C
 counterparts.
 
-@itemize
-@item getcwd
 @include fun-sb-posix-getcwd.texinfo
-@item readlink
 @include fun-sb-posix-readlink.texinfo
-@item syslog
 @include fun-sb-posix-syslog.texinfo
-@end itemize
 
 
 @node Extensions to POSIX
@@ -235,9 +216,5 @@ database while preventing the keyed accesses (@code{SB-POSIX:GETPWNAM},
 @code{SB-POSIX:GETGRGID})
 from running until iteration completes.
 
-@itemize
-@item do-passwds
 @include macro-sb-posix-do-passwds.texinfo
-@item do-groups
 @include macro-sb-posix-do-groups.texinfo
-@end itemize
diff --git a/doc/manual/docstrings.lisp b/doc/manual/docstrings.lisp
index 1d2a5e56a..6e5c4d1c6 100644
--- a/doc/manual/docstrings.lisp
+++ b/doc/manual/docstrings.lisp
@@ -530,7 +530,7 @@ variables if the symbol in question is contained in symbols
 
 (defun lisp-section-p (line line-number lines)
   "Returns T if the given LINE looks like start of lisp code --
-ie. if it starts with whitespace followed by a paren or
+i.e. if it starts with whitespace followed by a paren or
 semicolon, and the previous line is empty"
   (let ((offset (indentation line)))
     (and offset
diff --git a/doc/manual/start-stop.texinfo b/doc/manual/start-stop.texinfo
index 428cdd32f..fdae41717 100644
--- a/doc/manual/start-stop.texinfo
+++ b/doc/manual/start-stop.texinfo
@@ -24,10 +24,10 @@
 @comment  node-name,  next,  previous,  up
 @subsection From Shell to Lisp
 
-To run SBCL type @command{sbcl} at the command line.
+To run SBCL, type @command{sbcl} at the command line.
 
-You should end up in the toplevel @dfn{REPL} (read, eval, print
--loop), where you can interact with SBCL by typing expressions.
+You should end up in the toplevel @dfn{REPL} (read-eval-print loop),
+where you can interact with SBCL by typing expressions.
 
 @smallexample
 $ sbcl
@@ -39,7 +39,6 @@ It is mostly in the public domain; some portions are provided under
 BSD-style licenses.  See the CREDITS and COPYING files in the
 distribution for more information.
 * (+ 2 2)
-
 4
 * (exit)
 $
@@ -51,8 +50,8 @@ See also @ref{Command Line Options} and @ref{Stopping SBCL}.
 @comment  node-name,  next,  previous,  up
 @subsection Running from Emacs
 
-To run SBCL as an inferior-lisp from Emacs in your @file{.emacs} do
-something like:
+To run SBCL as an @code{inferior-lisp} from Emacs, in your
+@file{.emacs} do something like:
 
 @lisp
 ;;; The SBCL binary and command-line arguments
@@ -70,7 +69,7 @@ Integration}.
 
 Standard Unix tools that are interpreters follow a common command line
 protocol that is necessary to work with ``shebang scripts''. SBCL supports
-this via the @code{--script} command line option.
+this via the @code{--script} command line option @pxref{Command Line Options}.
 
 Example file (@file{hello.lisp}):
 
@@ -79,13 +78,15 @@ Example file (@file{hello.lisp}):
 (write-line "Hello, World!")
 @end lisp
 
-Usage examples:
+Usage from the command line:
 
 @smallexample
 $ ./hello.lisp
 Hello, World!
 @end smallexample
 
+Note that SBCL skips the shebang line when it reads the file:
+
 @smallexample
 $ sbcl --script hello.lisp
 Hello, World!
@@ -175,18 +176,17 @@ command line arguments are passed on to user code.
 
 The full, unambiguous syntax for invoking SBCL at the command line is:
 
-@command{sbcl} @var{runtime-option}* @code{--end-runtime-options} @var{toplevel-option}* @code{--end-toplevel-options} @var{user-options}*
+@command{sbcl} @var{runtime-option}* @code{--end-runtime-options} @var{toplevel-option}* @code{--end-toplevel-options} @var{user-option}*
 
-For convenience, the @code{--end-runtime-options} and
-@code{--end-toplevel-options} elements can be omitted. Omitting these
-elements can be convenient when you are running the program
-interactively, and you can see that no ambiguities are possible with
-the option values you are using. Omitting these elements is probably a
-bad idea for any batch file where any of the options are under user
-control, since it makes it impossible for SBCL to detect erroneous
-command line input, so that erroneous command line arguments will be
-passed on to the user program even if they was intended for the
-runtime system or the Lisp system.
+For convenience, @code{--end-runtime-options} and
+@code{--end-toplevel-options} can be omitted, which can be convenient
+when you are running the program interactively, and you can see that
+no ambiguities are possible with the option values you are using.
+Omitting these elements is probably a bad idea for any batch file
+where any of the options are under user control, since it makes it
+impossible for SBCL to detect erroneous command line input, so that
+erroneous command line arguments will be passed on to the user program
+even if they was intended for the runtime system or the Lisp system.
 
 @menu
 * Runtime Options::
@@ -234,19 +234,20 @@ with LDB.
 @cindex ldb
 There are some dangerous low-level errors (for instance, control stack
 exhausted, memory fault) that (or whose handlers) can corrupt the
-image. By default SBCL prints a warning, then tries to continue and
-handle the error in Lisp, but this will not always work and SBCL may
+image. By default, SBCL prints a warning, then tries to continue and
+handle the error in Lisp, but this will not always work, and SBCL may
 malfunction or even hang. With this option, upon encountering such an
-error SBCL will invoke ldb (if present and enabled) or else exit.
+error, SBCL will exit instead of invoking LDB (if present and
+enabled).
 
 
 @item --script @var{filename}
-As a runtime option this is equivalent to @code{--noinform}
+As a @emph{runtime} option, this is equivalent to @code{--noinform}
 @code{--disable-ldb} @code{--lose-on-corruption}
 @code{--end-runtime-options} @code{--script} @var{filename}. See the
-description of @code{--script} as a toplevel option below. If there
-are no other command line arguments following @code{--script}, the
-filename argument can be omitted.
+description of @code{--script} as a @emph{toplevel} option below. If
+there are no other command line arguments following @code{--script},
+the filename argument can be omitted.
 
 
 @item --merge-core-pages
@@ -271,9 +272,9 @@ Print SBCL's version information, then exit.
 In the future, runtime options may be added to control behaviour such
 as lazy allocation of memory.
 
-Runtime options, including any --end-runtime-options option, are
-stripped out of the command line before the Lisp toplevel logic gets a
-chance to see it.
+Runtime options, including any @code{--end-runtime-options} option,
+are stripped out of the command line before the Lisp toplevel logic
+gets a chance to see it.
 
 @node Toplevel Options
 @comment  node-name,  next,  previous,  up

-----------------------------------------------------------------------


hooks/post-receive
-- 
SBCL