diff options
| author |  Miek Gieben <miek@miek.nl>
| 2019-04-06 08:42:40 +0100 |
|---|---|---|
| committer |  GitHub <noreply@github.com>
| 2019-04-06 08:42:40 +0100 |
| commit | f8aa208cc00edf5ed231979210f8996bf318627d (patch) | |
| tree | 5b04d752f379c54226972070823301f114977c64 /Makefile.doc | |
| parent | 663271a7cab38e5c2505a1735c19f629f1889587 (diff) | |
| download | coredns-f8aa208cc00edf5ed231979210f8996bf318627d.tar.gz coredns-f8aa208cc00edf5ed231979210f8996bf318627d.tar.zst coredns-f8aa208cc00edf5ed231979210f8996bf318627d.zip | |
docs: Regenerate all manpages using mmark (#2762)
Mmark recently became able to create manual pages. This removed the
dependency on 'ronn' and just uses mmark (Go program).
Re-hookup Makefile.doc to generate the correct header mmark needs to
see and regenate them all.
Spot checking a few pages suggest they look good and actually better
than rendered with ronn, esp. lists in lists.
Fixes #2757
Signed-off-by: Miek Gieben <miek@miek.nl>
Diffstat (limited to 'Makefile.doc')
| -rw-r--r-- | Makefile.doc | 30 |
1 files changed, 16 insertions, 14 deletions
diff --git a/Makefile.doc b/Makefile.doc index dd2aac58f..cccbbd654 100644 --- a/Makefile.doc +++ b/Makefile.doc @@ -1,13 +1,12 @@ -ORG:=organization=CoreDNS -RONN:=ronn -r +MMARK:=mmark -man PLUGINS:=$(wildcard plugin/*/README.md) READMES:=$(subst plugin/,,$(PLUGINS)) READMES:=$(subst /README.md,,$(READMES)) PLUGINS:=$(subst plugin/,coredns-,$(PLUGINS)) PLUGINS:=$(subst /README.md,(7),$(PLUGINS)) -ifeq (, $(shell which ronn)) - $(warning "No ronn in $$PATH, exiting") +ifeq (, $(shell which mmark)) + $(warning "No mmark in $$PATH, exiting, see github.com/mmarkdown/mmark") all: @echo "noop" else @@ -15,15 +14,17 @@ all: man/coredns.1 man/corefile.5 plugins endif man/coredns.1: coredns.1.md - sed -e 's/^\(#.*\)/\U\1/' $< > $@.md - sed -i -e "s/@@PLUGINS@@/$(PLUGINS)/" $@.md - $(RONN) --$(ORG) --manual='CoreDNS' $@.md - rm $@.md + @/bin/echo -e '%%%\n title = "coredns 1"\n' \ + 'area = "CoreDNS"\n workgroup = "CoreDNS"\n%%%\n\n' > $@.header + @cat $@.header $< > $@.md && rm $@.header + @sed -i -e "s/@@PLUGINS@@/$(PLUGINS)/" $@.md + $(MMARK) $@.md > $@ && rm $@.md man/corefile.5: corefile.5.md - sed -e 's/^\(#.*\)/\U\1/' $< > $@.md - $(RONN) --$(ORG) --manual='CoreDNS' $@.md - rm $@.md + @/bin/echo -e '%%%\n title = "corefile 5"\n' \ + 'area = "CoreDNS"\n workgroup = "CoreDNS"\n%%%\n\n' > $@.header + @cat $@.header $< > $@.md && rm $@.header + $(MMARK) $@.md > $@ && rm $@.md .PHONY: plugins plugins: @@ -32,9 +33,10 @@ plugins: done man/coredns-%.7: plugin/%/README.md - sed -e 's/^\(#.*\)/\U\1/' $< > $@.md - $(RONN) --$(ORG) --manual='CoreDNS plugins' $@.md - rm $@.md + @/bin/echo -e "%%%\n title = \"`basename $@ | sed s\/\.7\/\/` 7\"\n" \ + 'area = "CoreDNS"\n workgroup = "CoreDNS Plugins"\n%%%\n\n' > $@.header + @cat $@.header $< > $@.md && rm $@.header + $(MMARK) $@.md > $@ && rm $@.md PHONY: clean clean: |