bug-bash
[Top][All Lists]
Advanced

[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]

[PATCH] Fix some documentation errors


From: Lawrence Velázquez
Subject: [PATCH] Fix some documentation errors
Date: Sat, 28 Dec 2024 23:46:13 -0500

Also replace "behaviour" with "behavior", which the project prefers.

This applies on top of commit bb56d620e075e3c96ae84b52de6b74683d9ab320,
the current tip of the devel branch.
---
 CHANGES                      | 14 +++++++-------
 CHANGES-5.3                  | 14 +++++++-------
 NEWS                         |  6 +++---
 NEWS-5.3                     |  6 +++---
 doc/bash.1                   | 16 ++++++++--------
 doc/bashref.texi             | 10 +++++-----
 lib/readline/doc/history.3   |  2 +-
 lib/readline/doc/hstech.texi |  2 +-
 lib/readline/doc/rltech.texi |  8 ++++----
 lib/readline/doc/rluser.texi |  8 ++++----
 10 files changed, 43 insertions(+), 43 deletions(-)

diff --git a/CHANGES b/CHANGES
index 4b826d0a..8ad19fdd 100644
--- a/CHANGES
+++ b/CHANGES
@@ -152,7 +152,7 @@ l. There is a new `bash_source_fullpath' shopt option, 
which makes bash put
    at configure time.
 
 m. Posix mode now forces job notifications to occur when the new edition of
-   POSIX specifes (since it now specifies them).
+   POSIX specifies (since it now specifies them).
 
 n. Interactive shells don't print job notifications while sourcing scripts.
 
@@ -325,7 +325,7 @@ vv. Fixed a bug that caused unset not to remove a function 
named a[b] if
 ww. Posix mode doesn't perform function lookup for function names containing
     a slash.
 
-xx. <( and >( can now be used in funtion names.
+xx. <( and >( can now be used in function names.
 
 yy. Fixed a bug that caused tilde expansion not to be performed on some
     array subscripts.
@@ -451,7 +451,7 @@ oooo. If the cd builtin uses $OLDPWD, allow it to use 
$CDPATH if the user has
       set it to something that's not a full pathname.
 
 pppp. The test builtin only supports the optional argument to -t if parsing
-      an expression with more than four aguments and not in posix mode.
+      an expression with more than four arguments and not in posix mode.
 
 qqqq. Changes to filename quoting and rewriting to deal with NFC and NFD
       Unicode forms (primarily for macOS).
@@ -618,7 +618,7 @@ a. Fixed a bug in clearing the visible line structure 
before redisplay.
 b. Fix a bug where setlocale(3) returning NULL caused a crash.
 
 c. Fixed signal checking in callback mode to handle signals that arrive before
-   readline restore's the application's signal handlers.
+   readline restores the application's signal handlers.
 
 d. Fixed a bug with word completion where the directory name needs to be
    dequoted and tilde-expanded.
@@ -675,7 +675,7 @@ u. Call the filename rewrite hook on the word being 
completed before comparing
    strings.
 
 v. Fix infinite recursion that can happen if someone binds a key that doesn't
-   have a different upper and lower case represenation to do-lowercase-version.
+   have a different upper and lower case representation to 
do-lowercase-version.
 
 w. Check for non-ANSI (dumb) terminals a little more thoroughly.
 
@@ -718,12 +718,12 @@ j. `trap' has a new -P option that prints the trap action 
associated with each
    signal argument.
 
 k. The `command' builtin preceding a declaration builtin (e.g., `declare')
-   preserves the special asisgnment statement parsing for the declation
+   preserves the special assignment statement parsing for the declaration
    builtin. This is a new POSIX requirement.
 
 l. `printf' uses the `alternate form' for %q and %Q to force single quoting.
 
-m. `printf' now interprets %ls (%S) and %lc (%C)nas referring to wide strings
+m. `printf' now interprets %ls (%S) and %lc (%C) as referring to wide strings
    and characters, respectively, when in a multibyte locale.
 
 n. The shell can be compiled with a different default value for the
