master: doc: fix some typos and readability issues

melisgl via Sbcl-commits <[email protected]> Wed, 01 Jul 2026 13:31:01 +0000
Newsgroups gmane.lisp.steel-bank.cvs
Message-ID <[email protected]>
The branch "master" has been updated in SBCL:
       via  739a65fe111c65247f329285ff3a4c33a6f187e1 (commit)
      from  34dda2dde18230174cb01b05eeb8a7e166837b9d (commit)

- Log -----------------------------------------------------------------
commit 739a65fe111c65247f329285ff3a4c33a6f187e1
Author: Gabor Melis <[email protected]>
Date:   Wed Jul 1 15:06:52 2026 +0200

    doc: fix some typos and readability issues
    
    Thanks to Štěpán Němec.
---
 INSTALL                                  |  8 ++++----
 contrib/sb-aclrepl/repl.lisp             |  2 +-
 contrib/sb-aclrepl/sb-aclrepl.texinfo    |  2 +-
 contrib/sb-manual/doc/beyond-ansi.lisp   |  4 ++--
 contrib/sb-manual/doc/package-locks.lisp | 10 +++++-----
 doc/manual/beyond-ansi.texinfo           | 10 +++++-----
 doc/manual/efficiency.texinfo            |  2 +-
 doc/manual/package-locks.texinfo         | 12 ++++++------
 src/code/filesys.lisp                    |  2 +-
 src/code/target-hash-table.lisp          |  2 +-
 src/code/target-package.lisp             |  4 ++--
 src/compiler/proclaim.lisp               |  2 +-
 12 files changed, 30 insertions(+), 30 deletions(-)

diff --git a/INSTALL b/INSTALL
index 81225f802..572dd9641 100644
--- a/INSTALL
+++ b/INSTALL
@@ -127,7 +127,7 @@ INSTALLING SBCL
   If you don't already have an SBCL binary installed as "sbcl" on your
   system, you'll need to tell make.sh what Lisp to use as the
   cross-compilation host (cf. make.sh for detailed instructions on
-  how to cross compile). For example, to use CMUCL (assuming has
+  how to cross compile). For example, to use CMUCL (assuming it has
   been installed under its default name "lisp") as the
   cross-compilation host:
 
@@ -146,9 +146,9 @@ INSTALLING SBCL
     $ cd ./doc/manual && make
 
   This builds the Info, HTML and PDF documentation from the Texinfo
-  sources. The manual includes documentation string from the build
-  SBCL, but if SBCL itself has not been yet built, but one if found
-  installed documentation strings from the installed version are used.
+  sources. The manual includes documentation strings from the built
+  SBCL. If SBCL itself has not been built yet, but an installed one
+  is found, documentation strings from the installed version are used.
 
   Now you should have the same src/runtime/sbcl and output/sbcl.core
   files that come with the binary distribution, and you can install
