[PATCH] bash.1: fix warnings from "mandoc -Tlint"

[Bjarni Ingi Gislason]

  Remove superfluous paragraph macros after and before a subject
heading macro (.SH and .SS).

  Change ".br" before a ".sp" to '.'.

  The output from "nroff" and "groff" is unchanged.

###

  Details:

mandoc: ./doc/bash.1:34:28: UNSUPP: unsupported control character: 0x7
mandoc: ./doc/bash.1:34:35: UNSUPP: unsupported control character: 0x7
mandoc: ./doc/bash.1:36:17: UNSUPP: unsupported control character: 0x7
mandoc: ./doc/bash.1:36:34: UNSUPP: unsupported control character: 0x7
mandoc: ./doc/bash.1:7296:2: ERROR: skipping unknown macro: .zZ
mandoc: ./doc/bash.1:10770:2: ERROR: skipping unknown macro: .zY
mandoc: ./doc/bash.1:484:2: WARNING: skipping paragraph macro: PP empty
mandoc: ./doc/bash.1:455:2: WARNING: skipping paragraph macro: PP after SH
mandoc: ./doc/bash.1:514:2: WARNING: skipping paragraph macro: PP after SS
mandoc: ./doc/bash.1:525:2: WARNING: skipping paragraph macro: PP after SS
mandoc: ./doc/bash.1:660:2: WARNING: skipping paragraph macro: PP empty
mandoc: ./doc/bash.1:660:2: WARNING: skipping paragraph macro: PP empty
mandoc: ./doc/bash.1:602:2: WARNING: skipping paragraph macro: PP after SS
mandoc: ./doc/bash.1:671:2: WARNING: skipping paragraph macro: PP after SS
mandoc: ./doc/bash.1:933:2: WARNING: skipping paragraph macro: PP after SS
mandoc: ./doc/bash.1:980:2: WARNING: skipping paragraph macro: PP after SS
mandoc: ./doc/bash.1:1311:2: WARNING: skipping paragraph macro: PP after SS
mandoc: ./doc/bash.1:1332:2: WARNING: skipping paragraph macro: PP after SS
mandoc: ./doc/bash.1:1441:2: WARNING: skipping paragraph macro: PP after SS
mandoc: ./doc/bash.1:2784:2: WARNING: skipping paragraph macro: PP after SS
mandoc: ./doc/bash.1:2882:2: WARNING: skipping paragraph macro: PP after SS
mandoc: ./doc/bash.1:2945:2: WARNING: skipping paragraph macro: PP after SS
mandoc: ./doc/bash.1:3352:2: WARNING: skipping paragraph macro: PP after SS
mandoc: ./doc/bash.1:3390:2: WARNING: skipping paragraph macro: PP after SS
mandoc: ./doc/bash.1:3416:2: WARNING: skipping paragraph macro: PP after SS
mandoc: ./doc/bash.1:3440:2: WARNING: skipping paragraph macro: PP after SS
mandoc: ./doc/bash.1:3710:2: WARNING: skipping paragraph macro: br before sp
mandoc: ./doc/bash.1:3728:2: WARNING: skipping paragraph macro: br before sp
mandoc: ./doc/bash.1:3739:2: WARNING: skipping paragraph macro: br before sp
mandoc: ./doc/bash.1:3525:2: WARNING: skipping paragraph macro: PP after SS
mandoc: ./doc/bash.1:3785:2: WARNING: skipping paragraph macro: PP after SS
mandoc: ./doc/bash.1:3901:2: WARNING: skipping paragraph macro: PP after SS
mandoc: ./doc/bash.1:3917:2: WARNING: skipping paragraph macro: PP after SS
mandoc: ./doc/bash.1:3970:2: WARNING: skipping paragraph macro: PP empty
mandoc: ./doc/bash.1:3954:2: WARNING: skipping paragraph macro: PP after SS
mandoc: ./doc/bash.1:3972:2: WARNING: skipping paragraph macro: PP after SS
mandoc: ./doc/bash.1:4003:2: WARNING: skipping paragraph macro: PP after SS
mandoc: ./doc/bash.1:4025:2: WARNING: skipping paragraph macro: PP after SS
mandoc: ./doc/bash.1:4092:2: WARNING: skipping paragraph macro: PP after SS
mandoc: ./doc/bash.1:4141:2: WARNING: skipping paragraph macro: PP after SS
mandoc: ./doc/bash.1:4163:2: WARNING: skipping paragraph macro: PP after SS
mandoc: ./doc/bash.1:4920:2: WARNING: skipping paragraph macro: PP after SH
mandoc: ./doc/bash.1:5389:2: WARNING: skipping paragraph macro: PP after SS
mandoc: ./doc/bash.1:5425:2: WARNING: skipping paragraph macro: PP after SS
mandoc: ./doc/bash.1:5479:2: WARNING: skipping paragraph macro: PP after SS
mandoc: ./doc/bash.1:5630:2: WARNING: skipping paragraph macro: PP after SS
mandoc: ./doc/bash.1:5946:2: WARNING: skipping paragraph macro: PP after SS
mandoc: ./doc/bash.1:6044:2: WARNING: skipping paragraph macro: PP after SS
mandoc: ./doc/bash.1:6087:2: WARNING: skipping paragraph macro: PP after SS
mandoc: ./doc/bash.1:6096:2: WARNING: skipping paragraph macro: PP after SS
mandoc: ./doc/bash.1:6149:2: WARNING: skipping paragraph macro: PP after SS
mandoc: ./doc/bash.1:6291:2: WARNING: skipping paragraph macro: PP after SS
mandoc: ./doc/bash.1:6366:2: WARNING: skipping paragraph macro: PP after SS
mandoc: ./doc/bash.1:6437:2: WARNING: skipping paragraph macro: PP after SS
mandoc: ./doc/bash.1:6459:2: WARNING: skipping paragraph macro: PP after SS
mandoc: ./doc/bash.1:6564:2: WARNING: skipping paragraph macro: PP after SS
mandoc: ./doc/bash.1:6583:2: WARNING: skipping paragraph macro: PP after SS
mandoc: ./doc/bash.1:6884:1: WARNING: tab in filled text
mandoc: ./doc/bash.1:6701:2: WARNING: skipping paragraph macro: PP after SS
mandoc: ./doc/bash.1:7113:2: WARNING: skipping paragraph macro: PP after SS
mandoc: ./doc/bash.1:7165:2: WARNING: skipping paragraph macro: PP after SS
mandoc: ./doc/bash.1:7225:2: WARNING: skipping paragraph macro: PP empty
mandoc: ./doc/bash.1:7220:2: WARNING: skipping paragraph macro: PP after SS
mandoc: ./doc/bash.1:7019:2: WARNING: skipping paragraph macro: PP after SH
mandoc: ./doc/bash.1:7297:2: WARNING: skipping paragraph macro: PP after SH
mandoc: ./doc/bash.1:10771:2: WARNING: skipping paragraph macro: PP after SH
mandoc: ./doc/bash.1:10951:2: WARNING: skipping paragraph macro: PP after SH

