Skip to content

Commit

Permalink
docs/bfs.1: Fix some mandoc lint warnings
Browse files Browse the repository at this point in the history
And add mandoc -Tlint to make check-man.
  • Loading branch information
tavianator committed Sep 5, 2024
1 parent ac042e1 commit 812ecd1
Show file tree
Hide file tree
Showing 3 changed files with 11 additions and 12 deletions.
1 change: 1 addition & 0 deletions .github/workflows/ci.yml
Original file line number Diff line number Diff line change
Expand Up @@ -17,6 +17,7 @@ jobs:
sudo apt-get update -y
sudo apt-get install -y \
expect \
mandoc \
gcc-multilib \
libgcc-s1:i386 \
acl \
Expand Down
5 changes: 3 additions & 2 deletions Makefile
Original file line number Diff line number Diff line change
Expand Up @@ -216,8 +216,9 @@ check-install::

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

## Cleanup (`make clean`)

Expand Down
17 changes: 7 additions & 10 deletions docs/bfs.1
Original file line number Diff line number Diff line change
Expand Up @@ -41,7 +41,7 @@ For example,
.PP
.nf
.RS
.B bfs \\\( \-name '*.txt' \-or \-lname '*.txt' \\\\) \-and \-print
.B bfs \e( \-name '*.txt' \-or \-lname '*.txt' \e) \-and \-print
.RE
.fi
.PP
Expand All @@ -51,7 +51,7 @@ is implied between two consecutive expressions, so this is equivalent:
.PP
.nf
.RS
.B bfs \\\( \-name '*.txt' \-or \-lname '*.txt' \\\\) \-print
.B bfs \e( \-name '*.txt' \-or \-lname '*.txt' \e) \-print
.RE
.fi
.PP
Expand Down Expand Up @@ -115,7 +115,6 @@ Don't descend into other mount points (same as \fB\-xdev\fR).
Treat
.I PATH
as a path to search (useful if it begins with a dash).
.PP
.TP
\fB\-D \fIFLAG\fR
Turn on a debugging flag (see
Expand Down Expand Up @@ -188,9 +187,9 @@ threads in parallel (default: number of CPUs, up to
\fB( \fIexpression \fB)\fR
Parentheses are used for grouping expressions together.
You'll probably have to write
.B \\\\(
.B \e(
.I expression
.B \\\\)
.B \e)
to avoid the parentheses being interpreted by the shell.
.PP
\fB! \fIexpression\fR
Expand All @@ -199,7 +198,7 @@ to avoid the parentheses being interpreted by the shell.
.RS
The "not" operator: returns the negation of the truth value of the
.IR expression .
You may have to write \fB\\! \fIexpression\fR to avoid \fB!\fR being interpreted by the shell.
You may have to write \fB\e! \fIexpression\fR to avoid \fB!\fR being interpreted by the shell.
.RE
.PP
\fIexpression\fR \fIexpression\fR
Expand Down Expand Up @@ -266,7 +265,6 @@ Print usage information, and exit immediately (without parsing the rest of the c
Print version information, and exit immediately.
.RE
.SH OPTIONS
.PP
.B \-color
.br
.B \-nocolor
Expand All @@ -289,7 +287,7 @@ Follow all symbolic links (same as
.BR \-L ).
.TP
\fB\-files0\-from \fIFILE\fR
Treat the NUL ('\\0')-separated paths in
Treat the NUL ('\e0')-separated paths in
.I FILE
as starting points for the search.
Pass
Expand Down Expand Up @@ -689,7 +687,6 @@ Find files of the given type, following links when
.B \-type
would not, and vice versa.
.SH ACTIONS
.PP
.B \-delete
.br
.B \-rm
Expand Down Expand Up @@ -753,7 +750,7 @@ Print the path to the found file.
.B \-print0
Like
.BR \-print ,
but use the null character ('\\0') as a separator rather than newlines.
but use the null character ('\e0') as a separator rather than newlines.
Useful in conjunction with
.B xargs
.IR \-0 .
Expand Down

0 comments on commit 812ecd1

Please sign in to comment.