diff --git a/contrib/sb-aclrepl/repl.lisp b/contrib/sb-aclrepl/repl.lisp
index 93ad1b5e9..ae7f7c7e9 100644
--- a/contrib/sb-aclrepl/repl.lisp
+++ b/contrib/sb-aclrepl/repl.lisp
@@ -33,7 +33,7 @@
 (defparameter *prompt* #.*default-prompt*
   "The current prompt string or formatter function.")
 (defparameter *use-short-package-name* t
-  "When T, use the shortnest package nickname in a prompt")
+  "When T, use the shortest package nickname in a prompt.")
 (defparameter *dir-stack* nil
   "The top-level directory stack")
 (defparameter *command-char* #\:
diff --git a/contrib/sb-aclrepl/sb-aclrepl.texinfo b/contrib/sb-aclrepl/sb-aclrepl.texinfo
index a3af2c01a..7d7779e0b 100644
--- a/contrib/sb-aclrepl/sb-aclrepl.texinfo
+++ b/contrib/sb-aclrepl/sb-aclrepl.texinfo
@@ -51,7 +51,7 @@ If @code{t}, then exit when the EOF character is entered.
 @anchor{Variable sb-aclrepl *use-short-package-name*}
 @vvindex @sortas{use-short-package-name* sb-aclrepl} *use-short-package-name* [sb-aclrepl]
 @deffn{Variable} sb-aclrepl:*use-short-package-name*
-When @code{t}, use the shortnest package nickname in a prompt
+When @code{t}, use the shortest package nickname in a prompt.
 @end deffn
 @anchor{Variable sb-aclrepl *max-history*}
 @vvindex @sortas{max-history* sb-aclrepl} *max-history* [sb-aclrepl]
diff --git a/contrib/sb-manual/doc/beyond-ansi.lisp b/contrib/sb-manual/doc/beyond-ansi.lisp
index 6c8c3c710..1528144c6 100644
--- a/contrib/sb-manual/doc/beyond-ansi.lisp
+++ b/contrib/sb-manual/doc/beyond-ansi.lisp
@@ -92,8 +92,8 @@
 
   A local nickname is valid only when inside the package for which it
   has been specified. Different packages can use same local nickname
-  for different global names, or different local nickname for same
-  global name.
+  for different global names, or different local nicknames for the
+  same global name.
 
   The symbol :PACKAGE-LOCAL-NICKNAMES in *FEATURES* denotes the
   support for this feature.
diff --git a/contrib/sb-manual/doc/package-locks.lisp b/contrib/sb-manual/doc/package-locks.lisp
index 44127d66a..592524032 100644
--- a/contrib/sb-manual/doc/package-locks.lisp
+++ b/contrib/sb-manual/doc/package-locks.lisp
@@ -42,7 +42,7 @@
 
   Unless explicitly altered by DEFPACKAGE,
   SB-EXT:ADD-IMPLEMENTATION-PACKAGE, or
-  SB-EXT:REMOVE-IMPLEMENTATION-PACKAGE each package is its own
+  SB-EXT:REMOVE-IMPLEMENTATION-PACKAGE, each package is its own
   (only) implementation package.")
 
 (defsection @package-lock-violations (:title "Package Lock Violations")
@@ -55,8 +55,8 @@
   compile-time warning, and a runtime PROGRAM-ERROR when the form that
   violates package locks would be executed.
 
-  A complete listing of operators affect by this is: LET, LET*, FLET,
-  LABELS, MACROLET, and SYMBOL-MACROLET, DECLARE.
+  A complete listing of operators affected by this is: LET, LET*,
+  FLET, LABELS, MACROLET, SYMBOL-MACROLET, DECLARE.
 
   Package locks affecting both lexical bindings and declarations can
   be disabled locally with the SB-EXT:DISABLE-PACKAGE-LOCKS
@@ -76,7 +76,7 @@
              ,@body)))")
 
 (defsection @other-operations (:title "Other Operations")
-  "If an non-lexical operation violates a package lock, a continuable
+  "If a non-lexical operation violates a package lock, a continuable
   error that is of a subtype of SB-EXT:PACKAGE-LOCK-VIOLATION
   (subtype of PACKAGE-ERROR) is signalled when the operation is
   attempted.
@@ -140,7 +140,7 @@
 
   - Adding a new package local nickname to a package.
 
-  - Removing an existing package local nickname to a package.")
+  - Removing an existing package local nickname from a package.")
 
 (defsection @operations-on-symbols (:title "Operations on Symbols")
   "Following actions cause a package lock violation if the home package
diff --git a/doc/manual/beyond-ansi.texinfo b/doc/manual/beyond-ansi.texinfo
index 8f2d8466f..15e3563e3 100644
--- a/doc/manual/beyond-ansi.texinfo
+++ b/doc/manual/beyond-ansi.texinfo
@@ -122,8 +122,8 @@ with normal nicknames.
 
 A local nickname is valid only when inside the package for which it
 has been specified. Different packages can use same local nickname
-for different global names, or different local nickname for same
-global name.
+for different global names, or different local nicknames for the
+same global name.
 
 The symbol @code{:package-local-nicknames} in @code{*features*} denotes the
 support for this feature.
@@ -157,7 +157,7 @@ Example:
 Returns an alist of @code{(local-nickname . actual-package)} describing the
 nicknames local to the designated package.
 
-When in the designated package, calls to @code{find-package} with the any of the
+When in the designated package, calls to @code{find-package} with any of the
 local-nicknames will return the corresponding actual-package instead. This
 also affects all implied calls to @code{find-package}, including those performed by
 the reader.
@@ -2120,7 +2120,7 @@ Create and return a new hash table. The keywords are as follows:
 @itemize
 @item @code{:test}
 
-Determines how keys are compared. Must a designator for one of
+Determines how keys are compared. Must be a designator for one of
 the standard hash table tests, or a hash table test defined
 using @code{sb-ext:define-hash-table-test}. Additionally, when an
 explicit @code{hash-function} is provided (see below), any two argument
@@ -2647,7 +2647,7 @@ Both
 @end example
 
 delete the @code{"foo"} subdirectory of @code{"/tmp"}, or signal an error if
-it does not exist or if is a file or a symbolic link.
+it does not exist or if it is a file or a symbolic link.
 @end deffn
 @anchor{Function sb-ext get-time-of-day}
 @ffindex @sortas{get-time-of-day sb-ext} get-time-of-day [sb-ext]
diff --git a/doc/manual/efficiency.texinfo b/doc/manual/efficiency.texinfo
index dd6543167..864ec9631 100644
--- a/doc/manual/efficiency.texinfo
+++ b/doc/manual/efficiency.texinfo
@@ -381,7 +381,7 @@ Only valid as a global proclamation.
 
 Specifies that the named symbols cannot be proclaimed or locally
 declared @code{special}. Proclaiming an already special or constant variable
-name as @code{sb-ext:global} signal an error. Allows more efficient value
+name as @code{sb-ext:global} signals an error. Allows more efficient value
 lookup in threaded environments in addition to expressing programmer
 intention.
 @end deffn
diff --git a/doc/manual/package-locks.texinfo b/doc/manual/package-locks.texinfo
index 248e0275f..1c26ccb9b 100644
--- a/doc/manual/package-locks.texinfo
+++ b/doc/manual/package-locks.texinfo
@@ -54,7 +54,7 @@ bound to one of the implementation packages of the locked package.
 
 Unless explicitly altered by @code{defpackage},
 @code{sb-ext:add-implementation-package}, or
-@code{sb-ext:remove-implementation-package} each package is its own
+@code{sb-ext:remove-implementation-package}, each package is its own
 (only) implementation package.
 
 @node package lock violations
@@ -73,8 +73,8 @@ Lexical bindings or declarations that violate package locks cause a
 compile-time warning, and a runtime @code{program-error} when the form that
 violates package locks would be executed.
 
-A complete listing of operators affect by this is: @code{let}, @code{let*}, @code{flet},
-@code{labels}, @code{macrolet}, and @code{symbol-macrolet}, @code{declare}.
+A complete listing of operators affected by this is: @code{let}, @code{let*},
+@code{flet}, @code{labels}, @code{macrolet}, @code{symbol-macrolet}, @code{declare}.
 
 Package locks affecting both lexical bindings and declarations can
 be disabled locally with the @code{sb-ext:disable-package-locks}
@@ -98,7 +98,7 @@ Example:
 @node other operations
 @subsubsection Other Operations
 
-If an non-lexical operation violates a package lock, a continuable
+If a non-lexical operation violates a package lock, a continuable
 error that is of a subtype of @code{sb-ext:package-lock-violation}
 (subtype of @code{package-error}) is signalled when the operation is
 attempted.
@@ -169,7 +169,7 @@ operations signal errors of type @code{sb-ext:package-locked-error}.
 
 @item Adding a new package local nickname to a package.
 
-@item Removing an existing package local nickname to a package.
+@item Removing an existing package local nickname from a package.
 @end itemize
 
 @node operations on symbols
@@ -319,7 +319,7 @@ if @code{package} doesn't designate a valid package.
 @ffindex @sortas{lock-package sb-ext} lock-package [sb-ext]
 @deffn{Function} sb-ext:lock-package package
 Locks @code{package} and returns @code{t}. Has no effect if @code{package} was already
-locked. Signals an error if @code{package} is not a valid package designator
+locked. Signals an error if @code{package} is not a valid package designator.
 @end deffn
 @anchor{Function sb-ext unlock-package}
 @ffindex @sortas{unlock-package sb-ext} unlock-package [sb-ext]
diff --git a/src/code/filesys.lisp b/src/code/filesys.lisp
index 75ba97188..d027bf91b 100644
--- a/src/code/filesys.lisp
+++ b/src/code/filesys.lisp
@@ -622,7 +622,7 @@ Both
     (DELETE-DIRECTORY \"/tmp/foo/\")
 
 delete the `\"foo\"` subdirectory of `\"/tmp\"`, or signal an error if
-it does not exist or if is a file or a symbolic link."
+it does not exist or if it is a file or a symbolic link."
   (declare (type pathname-designator pathspec))
   (labels ((recurse-merged (dir)
              (lambda (sub)
diff --git a/src/code/target-hash-table.lisp b/src/code/target-hash-table.lisp
index 764e83e55..18a60869e 100644
--- a/src/code/target-hash-table.lisp
+++ b/src/code/target-hash-table.lisp
@@ -894,7 +894,7 @@ Examples:
 
   - :TEST
 
-      Determines how keys are compared. Must a designator for one of
+      Determines how keys are compared. Must be a designator for one of
       the standard hash table tests, or a hash table test defined
       using SB-EXT:DEFINE-HASH-TABLE-TEST. Additionally, when an
       explicit HASH-FUNCTION is provided (see below), any two argument
diff --git a/src/code/target-package.lisp b/src/code/target-package.lisp
index 988178556..ad13e7f2d 100644
--- a/src/code/target-package.lisp
+++ b/src/code/target-package.lisp
@@ -618,7 +618,7 @@ if PACKAGE doesn't designate a valid package."
 
 (defun lock-package (package)
   "Locks PACKAGE and returns T. Has no effect if PACKAGE was already
-locked. Signals an error if PACKAGE is not a valid package designator"
+locked. Signals an error if PACKAGE is not a valid package designator."
   (flet ((unoptimize (table)
            (dovector (x (symtbl-cells table))
              ;; By some small miracle this was mostly correct for NIL
@@ -922,7 +922,7 @@ REMOVE-PACKAGE-LOCAL-NICKNAME, and the DEFPACKAGE option :LOCAL-NICKNAMES."
   "Returns an alist of `(LOCAL-NICKNAME . ACTUAL-PACKAGE)` describing the
 nicknames local to the designated package.
 
-When in the designated package, calls to FIND-PACKAGE with the any of the
+When in the designated package, calls to FIND-PACKAGE with any of the
 local-nicknames will return the corresponding actual-package instead. This
 also affects all implied calls to FIND-PACKAGE, including those performed by
 the reader.
diff --git a/src/compiler/proclaim.lisp b/src/compiler/proclaim.lisp
index fc5f2d851..f97c90155 100644
--- a/src/compiler/proclaim.lisp
+++ b/src/compiler/proclaim.lisp
@@ -584,7 +584,7 @@ Only valid as a global proclamation.
 
 Specifies that the named symbols cannot be proclaimed or locally
 declared SPECIAL. Proclaiming an already special or constant variable
-name as SB-EXT:GLOBAL signal an error. Allows more efficient value
+name as SB-EXT:GLOBAL signals an error. Allows more efficient value
 lookup in threaded environments in addition to expressing programmer
 intention.")
 

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


hooks/post-receive
-- 
SBCL

_______________________________________________
Sbcl-commits mailing list
[email protected]
https://lists.sourceforge.net/lists/listinfo/sbcl-commits