Skip to content

Commit

Permalink
📝 add document attributes to manpages
Browse files Browse the repository at this point in the history
Use the document attribute options of `ronn`..

```console
Document attributes:
      --date=<date>          published date in YYYY-MM-DD format (bottom-center)
      --manual=<name>        name of the manual (top-center)
      --organization=<name>  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 $<
```
  • Loading branch information
virgilwashere committed May 5, 2019
1 parent 8789f91 commit d9d2b1d
Show file tree
Hide file tree
Showing 3 changed files with 18 additions and 5 deletions.
19 changes: 16 additions & 3 deletions man/Makefile
Original file line number Diff line number Diff line change
@@ -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)
2 changes: 1 addition & 1 deletion man/bats.1
Original file line number Diff line number Diff line change
@@ -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
Expand Down
2 changes: 1 addition & 1 deletion man/bats.7
Original file line number Diff line number Diff line change
@@ -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
Expand Down

0 comments on commit d9d2b1d

Please sign in to comment.