xref: /freebsd/sys/contrib/openzfs/scripts/mancheck.sh (revision af23369a6deaaeb612ab266eb88b8bb8d560c322)
1#!/bin/sh
2#
3# Permission to use, copy, modify, and/or distribute this software for
4# any purpose with or without fee is hereby granted.
5#
6# THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
7# WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
8# MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
9# ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
10# WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN
11# AN ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT
12# OF OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
13#
14# shellcheck disable=SC2086
15
16trap 'rm -f "$stdout_file" "$stderr_file" "$result_file"' EXIT
17
18if [ "$#" -eq 0 ]; then
19    echo "Usage: $0 manpage-directory..."
20    exit 1
21fi
22
23if ! command -v mandoc > /dev/null; then
24    echo "skipping mancheck because mandoc is not installed"
25    exit 0
26fi
27
28IFS="
29"
30files="$(find "$@" -type f -name '*[1-9]*')" || exit 1
31
32add_excl="$(awk '
33    /^.\\" lint-ok:/ {
34        print "-e"
35        $1 = "mandoc:"
36        $2 = FILENAME ":[[:digit:]]+:[[:digit:]]+:"
37        print
38    }' $files)"
39
40# Redirect to file instead of 2>&1ing because mandoc flushes inconsistently(?) which tears lines
41# https://github.com/openzfs/zfs/pull/12129/checks?check_run_id=2701608671#step:5:3
42stdout_file="$(mktemp)"
43stderr_file="$(mktemp)"
44mandoc -Tlint $files 1>"$stdout_file" 2>"$stderr_file"
45result_file="$(mktemp)"
46grep -vhE -e 'mandoc: outdated mandoc.db' -e 'STYLE: referenced manual not found' $add_excl "$stdout_file" "$stderr_file" > "$result_file"
47
48if [ -s "$result_file" ]; then
49    cat "$result_file"
50    exit 1
51else
52    echo "no errors found"
53fi
54