[Xenomai-git] Philippe Gerum : doc: add convenience rules for producing specific output
Module: xenomai-forge Branch: next Commit: 9cb5ab203e20960cf16824997c96b929e679e6a4 URL: http://git.xenomai.org/?p=xenomai-forge.git;a=commit;h=9cb5ab203e20960cf16824997c96b929e679e6a4 Author: Philippe Gerum Date: Thu Jun 12 09:29:34 2014 +0200 doc: add convenience rules for producing specific output >From the top Makefile: $ make doc/doxygen $ make doc/man $ make doc/asciidoc Respectively recurse in the doc/{doxygen, man, asciidoc} subdirs, invoking the default rule there. In addition: $ make doc/html $ make doc/pdf Recurse in the doc/{doxygen, man, asciidoc} subdirs, invoking the html or pdf rule there. In doc/doxygen/, this specifically rebuilds the online manual in HTML form, or as a PDF book. --- Makefile.am |5 + Makefile.in |5 + doc/Makefile.am |4 doc/Makefile.in |5 + doc/doxygen/Makefile.am | 11 ++- doc/doxygen/Makefile.in | 15 --- 6 files changed, 41 insertions(+), 4 deletions(-) diff --git a/Makefile.am b/Makefile.am index 35ec663..966b438 100644 --- a/Makefile.am +++ b/Makefile.am @@ -13,6 +13,11 @@ SUBDIRS =\ if XENO_RUN_DOC SUBDIRS += doc + +doc/%: FORCE + $(MAKE) -C doc/ $* + +.PHONY: FORCE endif EXTRA_DIST = kernel debian diff --git a/Makefile.in b/Makefile.in index 04c481d..ffe5913 100644 --- a/Makefile.in +++ b/Makefile.in @@ -829,6 +829,11 @@ uninstall-am: ps ps-am tags tags-am uninstall uninstall-am +@XENO_RUN_DOC_TRUE@doc/%: FORCE +@XENO_RUN_DOC_TRUE@$(MAKE) -C doc/ $* + +@XENO_RUN_DOC_TRUE@.PHONY: FORCE + dist-hook: rm -fr `find $(distdir) -name '.svn' -o -name CVS -o -name '.#*' \ -o -name '*~' -o -name autom4te.cache` diff --git a/doc/Makefile.am b/doc/Makefile.am index d54544d..36facf7 100644 --- a/doc/Makefile.am +++ b/doc/Makefile.am @@ -2,6 +2,9 @@ SUBDIRS=doxygen asciidoc man GENERATE_DOC=$(top_srcdir)/scripts/maint/generate-doc +doxygen asciidoc man: FORCE + $(MAKE) -C $@ + generate-doc: @if test \! -e $(GENERATE_DOC) -o \! -e $(top_srcdir)/.git ; then \ echo "$@ wants $top_srcdir to be a GIT working tree." ; \ @@ -9,3 +12,4 @@ generate-doc: srcdir=$(srcdir) $(GENERATE_DOC) ; \ fi +.PHONY: FORCE diff --git a/doc/Makefile.in b/doc/Makefile.in index ceb556e..aff385e 100644 --- a/doc/Makefile.in +++ b/doc/Makefile.in @@ -651,6 +651,9 @@ uninstall-am: ps ps-am tags tags-am uninstall uninstall-am +doxygen asciidoc man: FORCE + $(MAKE) -C $@ + generate-doc: @if test \! -e $(GENERATE_DOC) -o \! -e $(top_srcdir)/.git ; then \ echo "$@ wants $top_srcdir to be a GIT working tree." ; \ @@ -658,6 +661,8 @@ generate-doc: srcdir=$(srcdir) $(GENERATE_DOC) ; \ fi +.PHONY: FORCE + # Tell versions [3.59,3.63) of GNU make to not export all variables. # Otherwise a system limit (for SysV at least) may be exceeded. .NOEXPORT: diff --git a/doc/doxygen/Makefile.am b/doc/doxygen/Makefile.am index 5f4273c..5e2f286 100644 --- a/doc/doxygen/Makefile.am +++ b/doc/doxygen/Makefile.am @@ -5,11 +5,20 @@ EXTRA_DIST = manual-common.conf.in manual-html.conf.in manual-pdf.conf.in if !XENO_BUILD_DOC HTML_DOCSDIR = $(srcdir)/../generated/html/ PDF_DOCSDIR = $(srcdir)/../generated/pdf/ + +html pdf: + @echo "build tree not configured for regenerating documentation" + @echo "reconfigure with --enable-doc-build" + @/bin/false else HTML_DOCSDIR = ./ PDF_DOCSDIR = ./ -all-local: $(HTML_DOCS) $(PDF_DOCS) +all-local: html pdf + +html: $(HTML_DOCS) + +pdf: $(PDF_DOCS) manual-html: $(DOXYGEN) $@.conf diff --git a/doc/doxygen/Makefile.in b/doc/doxygen/Makefile.in index a073479..ef51034 100644 --- a/doc/doxygen/Makefile.in +++ b/doc/doxygen/Makefile.in @@ -438,7 +438,7 @@ dvi: dvi-am dvi-am: -html: html-am +@XENO_BUILD_DOC_FALSE@html: html-am html-am: @@ -482,7 +482,7 @@ mostlyclean: mostlyclean-am mostlyclean-am: mostlyclean-generic mostlyclean-libtool -pdf: pdf-am +@XENO_BUILD_DOC_FALSE@pdf: pdf-am pdf-am: @@ -508,7 +508,16 @@ uninstall-am: uninstall-local tags-am uninstall uninstall-am uninstall-local -@XENO_BUILD_DOC_TRUE@all-local: $(HTML_DOCS) $(PDF_DOCS) +@XENO_BUILD_DOC_FALSE@html pdf: +@XENO_BUILD_DOC_FALSE@ @echo "build tree not configured for regenerating documentation" +@XENO_BUILD_DOC_FALSE@ @echo "reconfigure with --enable-doc-build" +@XENO_BUILD_DOC_FALSE@ @/bin/false + +@XENO_BUILD_DOC_TRUE@all-local: html pdf + +@XENO_BUILD_DOC_TRUE@html: $(HTML_DOCS) + +@XENO_BUILD_DOC_TRUE@pdf: $(PDF_DOCS) @XENO_BUILD_DOC_TRUE@manual-html: @XENO_BUILD_DOC_TRUE@ $(DOXYGEN) $@.conf ___ Xenomai-git mailing list Xenomai-git@xenomai.org http://www.xenomai.org/mailman/listinfo/xenomai-git
[Xenomai-git] Philippe Gerum : doc: add convenience rules for producing specific output
Module: xenomai-forge Branch: next Commit: 3194ba3c83c034ef9b738b3086e64280eeb0e400 URL: http://git.xenomai.org/?p=xenomai-forge.git;a=commit;h=3194ba3c83c034ef9b738b3086e64280eeb0e400 Author: Philippe Gerum Date: Thu Jun 12 09:29:34 2014 +0200 doc: add convenience rules for producing specific output >From the top Makefile: $ make doc/doxygen $ make doc/man $ make doc/asciidoc Respectively recurse in the doc/{doxygen, man, asciidoc} subdirs, invoking the default rule there. In addition: $ make doc/html $ make doc/pdf Recurse in the doc/{doxygen, man, asciidoc} subdirs, invoking the html or pdf rule there. In doc/doxygen/, this specifically rebuilds the online manual in HTML form, or as a PDF book. --- Makefile.am |5 + Makefile.in |5 + doc/Makefile.am |4 doc/Makefile.in |5 + doc/doxygen/Makefile.am | 11 ++- doc/doxygen/Makefile.in | 15 --- 6 files changed, 41 insertions(+), 4 deletions(-) diff --git a/Makefile.am b/Makefile.am index 35ec663..966b438 100644 --- a/Makefile.am +++ b/Makefile.am @@ -13,6 +13,11 @@ SUBDIRS =\ if XENO_RUN_DOC SUBDIRS += doc + +doc/%: FORCE + $(MAKE) -C doc/ $* + +.PHONY: FORCE endif EXTRA_DIST = kernel debian diff --git a/Makefile.in b/Makefile.in index 04c481d..ffe5913 100644 --- a/Makefile.in +++ b/Makefile.in @@ -829,6 +829,11 @@ uninstall-am: ps ps-am tags tags-am uninstall uninstall-am +@XENO_RUN_DOC_TRUE@doc/%: FORCE +@XENO_RUN_DOC_TRUE@$(MAKE) -C doc/ $* + +@XENO_RUN_DOC_TRUE@.PHONY: FORCE + dist-hook: rm -fr `find $(distdir) -name '.svn' -o -name CVS -o -name '.#*' \ -o -name '*~' -o -name autom4te.cache` diff --git a/doc/Makefile.am b/doc/Makefile.am index d54544d..36facf7 100644 --- a/doc/Makefile.am +++ b/doc/Makefile.am @@ -2,6 +2,9 @@ SUBDIRS=doxygen asciidoc man GENERATE_DOC=$(top_srcdir)/scripts/maint/generate-doc +doxygen asciidoc man: FORCE + $(MAKE) -C $@ + generate-doc: @if test \! -e $(GENERATE_DOC) -o \! -e $(top_srcdir)/.git ; then \ echo "$@ wants $top_srcdir to be a GIT working tree." ; \ @@ -9,3 +12,4 @@ generate-doc: srcdir=$(srcdir) $(GENERATE_DOC) ; \ fi +.PHONY: FORCE diff --git a/doc/Makefile.in b/doc/Makefile.in index ceb556e..aff385e 100644 --- a/doc/Makefile.in +++ b/doc/Makefile.in @@ -651,6 +651,9 @@ uninstall-am: ps ps-am tags tags-am uninstall uninstall-am +doxygen asciidoc man: FORCE + $(MAKE) -C $@ + generate-doc: @if test \! -e $(GENERATE_DOC) -o \! -e $(top_srcdir)/.git ; then \ echo "$@ wants $top_srcdir to be a GIT working tree." ; \ @@ -658,6 +661,8 @@ generate-doc: srcdir=$(srcdir) $(GENERATE_DOC) ; \ fi +.PHONY: FORCE + # Tell versions [3.59,3.63) of GNU make to not export all variables. # Otherwise a system limit (for SysV at least) may be exceeded. .NOEXPORT: diff --git a/doc/doxygen/Makefile.am b/doc/doxygen/Makefile.am index 5f4273c..5e2f286 100644 --- a/doc/doxygen/Makefile.am +++ b/doc/doxygen/Makefile.am @@ -5,11 +5,20 @@ EXTRA_DIST = manual-common.conf.in manual-html.conf.in manual-pdf.conf.in if !XENO_BUILD_DOC HTML_DOCSDIR = $(srcdir)/../generated/html/ PDF_DOCSDIR = $(srcdir)/../generated/pdf/ + +html pdf: + @echo "build tree not configured for regenerating documentation" + @echo "reconfigure with --enable-doc-build" + @/bin/false else HTML_DOCSDIR = ./ PDF_DOCSDIR = ./ -all-local: $(HTML_DOCS) $(PDF_DOCS) +all-local: html pdf + +html: $(HTML_DOCS) + +pdf: $(PDF_DOCS) manual-html: $(DOXYGEN) $@.conf diff --git a/doc/doxygen/Makefile.in b/doc/doxygen/Makefile.in index a073479..ef51034 100644 --- a/doc/doxygen/Makefile.in +++ b/doc/doxygen/Makefile.in @@ -438,7 +438,7 @@ dvi: dvi-am dvi-am: -html: html-am +@XENO_BUILD_DOC_FALSE@html: html-am html-am: @@ -482,7 +482,7 @@ mostlyclean: mostlyclean-am mostlyclean-am: mostlyclean-generic mostlyclean-libtool -pdf: pdf-am +@XENO_BUILD_DOC_FALSE@pdf: pdf-am pdf-am: @@ -508,7 +508,16 @@ uninstall-am: uninstall-local tags-am uninstall uninstall-am uninstall-local -@XENO_BUILD_DOC_TRUE@all-local: $(HTML_DOCS) $(PDF_DOCS) +@XENO_BUILD_DOC_FALSE@html pdf: +@XENO_BUILD_DOC_FALSE@ @echo "build tree not configured for regenerating documentation" +@XENO_BUILD_DOC_FALSE@ @echo "reconfigure with --enable-doc-build" +@XENO_BUILD_DOC_FALSE@ @/bin/false + +@XENO_BUILD_DOC_TRUE@all-local: html pdf + +@XENO_BUILD_DOC_TRUE@html: $(HTML_DOCS) + +@XENO_BUILD_DOC_TRUE@pdf: $(PDF_DOCS) @XENO_BUILD_DOC_TRUE@manual-html: @XENO_BUILD_DOC_TRUE@ $(DOXYGEN) $@.conf ___ Xenomai-git mailing list Xenomai-git@xenomai.org http://www.xenomai.org/mailman/listinfo/xenomai-git