diff --git a/CHANGES-5.3 b/CHANGES-5.3
index 286c9ff9..4c499858 100644
--- a/CHANGES-5.3
+++ b/CHANGES-5.3
@@ -152,7 +152,7 @@ l. There is a new `bash_source_fullpath' shopt option, 
which makes bash put
    at configure time.
 
 m. Posix mode now forces job notifications to occur when the new edition of
-   POSIX specifes (since it now specifies them).
+   POSIX specifies (since it now specifies them).
 
 n. Interactive shells don't print job notifications while sourcing scripts.
 
@@ -325,7 +325,7 @@ vv. Fixed a bug that caused unset not to remove a function 
named a[b] if
 ww. Posix mode doesn't perform function lookup for function names containing
     a slash.
 
-xx. <( and >( can now be used in funtion names.
+xx. <( and >( can now be used in function names.
 
 yy. Fixed a bug that caused tilde expansion not to be performed on some
     array subscripts.
@@ -451,7 +451,7 @@ oooo. If the cd builtin uses $OLDPWD, allow it to use 
$CDPATH if the user has
       set it to something that's not a full pathname.
 
 pppp. The test builtin only supports the optional argument to -t if parsing
-      an expression with more than four aguments and not in posix mode.
+      an expression with more than four arguments and not in posix mode.
 
 qqqq. Changes to filename quoting and rewriting to deal with NFC and NFD
       Unicode forms (primarily for macOS).
@@ -618,7 +618,7 @@ a. Fixed a bug in clearing the visible line structure 
before redisplay.
 b. Fix a bug where setlocale(3) returning NULL caused a crash.
 
 c. Fixed signal checking in callback mode to handle signals that arrive before
-   readline restore's the application's signal handlers.
+   readline restores the application's signal handlers.
 
 d. Fixed a bug with word completion where the directory name needs to be
    dequoted and tilde-expanded.
@@ -675,7 +675,7 @@ u. Call the filename rewrite hook on the word being 
completed before comparing
    strings.
 
 v. Fix infinite recursion that can happen if someone binds a key that doesn't
-   have a different upper and lower case represenation to do-lowercase-version.
+   have a different upper and lower case representation to 
do-lowercase-version.
 
 w. Check for non-ANSI (dumb) terminals a little more thoroughly.
 
@@ -718,12 +718,12 @@ j. `trap' has a new -P option that prints the trap action 
associated with each
    signal argument.
 
 k. The `command' builtin preceding a declaration builtin (e.g., `declare')
-   preserves the special asisgnment statement parsing for the declation
+   preserves the special assignment statement parsing for the declaration
    builtin. This is a new POSIX requirement.
 
 l. `printf' uses the `alternate form' for %q and %Q to force single quoting.
 
-m. `printf' now interprets %ls (%S) and %lc (%C)nas referring to wide strings
+m. `printf' now interprets %ls (%S) and %lc (%C) as referring to wide strings
    and characters, respectively, when in a multibyte locale.
 
 n. The shell can be compiled with a different default value for the
diff --git a/NEWS b/NEWS
index 3bd189d7..a2eec817 100644
--- a/NEWS
+++ b/NEWS
@@ -29,12 +29,12 @@ j. `trap' has a new -P option that prints the trap action 
associated with each
    signal argument.
 
 k. The `command' builtin preceding a declaration builtin (e.g., `declare')
-   preserves the special asisgnment statement parsing for the declation
+   preserves the special assignment statement parsing for the declaration
    builtin. This is a new POSIX requirement.
 
 l. `printf' uses the `alternate form' for %q and %Q to force single quoting.
 
-m. `printf' now interprets %ls (%S) and %lc (%C)nas referring to wide strings
+m. `printf' now interprets %ls (%S) and %lc (%C) as referring to wide strings
    and characters, respectively, when in a multibyte locale.
 
 n. The shell can be compiled with a different default value for the
