From mboxrd@z Thu Jan 1 00:00:00 1970 Return-Path: X-Spam-Checker-Version: SpamAssassin 3.4.2 (2018-09-13) on dcvr.yhbt.net X-Spam-Level: X-Spam-ASN: X-Spam-Status: No, score=-4.0 required=3.0 tests=ALL_TRUSTED,BAYES_00 shortcircuit=no autolearn=ham autolearn_force=no version=3.4.2 Received: from localhost (dcvr.yhbt.net [127.0.0.1]) by dcvr.yhbt.net (Postfix) with ESMTP id 825721F4C0 for ; Tue, 15 Oct 2019 20:19:36 +0000 (UTC) From: Eric Wong To: meta@public-inbox.org Subject: [PATCH] doc: "check-man" target to ensure we stay <=80 cols Date: Tue, 15 Oct 2019 20:19:36 +0000 Message-Id: <20191015201936.31784-1-e@80x24.org> MIME-Version: 1.0 Content-Transfer-Encoding: 8bit List-Id: This should prevent future documentation changes from exceeding the limit of standard terminals. --- Documentation/include.mk | 18 +++++++++++++++++- 1 file changed, 17 insertions(+), 1 deletion(-) diff --git a/Documentation/include.mk b/Documentation/include.mk index 9fd85210..3a73ae84 100644 --- a/Documentation/include.mk +++ b/Documentation/include.mk @@ -10,6 +10,7 @@ RSYNC = rsync RSYNC_DEST = public-inbox.org:/srv/public-inbox/ MAN = man XMLSTARLET = xmlstarlet +AWK = awk # same as pod2text COLUMNS = 76 @@ -58,7 +59,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 +86,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)