Signed-off-by: Bjarni Ingi Gislason <bjarniig@rhi.hi.is>
---
 doc/bash.1 | 62 +++---------------------------------------------------
 1 file changed, 3 insertions(+), 59 deletions(-)

diff --git a/doc/bash.1 b/doc/bash.1
index 485f22b2..727a88ca 100644
--- a/doc/bash.1
+++ b/doc/bash.1
@@ -452,7 +452,6 @@ and the effective user id is set to the real user id.
 If the \fB\-p\fP option is supplied at invocation, the startup behavior is
 the same, but the effective user id is not reset.
 .SH DEFINITIONS
-.PP
 The following definitions are used throughout the rest of this
 document.
 .PD 0
@@ -481,7 +480,6 @@ A character that, when unquoted, separates words.  One of 
the following:
 .if t \fB|  &  ;  (  )  <  >  space  tab  newline\fP
 .if n \fB|  & ; ( ) < > space tab newline\fP
 .RE
-.PP
 .TP
 .B control operator
 A \fItoken\fP that performs a control function.  It is one of the following
@@ -511,7 +509,6 @@ command:
 .if t .RE
 .SH "SHELL GRAMMAR"
 .SS Simple Commands
-.PP
 A \fIsimple command\fP is a sequence of optional variable assignments
 followed by \fBblank\fP-separated words and redirections, and
 terminated by a \fIcontrol operator\fP.  The first word
