scripts: import a linter for manual pages
This commit is contained in:
parent
9766259e33
commit
d5b28a6157
|
|
@ -1,4 +1,4 @@
|
|||
dist=Makefile,config.sh,data/pkgconfig.sh,doc/docbook.sh,doc/gtkdoc.sh,doc/manual.css.xml,doc/markdown.sh,po/gettext.sh,tests/clint.sh,tests/coverage.sh,tests/distcheck.sh,tests/fixme.sh,tests/golint.sh,tests/gotest.sh,tests/htmllint.sh,tests/phplint.sh,tests/pkgconfig.sh,tests/pylint.sh,tests/shlint.sh,tests/xmllint.sh,tools/appbroker.sh,tools/platform.sh,tools/subst.sh,tools/template.sh
|
||||
dist=Makefile,config.sh,data/pkgconfig.sh,doc/docbook.sh,doc/gtkdoc.sh,doc/manual.css.xml,doc/markdown.sh,po/gettext.sh,tests/clint.sh,tests/coverage.sh,tests/distcheck.sh,tests/fixme.sh,tests/golint.sh,tests/gotest.sh,tests/htmllint.sh,tests/manlint.sh,tests/phplint.sh,tests/pkgconfig.sh,tests/pylint.sh,tests/shlint.sh,tests/xmllint.sh,tools/appbroker.sh,tools/platform.sh,tools/subst.sh,tools/template.sh
|
||||
|
||||
#dist
|
||||
[data/pkgconfig.sh]
|
||||
|
|
@ -52,6 +52,10 @@ mode=0755
|
|||
install=$(PREFIX)/libexec/configure/scripts
|
||||
mode=0755
|
||||
|
||||
[tests/manlint.sh]
|
||||
install=$(PREFIX)/libexec/configure/scripts
|
||||
mode=0755
|
||||
|
||||
[tests/phplint.sh]
|
||||
install=$(PREFIX)/libexec/configure/scripts
|
||||
mode=0755
|
||||
|
|
|
|||
157
src/scripts/tests/manlint.sh
Executable file
157
src/scripts/tests/manlint.sh
Executable file
|
|
@ -0,0 +1,157 @@
|
|||
#!/bin/sh
|
||||
#$Id$
|
||||
#Copyright (c) 2025 Pierre Pronchery <khorben@defora.org>
|
||||
#
|
||||
#Redistribution and use in source and binary forms, with or without
|
||||
#modification, are permitted provided that the following conditions are met:
|
||||
#
|
||||
# * Redistributions of source code must retain the above copyright notice, this
|
||||
# list of conditions and the following disclaimer.
|
||||
# * Redistributions in binary form must reproduce the above copyright notice,
|
||||
# this list of conditions and the following disclaimer in the documentation
|
||||
# and/or other materials provided with the distribution.
|
||||
#
|
||||
#THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
|
||||
#AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
|
||||
#IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
|
||||
#DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE
|
||||
#FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
|
||||
#DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
|
||||
#SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
|
||||
#CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
|
||||
#OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
|
||||
#OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
|
||||
|
||||
|
||||
|
||||
#variables
|
||||
CONFIGSH="${0%/manlint.sh}/../config.sh"
|
||||
PROGNAME="manlint.sh"
|
||||
PROJECTCONF="../project.conf"
|
||||
#executables
|
||||
DATE="date"
|
||||
DEBUG="_debug"
|
||||
ECHO="/bin/echo"
|
||||
FIND="find"
|
||||
MANDOC="mandoc"
|
||||
MKDIR="mkdir -p"
|
||||
SORT="sort -n"
|
||||
TR="tr"
|
||||
|
||||
[ -f "$CONFIGSH" ] && . "$CONFIGSH"
|
||||
|
||||
|
||||
#functions
|
||||
#manlint
|
||||
_manlint()
|
||||
{
|
||||
res=0
|
||||
subdirs=
|
||||
|
||||
$DATE
|
||||
while read line; do
|
||||
case "$line" in
|
||||
"["*)
|
||||
break
|
||||
;;
|
||||
"subdirs="*)
|
||||
subdirs=${line#subdirs=}
|
||||
subdirs=$(echo "$subdirs" | $TR ',' ' ')
|
||||
;;
|
||||
esac
|
||||
done < "$PROJECTCONF"
|
||||
if [ ! -n "$subdirs" ]; then
|
||||
_error "Could not locate directories to analyze"
|
||||
return $?
|
||||
fi
|
||||
for subdir in $subdirs; do
|
||||
[ -d "../$subdir" ] || continue
|
||||
while read filename; do
|
||||
[ -n "$filename" ] || continue
|
||||
echo
|
||||
$ECHO -n "$filename:"
|
||||
$DEBUG $MANDOC -Tlint "$filename" 2>&1
|
||||
if [ $? -eq 0 ]; then
|
||||
echo " OK"
|
||||
echo "$PROGNAME: $filename: OK" 1>&2
|
||||
else
|
||||
echo "FAIL"
|
||||
echo "$PROGNAME: $filename: FAIL" 1>&2
|
||||
res=2
|
||||
fi
|
||||
done << EOF
|
||||
$($FIND "../$subdir" -type f -a \( \
|
||||
-name '*.1' -o -name '*.2' -o -name '*.3' -o -name '*.4' \
|
||||
-o -name '*.5' -o -name '*.6' -o -name '*.7' -o -name '*.8' \
|
||||
-o -name '*.9' \) | $SORT)
|
||||
EOF
|
||||
done
|
||||
return $res
|
||||
}
|
||||
|
||||
|
||||
#debug
|
||||
_debug()
|
||||
{
|
||||
echo "$@" 1>&3
|
||||
"$@"
|
||||
}
|
||||
|
||||
|
||||
#error
|
||||
_error()
|
||||
{
|
||||
echo "$PROGNAME: $@" 1>&2
|
||||
return 2
|
||||
}
|
||||
|
||||
|
||||
#usage
|
||||
_usage()
|
||||
{
|
||||
echo "Usage: $PROGNAME [-c] target..." 1>&2
|
||||
return 1
|
||||
}
|
||||
|
||||
|
||||
#main
|
||||
clean=0
|
||||
while getopts "cO:P:" name; do
|
||||
case "$name" in
|
||||
c)
|
||||
clean=1
|
||||
;;
|
||||
O)
|
||||
export "${OPTARG%%=*}"="${OPTARG#*=}"
|
||||
;;
|
||||
P)
|
||||
#XXX ignored for compatibility
|
||||
;;
|
||||
?)
|
||||
_usage
|
||||
exit $?
|
||||
;;
|
||||
esac
|
||||
done
|
||||
shift $((OPTIND - 1))
|
||||
if [ $# -lt 1 ]; then
|
||||
_usage
|
||||
exit $?
|
||||
fi
|
||||
|
||||
#clean
|
||||
[ $clean -ne 0 ] && exit 0
|
||||
|
||||
exec 3>&1
|
||||
ret=0
|
||||
while [ $# -gt 0 ]; do
|
||||
target="$1"
|
||||
dirname="${target%/*}"
|
||||
shift
|
||||
|
||||
if [ -n "$dirname" -a "$dirname" != "$target" ]; then
|
||||
$MKDIR -- "$dirname" || ret=$?
|
||||
fi
|
||||
_manlint > "$target" || ret=$?
|
||||
done
|
||||
exit $ret
|
||||
Loading…
Reference in New Issue
Block a user