mirror of
https://github.com/coredns/coredns.git
synced 2025-10-27 00:04:15 -04:00
Manual pages (#1346)
* Add manual pages Generate manual pages from the README and extend README with Name and Description sections. The generation requires 'ronn' which may not be available. Just check in all generated manual pages.
This commit is contained in:
30
Makefile.doc
Normal file
30
Makefile.doc
Normal file
@@ -0,0 +1,30 @@
|
||||
ORG:=organization=CoreDNS
|
||||
RONN:=ronn -r
|
||||
PLUGINS:=$(wildcard plugin/*/README.md)
|
||||
READMES:=$(subst plugin/,,$(PLUGINS))
|
||||
READMES:=$(subst /README.md,,$(READMES))
|
||||
PLUGINS:=$(subst plugin/,corendns-,$(PLUGINS))
|
||||
PLUGINS:=$(subst /README.md,(7),$(PLUGINS))
|
||||
|
||||
all: man/coredns.1 plugins
|
||||
|
||||
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
|
||||
|
||||
.PHONY: plugins
|
||||
plugins:
|
||||
for README in $(READMES); do \
|
||||
$(MAKE) -f Makefile.doc man/coredns-$$README.7; \
|
||||
done
|
||||
|
||||
man/coredns-%.7: plugin/%/README.md
|
||||
sed -e 's/^\(#.*\)/\U\1/' $< > $@.md
|
||||
$(RONN) --$(ORG) --manual='CoreDNS plugins' $@.md
|
||||
rm $@.md
|
||||
|
||||
PHONY: clean
|
||||
clean:
|
||||
rm -f man/*
|
||||
Reference in New Issue
Block a user