From: Pierre Habouzit Date: Sun, 11 Jan 2009 18:33:00 +0000 (+0100) Subject: Add some rules to deal with documentation generation. X-Git-Url: http://git.madism.org/?a=commitdiff_plain;ds=sidebyside;h=063d8a2ddca1e35efde7a3dec5eb04387dfb0922;p=apps%2Fpfixtools.git Add some rules to deal with documentation generation. Signed-off-by: Pierre Habouzit --- diff --git a/mk/asciidoc.conf b/mk/asciidoc.conf new file mode 100644 index 0000000..138604f --- /dev/null +++ b/mk/asciidoc.conf @@ -0,0 +1,51 @@ +## linkgit: macro +# +# Usage: linkgit:command[manpage-section] +# +# Note, {0} is the manpage section, while {target} is the command. +# +# Show GIT link as: (
); if section is defined, else just show +# the command. + +[macros] +(?su)[\\]?(?Plinkgit):(?P\S*?)\[(?P.*?)\]= + +[attributes] +asterisk=* +plus=+ +caret=^ +startsb=[ +endsb=] +tilde=~ + +ifdef::backend-docbook[] +[linkgit-inlinemacro] +{0%{target}} +{0#} +{0#{target}{0}} +{0#} +endif::backend-docbook[] + +ifdef::doctype-manpage[] +ifdef::backend-docbook[] +[header] +template::[header-declarations] + + +{mantitle} +{manvolnum} +Postfix Tools +{pft_version} +Postfix Tools Manual + + + {manname} + {manpurpose} + +endif::backend-docbook[] +endif::doctype-manpage[] + +ifdef::backend-xhtml11[] +[linkgit-inlinemacro] +{target}{0?({0})} +endif::backend-xhtml11[] diff --git a/mk/callouts.xsl b/mk/callouts.xsl new file mode 100644 index 0000000..6a361a2 --- /dev/null +++ b/mk/callouts.xsl @@ -0,0 +1,30 @@ + + + + + + + .sp + + + + + + + .br + + + + + + + + + + + + + + diff --git a/mk/common.mk b/mk/common.mk index a1b1412..058d21d 100644 --- a/mk/common.mk +++ b/mk/common.mk @@ -32,23 +32,45 @@ # see AUTHORS and source files for details # ############################################################################## +__DIR__:=$(realpath $(dir $(lastword $(MAKEFILE_LIST)))) + include ../mk/cflags.mk prefix ?= /usr/local LDFLAGSBASE += $(if $(DARWIN),-L/opt/local/lib,-Wl,-warn-common) CFLAGSBASE += --std=gnu99 -I../ -I../common $(if $(DARWIN),-I/opt/local/include,) +ASCIIDOC = asciidoc -f $(__DIR__)/asciidoc.conf -d manpage \ + -apft_version=$(shell git-describe) +XMLTO = xmlto -m $(__DIR__)/callouts.xsl +MAN_SECTIONS = 1 2 3 4 5 6 7 8 9 INSTALL_PROGS = $(addprefix install-,$(PROGRAMS)) -all: $(GENERATED) $(LIBS) $(PROGRAMS) | $(GENERATED) +all: $(GENERATED) $(LIBS) $(PROGRAMS) + +DOCS_SRC = $(foreach s,$(MAN_SECTIONS),$(patsubst %.$(s),%.txt,$(filter %.$(s),$(DOCS)))) +DOCS_HTML = $(DOCS_SRC:.txt=.html) +DOCS_XML = $(DOCS_SRC:.txt=.xml) +doc: $(DOCS) $(DOCS_HTML) -install: all $(INSTALL_PROGS) +install: all $(INSTALL_PROGS) install-doc + +install-doc: doc + $(if $(DOCS),\ + set -e\ + $(foreach s,$(MAN_SECTIONS),\ + $(foreach m,$(filter %.$(s),$(DOCS)),\ + ; install -d $(DESTDIR)$(prefix)/share/man/man$(s)/ \ + ; install $(m) $(DESTDIR)$(prefix)/share/man/man$(s)/ \ + ))) + $(if $(DOCS_HTML),install $(DOCS_HTML) $(DESTDIR)$(prefix)/share/doc/pfixtools) $(INSTALL_PROGS): install-%: install $* $(DESTDIR)$(prefix)/sbin clean: $(RM) $(LIBS:=.a) $(PROGRAMS) $(TESTS) .*.o .*.dep + $(RM) $(DOCS) $(DOCS_XML) $(DOCS_HTML) distclean: clean $(RM) $(GENERATED) @@ -77,6 +99,15 @@ headers: $(LIBS): %: %.a +$(DOCS_HTML): %.html: %.txt + $(ASCIIDOC) -b xhtml11 -o $@ $< + +$(DOCS_XML): %.xml: %.txt + $(ASCIIDOC) -b docbook -o $@ $< + +%.1 %.2 %.3 %.4 %.5 %.6 %.7 %.8 %.9: %.xml + $(XMLTO) man $< + .SECONDEXPANSION: $(LIBS:=.a): $$(patsubst %.c,.%.o,$$($$(patsubst %.a,%,$$@)_SOURCES)) Makefile @@ -86,6 +117,8 @@ $(LIBS:=.a): $$(patsubst %.c,.%.o,$$($$(patsubst %.a,%,$$@)_SOURCES)) Makefile $(PROGRAMS) $(TESTS): $$(patsubst %.c,.%.o,$$($$@_SOURCES)) Makefile $(CC) -o $@ $(filter %.o,$^) $(LDFLAGS) $($@_LIBADD) $(filter %.a,$^) +$(DOCS): + -include $(foreach p,$(PROGRAMS) $(TESTS),$(patsubst %.c,.%.dep,$(filter %.c,$($p_SOURCES)))) -.PHONY: install-dir $(INSTALL_PROGS) +.PHONY: install-doc install-dir $(INSTALL_PROGS)