Skip to content

Commit 812ecd1

Browse files
committed
docs/bfs.1: Fix some mandoc lint warnings
And add mandoc -Tlint to make check-man.
1 parent ac042e1 commit 812ecd1

3 files changed

Lines changed: 11 additions & 12 deletions

File tree

.github/workflows/ci.yml

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -17,6 +17,7 @@ jobs:
1717
sudo apt-get update -y
1818
sudo apt-get install -y \
1919
expect \
20+
mandoc \
2021
gcc-multilib \
2122
libgcc-s1:i386 \
2223
acl \

Makefile

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -216,8 +216,9 @@ check-install::
216216

217217
# Check man page markup
218218
check-man::
219-
${MSG} "[LINT] docs/bfs.1" \
220-
groff -man -rCHECKSTYLE=3 -ww -b -z docs/bfs.1
219+
${MSG} "[LINT] docs/bfs.1"
220+
${Q}groff -man -rCHECKSTYLE=3 -ww -b -z docs/bfs.1
221+
${Q}mandoc -Tlint -Wwarning docs/bfs.1
221222

222223
## Cleanup (`make clean`)
223224

docs/bfs.1

Lines changed: 7 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -41,7 +41,7 @@ For example,
4141
.PP
4242
.nf
4343
.RS
44-
.B bfs \\\( \-name '*.txt' \-or \-lname '*.txt' \\\\) \-and \-print
44+
.B bfs \e( \-name '*.txt' \-or \-lname '*.txt' \e) \-and \-print
4545
.RE
4646
.fi
4747
.PP
@@ -51,7 +51,7 @@ is implied between two consecutive expressions, so this is equivalent:
5151
.PP
5252
.nf
5353
.RS
54-
.B bfs \\\( \-name '*.txt' \-or \-lname '*.txt' \\\\) \-print
54+
.B bfs \e( \-name '*.txt' \-or \-lname '*.txt' \e) \-print
5555
.RE
5656
.fi
5757
.PP
@@ -115,7 +115,6 @@ Don't descend into other mount points (same as \fB\-xdev\fR).
115115
Treat
116116
.I PATH
117117
as a path to search (useful if it begins with a dash).
118-
.PP
119118
.TP
120119
\fB\-D \fIFLAG\fR
121120
Turn on a debugging flag (see
@@ -188,9 +187,9 @@ threads in parallel (default: number of CPUs, up to
188187
\fB( \fIexpression \fB)\fR
189188
Parentheses are used for grouping expressions together.
190189
You'll probably have to write
191-
.B \\\\(
190+
.B \e(
192191
.I expression
193-
.B \\\\)
192+
.B \e)
194193
to avoid the parentheses being interpreted by the shell.
195194
.PP
196195
\fB! \fIexpression\fR
@@ -199,7 +198,7 @@ to avoid the parentheses being interpreted by the shell.
199198
.RS
200199
The "not" operator: returns the negation of the truth value of the
201200
.IR expression .
202-
You may have to write \fB\\! \fIexpression\fR to avoid \fB!\fR being interpreted by the shell.
201+
You may have to write \fB\e! \fIexpression\fR to avoid \fB!\fR being interpreted by the shell.
203202
.RE
204203
.PP
205204
\fIexpression\fR \fIexpression\fR
@@ -266,7 +265,6 @@ Print usage information, and exit immediately (without parsing the rest of the c
266265
Print version information, and exit immediately.
267266
.RE
268267
.SH OPTIONS
269-
.PP
270268
.B \-color
271269
.br
272270
.B \-nocolor
@@ -289,7 +287,7 @@ Follow all symbolic links (same as
289287
.BR \-L ).
290288
.TP
291289
\fB\-files0\-from \fIFILE\fR
292-
Treat the NUL ('\\0')-separated paths in
290+
Treat the NUL ('\e0')-separated paths in
293291
.I FILE
294292
as starting points for the search.
295293
Pass
@@ -689,7 +687,6 @@ Find files of the given type, following links when
689687
.B \-type
690688
would not, and vice versa.
691689
.SH ACTIONS
692-
.PP
693690
.B \-delete
694691
.br
695692
.B \-rm
@@ -753,7 +750,7 @@ Print the path to the found file.
753750
.B \-print0
754751
Like
755752
.BR \-print ,
756-
but use the null character ('\\0') as a separator rather than newlines.
753+
but use the null character ('\e0') as a separator rather than newlines.
757754
Useful in conjunction with
758755
.B xargs
759756
.IR \-0 .

0 commit comments

Comments
 (0)