From 812ecd1feeb002252dd4d732b395d31c4179afaf Mon Sep 17 00:00:00 2001 From: Tavian Barnes Date: Thu, 5 Sep 2024 12:44:49 -0400 Subject: docs/bfs.1: Fix some mandoc lint warnings And add mandoc -Tlint to make check-man. --- .github/workflows/ci.yml | 1 + Makefile | 5 +++-- docs/bfs.1 | 17 +++++++---------- 3 files changed, 11 insertions(+), 12 deletions(-) diff --git a/.github/workflows/ci.yml b/.github/workflows/ci.yml index be0a164..afc709b 100644 --- a/.github/workflows/ci.yml +++ b/.github/workflows/ci.yml @@ -17,6 +17,7 @@ jobs: sudo apt-get update -y sudo apt-get install -y \ expect \ + mandoc \ gcc-multilib \ libgcc-s1:i386 \ acl \ diff --git a/Makefile b/Makefile index 5a46cfc..870e0cb 100644 --- a/Makefile +++ b/Makefile @@ -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`) diff --git a/docs/bfs.1 b/docs/bfs.1 index 040090c..2e5ade7 100644 --- a/docs/bfs.1 +++ b/docs/bfs.1 @@ -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 @@ -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 @@ -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 @@ -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 @@ -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 @@ -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 @@ -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 @@ -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 @@ -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 . -- cgit v1.2.3