2021-05-26 23:31:43 +00:00
|
|
|
#!/bin/sh
|
|
|
|
|
#
|
|
|
|
|
# Permission to use, copy, modify, and/or distribute this software for
|
|
|
|
|
# any purpose with or without fee is hereby granted.
|
|
|
|
|
#
|
|
|
|
|
# THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
|
|
|
|
|
# WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
|
|
|
|
|
# MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
|
|
|
|
|
# ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
|
|
|
|
|
# WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN
|
|
|
|
|
# AN ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT
|
|
|
|
|
# OF OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
|
|
|
|
|
#
|
|
|
|
|
# shellcheck disable=SC2086
|
|
|
|
|
|
|
|
|
|
if [ "$#" -eq 0 ]; then
|
|
|
|
|
echo "Usage: $0 manpage-directory..."
|
|
|
|
|
exit 1
|
|
|
|
|
fi
|
|
|
|
|
|
|
|
|
|
if ! command -v mandoc > /dev/null; then
|
|
|
|
|
echo "skipping mancheck because mandoc is not installed"
|
|
|
|
|
exit 0
|
|
|
|
|
fi
|
|
|
|
|
|
|
|
|
|
IFS="
|
|
|
|
|
"
|
|
|
|
|
|
Modernise/fix/rewrite unlinted manpages
zpool-destroy.8: flatten, fix description
zfs-wait.8: flatten, fix description, use list for events
zpool-reguid.8: flatten, fix description
zpool-history.8: flatten, fix description
zpool-export.8: flatten, fix description, remove -f "unmount" reference
AFAICT no such command exists even in Illumos (as of today, anyway),
and we definitely don't call it
zpool-labelclear.8: flatten, fix description
zpool-features.5: modernise
spl-module-parameters.5: modernise
zfs-mount-generator.8: rewrite
zfs-module-parameters.5: modernise
Reviewed-by: Richard Laager <rlaager@wiktel.com>
Reviewed-by: Brian Behlendorf <behlendorf1@llnl.gov>
Signed-off-by: Ahelenia Ziemiańska <nabijaczleweli@nabijaczleweli.xyz>
Closes #12169
2021-06-07 19:41:54 +00:00
|
|
|
files="$(find "$@" -type f -name '*[1-9]*')" || exit 1
|
2021-05-26 23:31:43 +00:00
|
|
|
|
|
|
|
|
add_excl="$(awk '
|
|
|
|
|
/^.\\" lint-ok:/ {
|
|
|
|
|
print "-e"
|
|
|
|
|
$1 = "mandoc:"
|
|
|
|
|
$2 = FILENAME ":[[:digit:]]+:[[:digit:]]+:"
|
|
|
|
|
print
|
|
|
|
|
}' $files)"
|
|
|
|
|
|
|
|
|
|
# Redirect to file instead of 2>&1ing because mandoc flushes inconsistently(?) which tears lines
|
|
|
|
|
# https://github.com/openzfs/zfs/pull/12129/checks?check_run_id=2701608671#step:5:3
|
|
|
|
|
etmp="$(mktemp)"
|
|
|
|
|
! { mandoc -Tlint $files 2>"$etmp"; cat "$etmp"; rm -f "$etmp"; } |
|
|
|
|
|
grep -vE -e 'mandoc: outdated mandoc.db' -e 'STYLE: referenced manual not found' $add_excl >&2
|
