doc: "check-man" target to ensure we stay <=80 cols

[public-inbox.git] / Documentation / include.mk

diff --git a/Documentation/include.mk b/Documentation/include.mk
index 04c6b35878b5b4cd47969b3a732b4d26858dcbc1..4af8d45552b8bed8264ab57cf6da31eff5a9d08b 100644 (file)
--- a/Documentation/include.mk
+++ b/Documentation/include.mk
@@ -8,8 +8,12 @@ all::
 # Maybe it's not worth it to support non-GNU make, though...
 RSYNC = rsync
 RSYNC_DEST = public-inbox.org:/srv/public-inbox/
+AWK = awk
 MAN = man
+
+# this is "xml" on FreeBSD and maybe some other distros:
 XMLSTARLET = xmlstarlet
+AWK = awk
 
 # same as pod2text
 COLUMNS = 76
@@ -58,7 +62,9 @@ man8 := $(addsuffix .8, $(m8))
 
 all:: man html
 
-man: $(man1) $(man5) $(man7) $(man8)
+manpages = $(man1) $(man5) $(man7) $(man8)
+
+man: $(manpages)
 
 prefix ?= $(PREFIX)
 prefix ?= $(HOME)
@@ -83,6 +89,19 @@ doc_install :: install-man
 %.1 %.5 %.7 %.8 : Documentation/%.pod
        $(podman) -s $(subst .,,$(suffix $@)) $< $@+ && mv $@+ $@
 
+# n.b. not sure if our usage of man(1) is portable or not, so not
+# enabled by default "check" target:
+# check :: check-man
+check_man = @echo CHECK80 $<;COLS=80 $(MAN) ./$^ | \
+       $(AWK) 'length>80{print;err=1}END{exit(err)}' >&2
+
+%.1.cols : %.1; $(check_man)
+%.5.cols : %.5; $(check_man)
+%.7.cols : %.7; $(check_man)
+%.8.cols : %.8; $(check_man)
+
+check-man :: $(addsuffix .cols, $(manpages))
+
 manuals :=
 manuals += $(m1)
 manuals += $(m5)
@@ -109,14 +128,15 @@ RELEASES =
 RELEASES += v1.1.0-pre1
 RELEASES += v1.0.0
 
-NEWS NEWS.atom NEWS.html : Documentation/RelNotes
+NEWS NEWS.atom NEWS.html :
        $(PERL) -I lib -w Documentation/mknews.perl $@ $(RELEASES)
 
 # check for internal API changes:
 check :: NEWS check-NEWS.atom NEWS.html
 
 check-NEWS.atom: NEWS.atom
-       $(XMLSTARLET) val $<; e=$$?; test $$e -eq 0 || test $$e -eq 127
+       $(XMLSTARLET) val NEWS.atom || \
+               { e=$$?; test $$e -eq 0 || test $$e -eq 127; }
 
 Documentation/%.html: Documentation/%.txt
        $(txt2pre)