bug-bash
[Top][All Lists]
Advanced

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

[PATCH 06/18] doc/bash.1: fix markup nit


From: G. Branden Robinson
Subject: [PATCH 06/18] doc/bash.1: fix markup nit
Date: Wed, 31 Jan 2024 02:41:52 -0600

Remove trailing whitespace from lines.  They shouldn't matter to
*roff,[1] but "git diff" shows them as distractingly radioactive.

Diff of rendering (Heirloom Doctools, DWB):

-              referred to as the region. When this variable is set to On,
+              referred to as the region.  When this variable is set to On,
               readline allows certain commands to designate the region as
-              active. When the region is active, readline highlights the text
+              active.  When the region is active, readline highlights the text

[1] Today I learned that AT&T troff's end-of-sentence detection is
    actually broken by trailing spaces, as seen above.
---
 doc/bash.1 | 64 +++++++++++++++++++++++++++---------------------------
 1 file changed, 32 insertions(+), 32 deletions(-)

diff --git a/doc/bash.1 b/doc/bash.1
index 058e6a18..f18816fc 100644
--- a/doc/bash.1
+++ b/doc/bash.1
@@ -2418,7 +2418,7 @@ .SS Shell Variables
 .TP
 .B HISTTIMEFORMAT
 If this variable is set and not null, its value is used as a format string
-for 
+for
 .IR strftime (3)
 to print the time stamp associated with each history
 entry displayed by the \fBhistory\fP builtin.
@@ -2678,7 +2678,7 @@ .SS Shell Variables
 .B PS4
 is replicated multiple times, as necessary, to indicate multiple
 levels of indirection.
-The default is 
+The default is
 .Q "+\ " .
 .TP
 .B SHELL
@@ -3403,7 +3403,7 @@ .SS Parameter Expansion
 .IR parameter ,
 then the result of the expansion is the expanded value of
 .I parameter