@@ -129,7 +129,7 @@ pp. There is a new `bash_source_fullpath' shopt option, 
which makes bash put
     at configure time.
 
 qq. Posix mode now forces job notifications to occur when the new edition of
-    POSIX specifes (since it now specifies them).
+    POSIX specifies (since it now specifies them).
 
 rr. Interactive shells don't print job notifications while sourcing scripts.
 
diff --git a/NEWS-5.3 b/NEWS-5.3
index 1d2f647d..db8c7319 100644
--- a/NEWS-5.3
+++ b/NEWS-5.3
@@ -29,12 +29,12 @@ j. `trap' has a new -P option that prints the trap action 
associated with each
    signal argument.
 
 k. The `command' builtin preceding a declaration builtin (e.g., `declare')
-   preserves the special asisgnment statement parsing for the declation
+   preserves the special assignment statement parsing for the declaration
    builtin. This is a new POSIX requirement.
 
 l. `printf' uses the `alternate form' for %q and %Q to force single quoting.
 
-m. `printf' now interprets %ls (%S) and %lc (%C)nas referring to wide strings
+m. `printf' now interprets %ls (%S) and %lc (%C) as referring to wide strings
    and characters, respectively, when in a multibyte locale.
 
 n. The shell can be compiled with a different default value for the
