Skip to content

Commit

Permalink
Widen mancheck target to all pages, fix them
Browse files Browse the repository at this point in the history
mandoc: ./man/man8/zfs-mount-generator.8.in:188:2:
        ERROR: skipping end of block that is not open: RE
mandoc: ./man/man8/zfs_ids_to_path.8:38:2:
        ERROR: skipping unknown macro: .LP
mandoc: ./man/man8/zfs_ids_to_path.8:48:2:
        ERROR: inserting missing end of block: Sh breaks Bl
mandoc: ./man/man8/zfs-wait.8:69:2:
        ERROR: skipping end of block that is not open: El
mandoc: ./man/man8/zfs-program.8:460:2:
        ERROR: inserting missing end of block: It breaks Bd
mandoc: ./man/man8/zfs-mount-generator.8:188:2:
        ERROR: skipping end of block that is not open: RE
mandoc: ./man/man8/zstream.8:43:2:
        ERROR: skipping unknown macro: .LP
mandoc: ./man/man8/zstream.8:107:2:
        ERROR: inserting missing end of block: Sh breaks Bl
mandoc: ./man/man8/zstream.8:107:2:
        ERROR: inserting missing end of block: Sh breaks Bl
make: *** [Makefile:1529: mancheck] Error 1

Reviewed-by: Brian Behlendorf <behlendorf1@llnl.gov>
Signed-off-by: Ahelenia Ziemiańska <nabijaczleweli@nabijaczleweli.xyz>
Issue openzfs#12017
  • Loading branch information
nabijaczleweli authored and behlendorf committed May 28, 2021
1 parent 1a7bad5 commit ade8e4b
Show file tree
Hide file tree
Showing 6 changed files with 6 additions and 8 deletions.
6 changes: 2 additions & 4 deletions Makefile.am
Original file line number Diff line number Diff line change
Expand Up @@ -169,10 +169,8 @@ checkbashisms:
PHONY += mancheck
mancheck:
@if type mandoc > /dev/null 2>&1; then \
find ${top_srcdir}/man/man8 -type f -name 'zfs.8' \
-o -name 'zpool.8' -o -name 'zdb.8' \
-o -name 'zgenhostid.8' | \
xargs mandoc -Tlint -Werror; \
find ${top_srcdir}/man/man8 -type f -name '*[1-9]*' \
-exec mandoc -Tlint -Werror {} \+; \
else \
echo "skipping mancheck because mandoc is not installed"; \
fi
Expand Down
1 change: 0 additions & 1 deletion man/man8/zfs-mount-generator.8.in
Original file line number Diff line number Diff line change
Expand Up @@ -185,7 +185,6 @@ If set to
.BR on ,
do not generate a mount unit for this dataset.

.RE
See also
.BR systemd.mount (5)

Expand Down
1 change: 1 addition & 0 deletions man/man8/zfs-program.8
Original file line number Diff line number Diff line change
Expand Up @@ -457,6 +457,7 @@ newbookmark (string)
.Bd -ragged -compact -offset "xxxx"
Full name of the new bookmark.
.El
.Ed
.It Sy zfs.check submodule
For each function in the zfs.sync submodule, there is a corresponding zfs.check
function which performs a "dry run" of the same operation.
Expand Down
1 change: 0 additions & 1 deletion man/man8/zfs-wait.8
Original file line number Diff line number Diff line change
Expand Up @@ -66,6 +66,5 @@ Note that the internal delete queue does not finish draining until
all large files have had time to be fully destroyed and all open file
handles to unlinked files are closed.
.El
.El
.Sh SEE ALSO
.Xr lsof 8
2 changes: 1 addition & 1 deletion man/man8/zfs_ids_to_path.8
Original file line number Diff line number Diff line change
Expand Up @@ -35,7 +35,6 @@
.Nm
.Sh DESCRIPTION
.Pp
.LP
The
.Sy zfs_ids_to_path
utility converts a provided objset and object id into a path to the file that
Expand All @@ -45,6 +44,7 @@ those ids refer to.
Verbose.
Print the dataset name and the file path within the dataset separately. This
will work correctly even if the dataset is not mounted.
.El
.Sh SEE ALSO
.Xr zfs 8 ,
.Xr zdb 8
3 changes: 2 additions & 1 deletion man/man8/zstream.8
Original file line number Diff line number Diff line change
Expand Up @@ -40,7 +40,6 @@
.Ar resume_token
.Sh DESCRIPTION
.sp
.LP
The
.Sy zstream
utility manipulates zfs send streams, which are the output of the
Expand Down Expand Up @@ -104,6 +103,8 @@ Therefore, a deduplicated send stream can be received by running:
.It Fl v
Verbose.
Print summary of converted records.
.El
.El
.Sh SEE ALSO
.Xr zfs 8 ,
.Xr zfs-send 8 ,
Expand Down

0 comments on commit ade8e4b

Please sign in to comment.