[Olena-patches] [PATCH 2/4] Add a Make rule faking the regeneration of the documentation.

* doc/Makefile.am, * doc/ref_guide/Makefile.am, * doc/tutorial/Makefile.am, * doc/white_paper/Makefile.am (fake-doc, void-doc): New (phony) targets. --- milena/ChangeLog | 10 +++++++ milena/doc/Makefile.am | 50 ++++++++++++++++++++++++++++++++++++ milena/doc/ref_guide/Makefile.am | 14 ++++++++++ milena/doc/tutorial/Makefile.am | 14 ++++++++++ milena/doc/white_paper/Makefile.am | 15 +++++++++++ 5 files changed, 103 insertions(+), 0 deletions(-) diff --git a/milena/ChangeLog b/milena/ChangeLog index c4eaf15..00a7295 100644 --- a/milena/ChangeLog +++ b/milena/ChangeLog @@ -1,5 +1,15 @@ 2009-06-25 Roland Levillain &lt;roland(a)lrde.epita.fr&gt; + Add a Make rule faking the regeneration of the documentation. + + * doc/Makefile.am, + * doc/ref_guide/Makefile.am, + * doc/tutorial/Makefile.am, + * doc/white_paper/Makefile.am (fake-doc, void-doc): + New (phony) targets. + +2009-06-25 Roland Levillain &lt;roland(a)lrde.epita.fr&gt; + Improve build dependencies in doc/. * doc/Makefile.am ($(USER_REFMAN_PDF), $(USER_REFMAN_HTML)) diff --git a/milena/doc/Makefile.am b/milena/doc/Makefile.am index a7664ed..e9550b8 100644 --- a/milena/doc/Makefile.am +++ b/milena/doc/Makefile.am @@ -253,3 +253,53 @@ Doxyfile_devel: $(srcdir)/Doxyfile.in Doxyfile_devel_pdf: Doxyfile_devel $(edit_pdf) $< >$@ + + +#<<lrde +# Pretend the documentation is up-to-date. This is really useful for +# developers who want to check the distribution mechanism, for +# generating the Doxygen documentation make take up to 1 hour. +# +# A few remarks. Refreshing the contents of EXTRA_DIST using +# +# touch $(EXTRA_DIST) +# +# just does not work, as EXTRA_DIST lists source and built files +# (resp. in srcdir and buidldir). Cheat: go to srcdir and strip the +# srcdir prefix from path of every file listed in EXTRA_DIST. And we +# have to prune the built files (e.g. `Doxyfile_user_pdf'). +# +# We also selectively refresh files by hand in a certain order (some +# of them being already listed in EXTRA_DIST), to satisfy the +# dependencies. +.PHONY: fake-doc +fake-doc: + cd $(srcdir) \ + && touch `echo $(EXTRA_DIST) \ + | sed -e 's!$(srcdir)/!!g' \ + -e 's/Doxyfile_user_pdf//g' \ + -e 's/Doxyfile_user//g' ` + cd ref_guide && $(MAKE) $(AM_MAKEFLAGS) $@ + cd tutorial && $(MAKE) $(AM_MAKEFLAGS) $@ + cd white_paper && $(MAKE) $(AM_MAKEFLAGS) $@ + touch $(EXTRA_DEPS) + touch Doxyfile_devel + touch Doxyfile_devel_pdf + touch Doxyfile_user + touch Doxyfile_user_pdf + test -d user || mkdir user + if test -d $(USER_REFMAN_HTML); then \ + touch $(USER_REFMAN_HTML); \ + else \ + mkdir $(USER_REFMAN_HTML); \ + fi + touch $(USER_REFMAN_PDF) + +# The converse of the previous rule, voiding the timestamps. +.PHONY: void-doc +void-doc: + touch $(srcdir)/Doxyfile.in + cd ref_guide && $(MAKE) $(AM_MAKEFLAGS) $@ + cd tutorial && $(MAKE) $(AM_MAKEFLAGS) $@ + cd white_paper && $(MAKE) $(AM_MAKEFLAGS) $@ +#>> diff --git a/milena/doc/ref_guide/Makefile.am b/milena/doc/ref_guide/Makefile.am index 3ba3098..b6bb701 100644 --- a/milena/doc/ref_guide/Makefile.am +++ b/milena/doc/ref_guide/Makefile.am @@ -61,3 +61,17 @@ CLEANFILES = \ *.haux *.hh *.html *.htoc \ ref_guide.html \ $(REF_GUIDE_HH) + + +#<<lrde +# Pretend the documentation is up-to-date. +.PHONY: fake-doc +fake-doc: + touch $(REF_GUIDE_HH) + touch $(REF_GUIDE_PDF) + +# The converse of the previous rule, voiding the timestamps. +.PHONY: void-doc +void-doc: + touch $(srcdir)/ref_guide.tex +#>> diff --git a/milena/doc/tutorial/Makefile.am b/milena/doc/tutorial/Makefile.am index 17d8154..debd706 100644 --- a/milena/doc/tutorial/Makefile.am +++ b/milena/doc/tutorial/Makefile.am @@ -59,3 +59,17 @@ CLEANFILES = \ tutorial.haux \ tutorial.html \ $(TUTORIAL_HH) + + +#<<lrde +# Pretend the documentation is up-to-date. +.PHONY: fake-doc +fake-doc: + touch $(TUTORIAL_HH) + touch $(TUTORIAL_PDF) + +# The converse of the previous rule, voiding the timestamps. +.PHONY: void-doc +void-doc: + touch $(srcdir)/tutorial.tex +#>> diff --git a/milena/doc/white_paper/Makefile.am b/milena/doc/white_paper/Makefile.am index 322deb8..eeebc6f 100644 --- a/milena/doc/white_paper/Makefile.am +++ b/milena/doc/white_paper/Makefile.am @@ -69,3 +69,18 @@ CLEANFILES = \ white_paper.pdf \ *.log *.idx *.out *.aux \ figures + + +#<<lrde +# Pretend the documentation is up-to-date. +.PHONY: fake-doc +fake-doc: + touch $(EPSS) + touch $(WHITE_PAPER_HTML) + touch $(WHITE_PAPER_PDF) + +# The converse of the previous rule, voiding the timestamps. +.PHONY: void-doc +void-doc: + touch $(srcdir)/white_paper.tex +#>> -- 1.6.2.4