@@ -129,7 +129,7 @@ pp. There is a new `bash_source_fullpath' shopt option, 
which makes bash put
     at configure time.
 
 qq. Posix mode now forces job notifications to occur when the new edition of
-    POSIX specifes (since it now specifies them).
+    POSIX specifies (since it now specifies them).
 
 rr. Interactive shells don't print job notifications while sourcing scripts.
 
diff --git a/doc/bash.1 b/doc/bash.1
index a5a8e445..5f6ef6b7 100644
--- a/doc/bash.1
+++ b/doc/bash.1
@@ -973,7 +973,7 @@ Using \fB;&\fP in place of \fB;;\fP causes execution to 
continue with
 the \fIlist\fP associated with the next pattern list.
 Using \fB;;&\fP in place of \fB;;\fP causes the shell to test the next
 pattern list in the statement, if any, and execute any associated \fIlist\fP
-if the match succeeds.
+if the match succeeds,
 continuing the case statement execution as if the pattern list had not matched.
 The exit status is zero if no pattern matches.
 .IP
@@ -1768,7 +1768,7 @@ have no effect, and it may not be unset.
 .B BASH_LOADABLES_PATH
 A colon-separated list of directories in which the
 .B enable
-command.
+command
 looks for
 dynamically loadable builtins.
 .TP
@@ -2649,7 +2649,7 @@ to obtain the list of possible hostname completions.
 When
 .SM
 .B HOSTFILE
-is unset, \fBbash\fP clears the the hostname list.
+is unset, \fBbash\fP clears the hostname list.
 .TP
 .B IFS
 The
@@ -6941,7 +6941,7 @@ If set to zero, any existing history entries are deleted 
and no new entries
 are saved.
 If set to a value less than zero, the number of history entries is not
 limited.
-By default, \fBbash\fP sets the the maximum number of history entries to
+By default, \fBbash\fP sets the maximum number of history entries to
 the value of the \fBHISTSIZE\fP shell variable.
 Setting \fIhistory\-size\fP to a non-numeric value will set
 the maximum number of history entries to 500.
@@ -8319,7 +8319,7 @@ and
 .BR HISTCONTROL .
 .PP
 On startup, \fBbash\fP initializes the history list
-by reading history entries from the
+by reading history entries from
 the file named by the
 .SM
 .B HISTFILE
@@ -9705,7 +9705,7 @@ subsequent assignments.
 .PP
 The return value is 0 unless an invalid option is encountered,
 an attempt is made to define a function using
-.Q "\-f foo=bar" .
+.Q "\-f foo=bar" ,
 an attempt is made to assign a value to a readonly variable,
 an attempt is made to assign a value to an array variable without
 using the compound assignment syntax (see
@@ -9888,7 +9888,7 @@ If \fB\-n\fP is supplied, each \fIname\fP is disabled; 
otherwise,
 \fIname\fPs are enabled.
 For example, to use the
 .B test
-binary found usin g
+binary found using
 .SM
 .B PATH
 instead of the shell builtin version, run
@@ -13239,7 +13239,7 @@ The hardware and operating system
 .TP
 The compiler used to compile
 .TP
-A description of the bug behaviour
+A description of the bug behavior
 .TP
 A short script or \c
 .Q recipe " \c"
diff --git a/doc/bashref.texi b/doc/bashref.texi
index dc7e36c0..639c5eac 100644
--- a/doc/bashref.texi
+++ b/doc/bashref.texi
@@ -2834,7 +2834,7 @@ word splitting and filename expansion on the results.
 @cindex expansion, arithmetic
 @cindex arithmetic expansion
 
-Arithmetic expansion evalutes an arithmetic expression
+Arithmetic expansion evaluates an arithmetic expression
 and substitutes the result.
 The format for arithmetic expansion is:
 
@@ -3326,7 +3326,7 @@ whose name results from the expansion of @var{word} 
exists and is
 a regular file.
 If the redirection operator is @samp{>|}, or the redirection operator is
 @samp{>} and the @code{noclobber} option is not enabled,
-Bash attemps the redirection
+Bash attempts the redirection
 even if the file named by @var{word} exists.
 
 @subsection Appending Redirected Output
@@ -4639,7 +4639,7 @@ The @var{action} is a command that is read and executed 
when the
 shell receives any of the signals @var{sigspec}.
 If @var{action} is absent (and
 there is a single @var{sigspec}) or
-equal to @samp{-}, each specified @var{sigspec}'ss disposition is reset
+equal to @samp{-}, each specified @var{sigspec}'s disposition is reset
 to the value it had when the shell was started.
 If @var{action} is the null string, then the signal specified by
 each @var{sigspec} is ignored by the shell and commands it invokes.
@@ -4903,7 +4903,7 @@ If the separator is a colon, any enclosing double quotes 
are optional, and
 Readline does not expand the command string before saving it.
 Since the entire key binding expression must be a single argument, it
 should be enclosed in single quotes.
-When @var{shell-command} is executed, the shell sets thex
+When @var{shell-command} is executed, the shell sets the
 @code{READLINE_LINE} variable to the contents of the Readline line
 buffer
 and the
@@ -10696,7 +10696,7 @@ The hardware and operating system.
 @item
 The compiler used to compile Bash.
 @item
-A description of the bug behaviour.
+A description of the bug behavior.
 @item
 A short script or `recipe' which exercises the bug and may be used
 to reproduce it.
diff --git a/lib/readline/doc/history.3 b/lib/readline/doc/history.3
index 514d6f8c..59e57287 100644
--- a/lib/readline/doc/history.3
+++ b/lib/readline/doc/history.3
@@ -495,7 +495,7 @@ The history list will contain only \fImax\fP entries at a 
time.
 .F1 int unstifle_history "void"
 Stop stifling the history.  This returns the previously-set
 maximum number of history entries (as set by \fBstifle_history()\fP).
-history was stifled.  The value is positive if the history was
+The value is positive if the history was
 stifled, negative if it wasn't.
 .PP
 .F1 int history_is_stifled "void"
diff --git a/lib/readline/doc/hstech.texi b/lib/readline/doc/hstech.texi
index c1c15b0a..b9ddd697 100644
--- a/lib/readline/doc/hstech.texi
+++ b/lib/readline/doc/hstech.texi
@@ -36,7 +36,7 @@ For information on the interactive use of @sc{gnu} History,
 * Introduction to History::    What is the GNU History library for?
 * History Storage::            How information is stored.
 * History Functions::          Functions that you can use.
