Skip to content

Commit

Permalink
Script for checking sanity of manpages
Browse files Browse the repository at this point in the history
Change-Id: Ia27b0ecf6a3267eb51f8a6562721dca72f128915
  • Loading branch information
onovy authored and notmyname committed Feb 10, 2016
1 parent 4e370e5 commit cc8dc88
Show file tree
Hide file tree
Showing 2 changed files with 26 additions and 0 deletions.
18 changes: 18 additions & 0 deletions .manpages
Original file line number Diff line number Diff line change
@@ -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"
8 changes: 8 additions & 0 deletions doc/source/development_guidelines.rst
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down

0 comments on commit cc8dc88

Please sign in to comment.