From d9d2b1d50753b4e9e1c4c24efa1326e0deea6851 Mon Sep 17 00:00:00 2001 From: Virgil Date: Sun, 5 May 2019 13:52:59 +1000 Subject: [PATCH] :memo: add document attributes to manpages Use the document attribute options of `ronn`.. ```console Document attributes: --date= published date in YYYY-MM-DD format (bottom-center) --manual= name of the manual (top-center) --organization= publishing group or individual (bottom-left) ``` .. when generating the man pages. ```makefile ORG := bats-core MANUAL := 'Bash Automated Testing System' ISOFMT := $(shell date -I) $(RONN) --date=$(ISOFMT) --manual=$(MANUAL) --organization=$(ORG) --roff $< ``` --- man/Makefile | 19 ++++++++++++++++--- man/bats.1 | 2 +- man/bats.7 | 2 +- 3 files changed, 18 insertions(+), 5 deletions(-) diff --git a/man/Makefile b/man/Makefile index b3a44bdb..3b231ad8 100644 --- a/man/Makefile +++ b/man/Makefile @@ -1,10 +1,23 @@ -RONN := ronn +# Makefile +# +# bats-core manpages +# +RONN := ronn -W PAGES := bats.1 bats.7 +ORG := bats-core +MANUAL := 'Bash Automated Testing System' +ISOFMT := $(shell date -I) +RM := rm -f + +.PHONY: all clean all: $(PAGES) bats.1: bats.1.ronn - $(RONN) -r $< + $(RONN) --date=$(ISOFMT) --manual=$(MANUAL) --organization=$(ORG) --roff $< bats.7: bats.7.ronn - $(RONN) -r $< + $(RONN) --date=$(ISOFMT) --manual=$(MANUAL) --organization=$(ORG) --roff $< + +clean: + $(RM) $(PAGES) diff --git a/man/bats.1 b/man/bats.1 index 93fb42c8..66590177 100644 --- a/man/bats.1 +++ b/man/bats.1 @@ -1,7 +1,7 @@ .\" generated with Ronn/v0.7.3 .\" http://github.com/rtomayko/ronn/tree/0.7.3 . -.TH "BATS" "1" "July 2018" "" "" +.TH "BATS" "1" "May 2019" "bats-core" "Bash Automated Testing System" . .SH "NAME" \fBbats\fR \- Bash Automated Testing System diff --git a/man/bats.7 b/man/bats.7 index d0836e52..bd702c20 100644 --- a/man/bats.7 +++ b/man/bats.7 @@ -1,7 +1,7 @@ .\" generated with Ronn/v0.7.3 .\" http://github.com/rtomayko/ronn/tree/0.7.3 . -.TH "BATS" "7" "November 2013" "" "" +.TH "BATS" "7" "May 2019" "bats-core" "Bash Automated Testing System" . .SH "NAME" \fBbats\fR \- Bats test file format