-* History Variables::          Variables that control behaviour.
+* History Variables::          Variables that control behavior.
 * History Programming Example::        Example of using the GNU History 
Library.
 @end menu
 
diff --git a/lib/readline/doc/rltech.texi b/lib/readline/doc/rltech.texi
index dadca6a6..a1c4211c 100644
--- a/lib/readline/doc/rltech.texi
+++ b/lib/readline/doc/rltech.texi
@@ -58,7 +58,7 @@ in your own programs, this section is for you.
 
 Many programs provide a command line interface, such as @code{mail},
 @code{ftp}, and @code{sh}.
-For such programs, the default behaviour of Readline is sufficient.
+For such programs, the default behavior of Readline is sufficient.
 This section describes how to use Readline in
 the simplest way possible, perhaps to replace calls in your code to
 @code{fgets()}.
@@ -149,7 +149,7 @@ rl_gets ()
 @}
 @end example
 
-This function gives the user the default behaviour of @key{TAB}
+This function gives the user the default behavior of @key{TAB}
 completion: filename completion.
 If you do not want Readline to
 complete filenames, you can change the binding of the @key{TAB} key
@@ -768,7 +768,7 @@ The caller should free @var{keymap}.
 
 @deftypefun void rl_free_keymap (Keymap keymap)
 Free all storage associated with @var{keymap}.
-This calls @code{rl_discard_keymap} to free subordindate
+This calls @code{rl_discard_keymap} to free subordinate
 keymaps and macros.
 @end deftypefun
 
@@ -1168,7 +1168,7 @@ displaying a new message in the message area with 
@code{rl_message()}.
 @deftypefun void rl_restore_prompt (void)
 Restore the local Readline prompt display state saved by the most
 recent call to @code{rl_save_prompt}.
-if you called @code{rl_save_prompt} to save the prompt before a call
+If you called @code{rl_save_prompt} to save the prompt before a call
 to @code{rl_message}, you should call this function before the
 corresponding call to @code{rl_clear_message}.
 @end deftypefun
diff --git a/lib/readline/doc/rluser.texi b/lib/readline/doc/rluser.texi
index 757661ba..bb331b63 100644
--- a/lib/readline/doc/rluser.texi
+++ b/lib/readline/doc/rluser.texi
@@ -703,7 +703,7 @@ are saved.
 If set to a value less than zero, the number of history entries is not
 limited.
 @ifset BashFeatures
-By default, Bash sets the the maximum number of history entries to
+By default, Bash sets the maximum number of history entries to
 the value of the @code{HISTSIZE} shell variable.
 @end ifset
 @ifclear BashFeatures
@@ -1055,7 +1055,7 @@ The eight-bit character whose value is the hexadecimal 
value @var{HH}
 When entering the text of a macro, single or double quotes must
 be used to indicate a macro definition.
 Unquoted text is assumed to be a function name.
-Tthe backslash escapes described above are expanded
+The backslash escapes described above are expanded
 in the macro body.
 Backslash will quote any other character in the macro text,
 including @samp{"} and @samp{'}.
@@ -1188,7 +1188,7 @@ binding, variable assignment, and conditional syntax.
 
 @example
 @page
-# This file controls the behaviour of line input editing for
+# This file controls the behavior of line input editing for
 # programs that use the GNU Readline library.  Existing
 # programs include FTP, Bash, and GDB.
 #
@@ -2057,7 +2057,7 @@ Expand the line by performing shell word expansions.
 This performs alias and history expansion,
 $'@var{string}' and $"@var{string}" quoting,
 tilde expansion, parameter and variable expansion, arithmetic expansion,
-command and proces substitution,
+command and process substitution,
 word splitting, and quote removal.  
 An explicit argument suppresses command and process substitution.
 
-- 
2.47.1




reply via email to

[Prev in Thread] Current Thread [Next in Thread]