@@ -522,7 +519,6 @@ The return value of a \fIsimple command\fP is its exit 
status, or
 128+\fIn\^\fP if the command is terminated by signal
 .IR n .
 .SS Pipelines
-.PP
 A \fIpipeline\fP is a sequence of one or more commands separated by
 one of the control operators
 .B |
@@ -599,7 +595,6 @@ If the \fBlastpipe\fP option is enabled using the 
\fBshopt\fP builtin
 (see the description of \fBshopt\fP below),
 the last element of a pipeline may be run by the shell process.
 .SS Lists
-.PP
 A \fIlist\fP is a sequence of one or more pipelines separated by one
 of the operators
 .BR ; ,
@@ -657,7 +652,6 @@ An OR list has the form
 .RS
 .PP
 \fIcommand1\fP \fB||\fP \fIcommand2\fP
-.PP
 .RE
 .PP
 .I command2
@@ -668,7 +662,6 @@ The return status of
 AND and OR lists is the exit status of the last command
 executed in the list.
 .SS Compound Commands
-.PP
 A \fIcompound command\fP is one of the following.
 In most cases a \fIlist\fP in a command's description may be separated from
 the rest of the command by one or more newlines, and may be followed by a
@@ -930,7 +923,6 @@ is the exit status
 of the last command executed in \fIlist-2\fP, or zero if
 none was executed.
 .SS Coprocesses
-.PP
 A \fIcoprocess\fP is a shell command preceded by the \fBcoproc\fP reserved
 word.
 A coprocess is executed asynchronously in a subshell, as if the command
@@ -977,7 +969,6 @@ Since the coprocess is created as an asynchronous command,
 the \fBcoproc\fP command always returns success.
 The return status of a coprocess is the exit status of \fIcommand\fP.
 .SS Shell Function Definitions
-.PP
 A shell function is an object that is called like a simple command and
 executes a compound command with a new set of positional parameters.
 Shell functions are declared as follows:
@@ -1308,7 +1299,6 @@ Namerefs can be unset using the \fB\-n\fP option to the 
\fBunset\fP builtin.
 Otherwise, if \fBunset\fP is executed with the name of a nameref variable
 as an argument, the variable referenced by the nameref variable will be unset.
 .SS Positional Parameters
-.PP
 A
 .I positional parameter
 is a parameter denoted by one or more
@@ -1329,7 +1319,6 @@ digit is expanded, it must be enclosed in braces (see
 .B EXPANSION
 below).
 .SS Special Parameters
-.PP
 The shell treats several parameters specially.  These parameters may
 only be referenced; assignment to them is not allowed.
 .PD 0
@@ -1438,7 +1427,6 @@ When checking mail, this parameter holds the name of the 
mail file
 currently being checked.
 .PD
 .SS Shell Variables
-.PP
 The following variables are set by the shell:
 .PP
 .PD 0
@@ -2781,7 +2769,6 @@ as explained above (see
 .SM
 .BR PARAMETERS ).
 .SS Brace Expansion
-.PP
 .I "Brace expansion"
 is a mechanism by which arbitrary strings
 may be generated.  This mechanism is similar to
@@ -2879,7 +2866,6 @@ command (see
 .B SHELL BUILTIN COMMANDS
 below).
 .SS Tilde Expansion
