Script for checking sanity of manpages

Change-Id: Ia27b0ecf6a3267eb51f8a6562721dca72f128915
This commit is contained in:
Ondřej Nový 2016-02-04 16:02:42 +01:00 committed by John Dickinson
parent 4e370e5116
commit cc8dc88b55
2 changed files with 26 additions and 0 deletions

18
.manpages Executable file
View File

@ -0,0 +1,18 @@
#!/bin/sh
RET=0
for MAN in doc/manpages/* ; do
OUTPUT=$(LC_ALL=en_US.UTF-8 MANROFFSEQ='' MANWIDTH=80 man --warnings -E UTF-8 -l \
-Tutf8 -Z "$MAN" 2>&1 >/dev/null)
if [ -n "$OUTPUT" ] ; then
RET=1
echo "$MAN:"
echo "$OUTPUT"
fi
done
if [ "$RET" -eq "0" ] ; then
echo "All manpages are fine"
fi
exit "$RET"

View File

@ -164,6 +164,14 @@ Installing Sphinx:
#. Install sphinx (On Ubuntu: `sudo apt-get install python-sphinx`)
#. `python setup.py build_sphinx`
--------
Manpages
--------
For sanity check of your change in manpage, use this command in the root
of your Swift repo::
./.manpages
---------------------
License and Copyright