bug-bash
[Top][All Lists]
Advanced

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

[PATCH 02/13] doc/bash.1: Fix groff man(7) style warnings.


From: G. Branden Robinson
Subject: [PATCH 02/13] doc/bash.1: Fix groff man(7) style warnings.
Date: Thu, 28 Mar 2024 16:11:09 -0500

Diff of rendering (ignoring differences in character set, default line
length, and a font selection affecting only a period):

(groff Git, 1.23.0, 1.22.4; mandoc; Heirloom Doctools nroff; DWB nroff)

-     expansion, word splitting, pathname expansion, and quote removal .
+     expansion, word splitting, pathname expansion, and quote removal.

Fixes style warnings from groff 1.23.0 "nroff -rCHECKSTYLE=3 -man":
an.tmac:./doc/bash.1:3033: style: .IR expects at least 2 arguments, got 1
an.tmac:./doc/bash.1:6302: style: .BR expects at least 2 arguments, got 1
an.tmac:./doc/bash.1:6454: style: .BR expects at least 2 arguments, got 1
---
 doc/bash.1 | 9 ++++++---
 1 file changed, 6 insertions(+), 3 deletions(-)

diff --git a/doc/bash.1 b/doc/bash.1
index 65bd81ce..c3253b09 100644
--- a/doc/bash.1
+++ b/doc/bash.1
@@ -3030,7 +3030,7 @@ .SH EXPANSION
 .IR "word splitting" ,
 .IR "pathname expansion" ,
 and
-.IR "quote removal .
+.IR "quote removal" .
 .PP
 The order of expansions is:
 brace expansion;
@@ -6299,7 +6299,7 @@ .SS "Readline Variables"
 .\" finesse.  We require `\c`, and while the single-font macros don't
 .\" honor input trap continuation, the font alternation macros do.
 .TP
-.BR comment\-begin\ (\c
+.BR comment\-begin\ ( \c
 .Q \fB#\fP \fB)\fP
 The string that is inserted when the readline
 .B insert\-comment
@@ -6450,8 +6450,11 @@ .SS "Readline Variables"
 locale contains eight-bit characters.
 This variable is dependent on the \fBLC_CTYPE\fP locale category, and
 may change if the locale is changed.
+.\" Tucking multiple macro calls into a paragraph tag requires some
+.\" finesse.  We require `\c`, and while the single-font macros don't
+.\" honor input trap continuation, the font alternation macros do.
 .TP
-.BR isearch\-terminators\ (\c
+.BR isearch\-terminators\ ( \c
 .Q \fBC\-[C\-J\fP \fB)\fP
 The string of characters that should terminate an incremental
 search without subsequently executing the character as a command.
-- 
2.30.2

Attachment: signature.asc
Description: PGP signature


reply via email to

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