-.PP
 If a word begins with an unquoted tilde character (`\fB~\fP'), all of
 the characters preceding the first unquoted slash (or all characters,
 if there is no unquoted slash) are considered a \fItilde-prefix\fP.
@@ -2942,7 +2928,6 @@ when they appear as arguments to simple commands.
 Bash does not do this, except for the \fIdeclaration\fP commands listed
 above, when in \fIposix mode\fP.
 .SS Parameter Expansion
-.PP
 The `\fB$\fP' character introduces parameter expansion,
 command substitution, or arithmetic expansion.  The parameter name
 or symbol to be expanded may be enclosed in braces, which
@@ -3349,7 +3334,6 @@ The result of the expansion is subject to word splitting 
and pathname
 expansion as described below.
 .RE
 .SS Command Substitution
-.PP
 \fICommand substitution\fP allows the output of a command to replace
 the command name.  There are two forms:
 .RS
@@ -3387,7 +3371,6 @@ escape the inner backquotes with backslashes.
 If the substitution appears within double quotes, word splitting and
 pathname expansion are not performed on the results.
 .SS Arithmetic Expansion
-.PP
 Arithmetic expansion allows the evaluation of an arithmetic expression
 and the substitution of the result.  The format for arithmetic expansion is:
 .RS
@@ -3413,7 +3396,6 @@ is invalid,
 .B bash
 prints a message indicating failure and no substitution occurs.
 .SS Process Substitution
-.PP
 \fIProcess substitution\fP allows a process's input or output to be
 referred to using a filename.
 It takes the form of
@@ -3437,7 +3419,6 @@ simultaneously with parameter and variable expansion,
 command substitution,
 and arithmetic expansion.
 .SS Word Splitting
-.PP
 The shell scans the results of
 parameter expansion,
 command substitution,
@@ -3522,7 +3503,6 @@ null argument removal.
 Note that if no expansion occurs, no splitting
 is performed.
 .SS Pathname Expansion
-.PP
 After word splitting,
 unless the
 .B \-f
@@ -3707,7 +3687,7 @@ A
 .B ]
 may be matched by including it as the first character
 in the set.
-.br
+.
 .if t .sp 0.5
 .if n .sp 1
 Within
@@ -3725,7 +3705,7 @@ following classes defined in the POSIX standard:
 .br
 A character class matches any character belonging to that class.
 The \fBword\fP character class matches letters, digits, and the character _.
-.br
+.
 .if t .sp 0.5
 .if n .sp 1
 Within
@@ -3736,7 +3716,7 @@ an \fIequivalence class\fP can be specified using the 
syntax
 \fB[=\fP\fIc\fP\fB=]\fP, which matches all characters with the
 same collation weight (as defined by the current locale) as
 the character \fIc\fP.
-.br
+.
 .if t .sp 0.5
 .if n .sp 1
 Within
@@ -3782,7 +3762,6 @@ contain multiple matches.
 Using separate matches against shorter strings, or using arrays of
 strings instead of a single long string, may be faster.
 .SS Quote Removal
-.PP
 After the preceding expansions, all unquoted occurrences of the
 characters
 .BR \e ,
@@ -3898,7 +3877,6 @@ Redirections using file descriptors greater than 9 should 
be used with
 care, as they may conflict with file descriptors the shell uses
 internally.
 .SS Redirecting Input
-.PP
 Redirection of input causes the file whose name results from
 the expansion of
 .I word
@@ -3914,7 +3892,6 @@ The general format for redirecting input is:
 [\fIn\fP]\fB<\fP\fIword\fP
 .RE
 .SS Redirecting Output
-.PP
 Redirection of output causes the file whose name results from
 the expansion of
 .I word
@@ -3951,7 +3928,6 @@ option to the
 builtin command is not enabled, the redirection is attempted even
 if the file named by \fIword\fP exists.
 .SS Appending Redirected Output
-.PP
 Redirection of output in this fashion
 causes the file whose name results from
 the expansion of
@@ -3967,9 +3943,7 @@ The general format for appending output is:
 .PP
 [\fIn\fP]\fB>>\fP\fIword\fP
 .RE
-.PP
 .SS Redirecting Standard Output and Standard Error
-.PP
 This construct allows both the
 standard output (file descriptor 1) and
 the standard error output (file descriptor 2)
@@ -4000,7 +3974,6 @@ When using the second form, \fIword\fP may not expand to 
a number or
 (see \fBDuplicating File Descriptors\fP below) for compatibility
 reasons.
 .SS Appending Standard Output and Standard Error
-.PP
 This construct allows both the
 standard output (file descriptor 1) and
 the standard error output (file descriptor 2)
