Skip to content

Commit

Permalink
docs: Add Makefile rule to check syntax of manpages.
Browse files Browse the repository at this point in the history
This should catch future nroff syntax errors immediately, instead of much
later.
  • Loading branch information
blp committed Aug 24, 2011
1 parent 5d94380 commit 0027492
Show file tree
Hide file tree
Showing 7 changed files with 31 additions and 5 deletions.
15 changes: 14 additions & 1 deletion Makefile.am
Original file line number Diff line number Diff line change
Expand Up @@ -45,7 +45,8 @@ EXTRA_DIST = \
REPORTING-BUGS \
SubmittingPatches \
WHY-OVS \
boot.sh
boot.sh \
$(MAN_FRAGMENTS)
bin_PROGRAMS =
sbin_PROGRAMS =
bin_SCRIPTS =
Expand All @@ -57,6 +58,7 @@ dist_sbin_SCRIPTS =
dist_scripts_SCRIPTS =
INSTALL_DATA_LOCAL =
man_MANS =
MAN_FRAGMENTS =
noinst_DATA =
noinst_HEADERS =
noinst_LIBRARIES =
Expand Down Expand Up @@ -148,6 +150,17 @@ rate-limit-check:
exit 1; \
fi

if HAVE_GROFF
ALL_LOCAL += manpage-check
manpage-check: $(MANS) $(MAN_FRAGMENTS)
@manpages=; \
for d in $(MANS); do \
manpages="$$manpages `test -f $$d || echo $(VPATH)/`$$d"; \
done; \
LANG=en_US.UTF-8 groff -w mac -w delim -w escape -w input -w missing -w tab -T utf8 -man -p -z $$manpages && touch $@
CLEANFILES += manpage-check
endif

dist-hook: $(DIST_HOOKS)
all-local: $(ALL_LOCAL)
clean-local: $(CLEAN_LOCAL)
Expand Down
1 change: 1 addition & 0 deletions configure.ac
Original file line number Diff line number Diff line change
Expand Up @@ -67,6 +67,7 @@ OVS_CHECK_VALGRIND
OVS_CHECK_SOCKET_LIBS
OVS_CHECK_LINKER_SECTIONS
OVS_CHECK_XENSERVER_VERSION
OVS_CHECK_GROFF

OVS_ENABLE_OPTION([-Wall])
OVS_ENABLE_OPTION([-Wno-sign-compare])
Expand Down
2 changes: 1 addition & 1 deletion lib/automake.mk
Original file line number Diff line number Diff line change
Expand Up @@ -236,7 +236,7 @@ EXTRA_DIST += \
lib/dh4096.pem \
lib/dirs.c.in

EXTRA_DIST += \
MAN_FRAGMENTS += \
lib/common.man \
lib/common-syn.man \
lib/daemon.man \
Expand Down
12 changes: 12 additions & 0 deletions m4/openvswitch.m4
Original file line number Diff line number Diff line change
Expand Up @@ -361,3 +361,15 @@ AC_DEFUN([OVS_CHECK_LINKER_SECTIONS],
fi
AM_CONDITIONAL(
[USE_LINKER_SECTIONS], [test $ovs_cv_use_linker_sections = yes])])

dnl Checks for groff.
AC_DEFUN([OVS_CHECK_GROFF],
[AC_CACHE_CHECK(
[for groff],
[ovs_cv_groff],
[if (groff -v) >/dev/null 2>&1; then
ovs_cv_groff=yes
else
ovs_cv_groff=no
fi])
AM_CONDITIONAL([HAVE_GROFF], [test "$ovs_cv_groff" = yes])])
2 changes: 1 addition & 1 deletion ofproto/automake.mk
Original file line number Diff line number Diff line change
Expand Up @@ -29,4 +29,4 @@ ofproto_libofproto_a_SOURCES = \
ofproto/pinsched.c \
ofproto/pinsched.h

EXTRA_DIST += ofproto/ofproto-unixctl.man
MAN_FRAGMENTS += ofproto/ofproto-unixctl.man
2 changes: 1 addition & 1 deletion ovsdb/automake.mk
Original file line number Diff line number Diff line change
Expand Up @@ -29,7 +29,7 @@ ovsdb_libovsdb_a_SOURCES = \
ovsdb/trigger.h \
ovsdb/transaction.c \
ovsdb/transaction.h
EXTRA_DIST += \
MAN_FRAGMENTS += \
ovsdb/remote-active.man \
ovsdb/remote-passive.man

Expand Down
2 changes: 1 addition & 1 deletion utilities/automake.mk
Original file line number Diff line number Diff line change
Expand Up @@ -32,11 +32,11 @@ EXTRA_DIST += \
utilities/ovs-save \
utilities/ovs-tcpundump.1.in \
utilities/ovs-tcpundump.in \
utilities/ovs-vlan-bugs.man \
utilities/ovs-vlan-test.in \
utilities/ovs-vlan-bug-workaround.8.in \
utilities/ovs-vlan-test.8.in \
utilities/ovs-vsctl.8.in
MAN_FRAGMENTS += utilities/ovs-vlan-bugs.man
DISTCLEANFILES += \
utilities/ovs-appctl.8 \
utilities/ovs-ctl \
Expand Down

0 comments on commit 0027492

Please sign in to comment.