-with the shortest matching pattern (the 
+with the shortest matching pattern (the
 .Q #
 case) or the longest matching pattern (the
 .Q ##
@@ -3441,7 +3441,7 @@ .SS Parameter Expansion
 .IR parameter ,
 then the result of the expansion is the expanded value of
 .I parameter
-with the shortest matching pattern (the 
+with the shortest matching pattern (the
 .Q %
 case) or the longest matching pattern (the
 .Q %%
@@ -3483,7 +3483,7 @@ .SS Parameter Expansion
 .B Pattern Matching
 below.
 In the first form above, only the first match is replaced.
-If there are two slashes separating \fIparameter\fP and \fIpattern\fP 
+If there are two slashes separating \fIparameter\fP and \fIpattern\fP
 (the second form above), all matches of \fIpattern\fP are
 replaced with \fIstring\fP.
 If \fIpattern\fP is preceded by \fB#\fP (the third form above),
@@ -3703,7 +3703,7 @@ .SS Command Substitution
 word would usually require.
 .PP
 Any side effects of \fIcommand\fP take effect immediately
-in the current execution environment and persist in the current 
+in the current execution environment and persist in the current
 environment after the command completes (e.g., the \fBexit\fP builtin
 will exit the shell).
 .PP
@@ -3854,7 +3854,7 @@ .SS Word Splitting
 .SM
 .B IFS
 is unset, word splitting behaves as if it contained the default value
-of 
+of
 .BR <space><tab><newline> .
 .PP
 Explicit null arguments (\^\f3"\^"\fP or \^\f3\(aq\^\(aq\fP\^) are retained
@@ -3868,7 +3868,7 @@ .SS Word Splitting
 non-null, the null argument is removed.
 That is, the word
 .Q "\-d\(aq\^\(aq"
-becomes 
+becomes
 .Q \-d
 after word splitting and null argument removal.
 .PP
@@ -3921,7 +3921,7 @@ .SS Pathname Expansion
 .Q .\&
 and
 .Q ..\& ,
-the pattern must begin with 
+the pattern must begin with
 .Q .\&
 (for example,
 .Q .?\& ),
@@ -4577,7 +4577,7 @@ .SH ALIASES
 replaces the word with the alias value, and reads that value as if it
 had been read instead of the word.
 The shell doesn't look at any characters following the word before
-attempting alias substitution. 
+attempting alias substitution.
 .PP
 The characters \fB/\fP, \fB$\fP, \fB\`\fP, and \fB=\fP and
 any of the shell \fImetacharacters\fP or quoting characters
@@ -5489,7 +5489,7 @@ .SH SIGNALS
 .B SIGINT
 to all processes in that process group.
 .PP
-When \fBbash\fP is running without job control enabled and receives 
+When \fBbash\fP is running without job control enabled and receives
 .SM
 .B SIGINT
 while waiting for a foreground command, it waits until that foreground
@@ -6159,7 +6159,7 @@ .SS "Readline Variables"
 .PP
 .PD 0
 .TP
-.B active\-region\-start\-color   
+.B active\-region\-start\-color
 A string variable that controls the text color and background when displaying
 the text in the active region (see the description of
 \fBenable\-active\-region\fP below).
@@ -6169,13 +6169,13 @@ .SS "Readline Variables"
 This variable is reset to the default value whenever the terminal type changes.
 The default value is the string that puts the terminal in standout mode,
 as obtained from the terminal's terminfo description.
-A sample value might be 
+A sample value might be
 .Q "\ee[01;33m" .
 .TP
-.B active\-region\-end\-color     
+.B active\-region\-end\-color
 A string variable that
 .Q undoes
-the effects of \fBactive\-region\-start\-color\fP 
+the effects of \fBactive\-region\-start\-color\fP
 and restores
 .Q normal
 terminal display appearance after displaying text in the active region.
@@ -6195,9 +6195,9 @@ .SS "Readline Variables"
 If set to \fBaudible\fP, readline attempts to ring the terminal's bell.
 .TP
 .B bind\-tty\-special\-chars (On)
-If set to \fBOn\fP (the default), readline attempts to bind the control 
-characters that are  
-treated specially by the kernel's terminal driver to their  
+If set to \fBOn\fP (the default), readline attempts to bind the control
+characters that are
+treated specially by the kernel's terminal driver to their
 readline equivalents.
 These override the default readline bindings described here.
 Type
@@ -6277,7 +6277,7 @@ .SS "Readline Variables"
 escape character (in effect, using escape as the \fImeta prefix\fP).
 The default is \fIOn\fP, but readline will set it to \fIOff\fP if the
 locale contains eight-bit characters.
-This variable is dependent on the \fBLC_CTYPE\fP locale category, and 
+This variable is dependent on the \fBLC_CTYPE\fP locale category, and
 may change if the locale is changed.
 .TP
 .B disable\-completion (Off)
@@ -6312,9 +6312,9 @@ .SS "Readline Variables"
 .B enable\-active\-region (On)
 The \fIpoint\fP is the current cursor position, and \fImark\fP refers
 to a saved cursor position.
-The text between the point and mark is referred to as the \fIregion\fP.  
+The text between the point and mark is referred to as the \fIregion\fP.
 When this variable is set to \fIOn\fP, readline allows certain commands
-to designate the region as \fIactive\fP.  
+to designate the region as \fIactive\fP.
 When the region is active, readline highlights the text in the region using
 the value of the \fBactive\-region\-start\-color\fP, which defaults to the
 string that enables
@@ -6438,7 +6438,7 @@ .SS "Readline Variables"
 sequence.
 The default is \fIOff\fP, but readline will set it to \fIOn\fP if the
 locale contains eight-bit characters.
-This variable is dependent on the \fBLC_CTYPE\fP locale category, and 
+This variable is dependent on the \fBLC_CTYPE\fP locale category, and
 may change if the locale is changed.
 .TP
 .B page\-completions (On)
@@ -6455,7 +6455,7 @@ .SS "Readline Variables"
 history lines may be modified and retain individual undo lists across
 calls to \fBreadline\fP.
 .TP
-.B search\-ignore\-case (Off)       
+.B search\-ignore\-case (Off)
 If set to \fBOn\fP, readline performs incremental and non-incremental
 history list searches in a case\-insensitive fashion.
 .TP
@@ -8139,7 +8139,7 @@ .SH "SHELL BUILTIN COMMANDS"
 .B READLINE_MARK
 variables to the current location of the insertion point and the saved
 insertion point (the mark), respectively.
-The shell assigns any numeric argument the user supplied to the     
+The shell assigns any numeric argument the user supplied to the
 .SM
 .B READLINE_ARGUMENT
 variable.
@@ -8687,7 +8687,7 @@ .SH "SHELL BUILTIN COMMANDS"
 The
 .B \-I
 option causes local variables to inherit the attributes
-(except the \fInameref\fP attribute) 
+(except the \fInameref\fP attribute)
 and value of any existing variable with the same
 \fIname\fP at a surrounding scope.
 If there is no existing variable, the local variable is initially unset.
@@ -10629,7 +10629,7 @@ .SH "SHELL BUILTIN COMMANDS"
 and while executing builtins that perform array dereferencing.
 .TP 8
 .B assoc_expand_once
-Deprecated; a synonym for \fBarray_expand_once\fP. 
+Deprecated; a synonym for \fBarray_expand_once\fP.
 .TP 8
 .B autocd
 If set, a command name that is the name of a directory is executed as if
@@ -11129,7 +11129,7 @@ .SH "SHELL BUILTIN COMMANDS"
 the evaluation of the conditional expression
 .IR expr .
 Each operator and operand must be a separate argument.
-Expressions are composed of the primaries described 
+Expressions are composed of the primaries described
 .ie \n(zZ=1 in \fIbash\fP(1)
 .el above
 under
@@ -11228,7 +11228,7 @@ .SH "SHELL BUILTIN COMMANDS"
 using the rules listed above.
 .PD
 .PP
-If the shell is not in \fIposix mode\fP, 
+If the shell is not in \fIposix mode\fP,
 when used with \fBtest\fP or \fB[\fP, the \fB<\fP and \fB>\fP operators
 sort lexicographically using ASCII ordering.
 When the shell is in \fIposix mode\fP, these operators sort using the
@@ -11317,7 +11317,7 @@ .SH "SHELL BUILTIN COMMANDS"
 .I action
 is executed before every \fIsimple command\fP, \fIfor\fP command,
 \fIcase\fP command, \fIselect\fP command, (( arithmetic command,
-[[ conditional command, 
+[[ conditional command,
 arithmetic \fIfor\fP command, and before the first command executes
 in a shell function (see
 .SM
@@ -11450,7 +11450,7 @@ .SH "SHELL BUILTIN COMMANDS"
 can be supplied to restrict the output to executable files.
 \fBtype\fP does not consult the table of hashed commands
 when using
-.B \-a 
+.B \-a
 with
 .BR \-p ,
 and only performs a
@@ -11756,7 +11756,7 @@ .SH "SHELL COMPATIBILITY MODE"
 This section does not mention behavior that is standard for a particular
 version (e.g., setting \fBcompat32\fP means that quoting the rhs of the regexp
 matching operator quotes special regexp characters in the word, which is
-default behavior in bash-3.2 and subsequent versions). 
+default behavior in bash-3.2 and subsequent versions).
 .PP
 If a user enables, say, \fBcompat32\fP, it may affect the behavior of other
 compatibility levels up to and including the current compatibility level.
@@ -11787,7 +11787,7 @@ .SH "SHELL COMPATIBILITY MODE"
 .PP
 Bash-5.0 was the final version for which there will be an individual shopt
 option for the previous version. Users should control the compatibility
-level with 
+level with
 .SM
 .BR BASH_COMPAT .
 .PP
-- 
2.30.2

Attachment: signature.asc
Description: PGP signature


reply via email to

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