@@ -4022,7 +3995,6 @@ This is semantically equivalent to
 .PP
 (see \fBDuplicating File Descriptors\fP below).
 .SS Here Documents
-.PP
 This type of redirection instructs the shell to read input from the
 current source until a line containing only
 .I delimiter
@@ -4089,7 +4061,6 @@ The result is supplied as a single string, with a newline 
appended,
 to the command on its
 standard input (or file descriptor \fIn\fP if \fIn\fP is specified).
 .SS "Duplicating File Descriptors"
-.PP
 The redirection operator
 .RS
 .PP
@@ -4138,7 +4109,6 @@ As a special case, if \fIn\fP is omitted, and \fIword\fP 
does not
 expand to one or more digits or \fB\-\fP, the standard output and standard
 error are redirected as described previously.
 .SS "Moving File Descriptors"
-.PP
 The redirection operator
 .RS
 .PP
@@ -4160,7 +4130,6 @@ moves the file descriptor \fIdigit\fP to file descriptor
 .IR n ,
 or the standard output (file descriptor 1) if \fIn\fP is not specified.
 .SS "Opening File Descriptors for Reading and Writing"
-.PP
 The redirection operator
 .RS
 .PP
@@ -4917,7 +4886,6 @@ invokes an external command, the variable
 is set to the full filename of the command and passed to that
 command in its environment.
 .SH "EXIT STATUS"
-.PP
 The exit status of an executed command is the value returned by the
 \fIwaitpid\fP system call or equivalent function.  Exit statuses
 fall between 0 and 255, though, as explained below, the shell may
@@ -5386,7 +5354,6 @@ options to the
 .B set
 builtin.
 .SS "Readline Notation"
-.PP
 In this section, the Emacs-style notation is used to denote
 keystrokes.  Control keys are denoted by C\-\fIkey\fR, e.g., C\-n
 means Control\-N.  Similarly,
@@ -5422,7 +5389,6 @@ accumulated into one unit, which can be yanked all at 
once.
 Commands which do not kill text separate the chunks of text
 on the kill ring.
 .SS "Readline Initialization"
-.PP
 Readline is customized by putting commands in an initialization
 file (the \fIinputrc\fP file).
 The name of this file is taken from the value of the
@@ -5476,7 +5442,6 @@ and
 In addition to command names, readline allows keys to be bound
 to a string that is inserted when the key is pressed (a \fImacro\fP).
 .SS "Readline Key Bindings"
-.PP
 The syntax for controlling key bindings in the
 .I inputrc
 file is simple.  All that is required is the name of the
@@ -5627,7 +5592,6 @@ builtin command (see
 .B SHELL BUILTIN COMMANDS
 below).
 .SS "Readline Variables"
-.PP
 Readline has variables that can be used to further customize its
 behavior.  A variable may be set in the
 .I inputrc
@@ -5943,7 +5907,6 @@ by \fIstat\fP(2) is appended to the filename when listing 
possible
 completions.
 .PD
 .SS "Readline Conditional Constructs"
-.PP
 Readline implements a facility similar in spirit to the conditional
 compilation features of the C preprocessor which allows key
 bindings and variable settings to be performed as the result
@@ -6041,7 +6004,6 @@ would read \fI/etc/inputrc\fP:
 .fi
 .RE
 .SS Searching
-.PP
 Readline provides commands for searching through the command history
 (see
 .SM
@@ -6084,7 +6046,6 @@ Non-incremental searches read the entire search string 
before starting
 to search for matching history lines.  The search string may be
 typed by the user or be part of the contents of the current line.
 .SS "Readline Command Names"
-.PP
 The following is a list of the names of the commands and the default
 key sequences to which they are bound.
 Command names without an accompanying key sequence are unbound by default.
@@ -6093,7 +6054,6 @@ position, and \fImark\fP refers to a cursor position 
saved by the
 \fBset\-mark\fP command.
 The text between the point and mark is referred to as the \fIregion\fP.
 .SS Commands for Moving
-.PP
 .PD 0
 .TP
 .B beginning\-of\-line (C\-a)
@@ -6146,7 +6106,6 @@ screen.
 Refresh the current line.
 .PD
 .SS Commands for Manipulating the History
-.PP
 .PD 0
 .TP
 .B accept\-line (Newline, Return)
@@ -6288,7 +6247,6 @@ commands.
 and \fIemacs\fP as the editor, in that order.
 .PD
 .SS Commands for Changing Text
-.PP
 .PD 0
 .TP
 .B \fIend\-of\-file\fP (usually C\-d)
@@ -6363,7 +6321,6 @@ Characters bound to \fBbackward\-delete\-char\fP replace 
the character
 before point with a space.  By default, this command is unbound.
 .PD
 .SS Killing and Yanking
-.PP
 .PD 0
 .TP
 .B kill\-line (C\-k)
@@ -6434,7 +6391,6 @@ or
 .BR yank\-pop .
 .PD
 .SS Numeric Arguments
-.PP
 .PD 0
 .TP
 .B digit\-argument (M\-0, M\-1, ..., M\-\-)
@@ -6456,7 +6412,6 @@ first time makes the argument count four, a second time 
makes the
 argument count sixteen, and so on.
 .PD
 .SS Completing
-.PP
 .PD 0
 .TP
 .B complete (TAB)
@@ -6561,7 +6516,6 @@ enclosed within braces so the list is available to the 
shell (see
 above).
 .PD
 .SS Keyboard Macros
-.PP
 .PD 0
 .TP
 .B start\-kbd\-macro (C\-x (\^)
@@ -6580,7 +6534,6 @@ Print the last keyboard macro defined in a format 
suitable for the
 \fIinputrc\fP file.
 .PD
 .SS Miscellaneous
-.PP
 .PD 0
 .TP
 .B re\-read\-init\-file (C\-x C\-r)
@@ -6698,7 +6651,6 @@ Display version information about the current instance of
 .BR bash .
 .PD
 .SS Programmable Completion
-.PP
 When word completion is attempted for an argument to a command for
 which a completion specification (a \fIcompspec\fP) has been defined
 using the \fBcomplete\fP builtin (see
@@ -7016,7 +6968,6 @@ builtin below under
 .B "SHELL BUILTIN COMMANDS"
 for information on setting and unsetting shell options.
 .SH "HISTORY EXPANSION"
-.PP
 The shell supports a history expansion feature that
 is similar to the history expansion in
 .BR csh .
@@ -7110,7 +7061,6 @@ The shell uses
 the history comment character to mark history timestamps when
 writing the history file.
 .SS Event Designators
-.PP
 An event designator is a reference to a command line entry in the
 history list.
 Unless the reference is absolute, events are relative to the current
@@ -7162,7 +7112,6 @@ Equivalent to
 The entire command line typed so far.
 .PD
 .SS Word Designators
-.PP
 Word designators are used to select desired words from the event.
 A
 .B :
@@ -7217,12 +7166,10 @@ Abbreviates \fIx\-$\fP like \fBx*\fP, but omits the 
last word.
 If a word designator is supplied without an event specification, the
 previous command is used as the event.
 .SS Modifiers
-.PP
 After the optional word designator, there may appear a sequence of
 one or more of the following modifiers, each preceded by a `:'.
 .PP
 .PD 0
-.PP
 .TP
 .B h
 Remove a trailing filename component, leaving only the head.
@@ -7294,7 +7241,6 @@ Apply the following `\fBs\fP' modifier once to each word 
in the event line.
 .SH "SHELL BUILTIN COMMANDS"
 .\" start of bash_builtins
 .zZ
-.PP
 Unless otherwise noted, each builtin command documented in this
 section as accepting options preceded by
 .B \-
@@ -10768,7 +10714,6 @@ process or job waited for.
 .SH "RESTRICTED SHELL"
 .\" rbash.1
 .zY
-.PP
 If
 .B bash
 is started with the name
@@ -10948,7 +10893,6 @@ Comments and bug reports concerning
 this manual page should be directed to
 .IR chet.ramey@case.edu .
 .SH BUGS
-.PP
 It's too big and too slow.
 .PP
 There are some subtle differences between
-- 
2.27.0