Olena-patches April 2010

olena-patches@lrde.epita.fr

5 participants
182 discussions

last-svn-commit-28-g2e5cd09 Generate the HTML and LaTeX Doxygen documentation in a single pass.

by Roland Levillain

* doc/Doxyfile.in (GENERATE_LATEX): Enable. (EXCLUDE): Adjust. * doc/Makefile.am (ref-doc-html, ref-doc-devel-html): Remove (phony) targets. (ref-doc, ref-doc-devel): New (phony) targets. (doc-html, doc-devel-html): Adjust targets. (DOXYFILE_USER_PDF, DOXYFILE_USER_HTML) (DOXYFILE_DEVEL_PDF, DOXYFILE_DEVEL_HTML): Remove variables. (DOXYFILE_USER_PDF, DOXYFILE_DEVEL): New variables. (USER_REFMAN_LATEX, USER_REFMAN_HTML) (DEVEL_REFMAN_LATEX, DEVEL_REFMAN_HTML): Remove variables. (USER_REFMAN): New variable. (all-local): Adjust. ($(srcdir)/user-refman-latex.stamp) ($(srcdir)/$(USER_REFMAN_LATEX)) ($(srcdir)/user-refman-html.stamp) ($(srcdir)/$(USER_REFMAN_HTML)) ($(srcdir)/devel-refman-latex.stamp) ($(srcdir)/$(DEVEL_REFMAN_LATEX)) ($(srcdir)/devel-refman-html.stamp) ($(srcdir)/$(DEVEL_REFMAN_HTML)): Remove targets. ($(srcdir)/user-refman.stamp) ($(srcdir)/$(USER_REFMAN)) ($(srcdir)/devel-refman.stamp) ($(srcdir)/$(DEVEL_REFMAN)): New targets. ($(srcdir)/$(USER_REFMAN_PDF), $(srcdir)/$(DEVEL_REFMAN_PDF)): Adjust targets. (regen-doc, regen-devel-doc): New (phony) targets. (clean-user-refman-latex, clean-user-refman-html) (clean-devel-refman-latex, clean-devel-refman-html): Remove (phony) targets. (maintainer-clean-local): Adjust. (edit_pdf): Remove variable. (EXTRA_DIST): Remove $(USER_REFMAN_HTML). Add $(USER_REFMAN)/html. (install-data-local, uninstall-local): Adjust. (CLEANFILES): Remove Doxyfile_user, Doxyfile_user_pdf, Doxyfile_devel, Doxyfile_devel_pdf, devel and user. (MAINTAINERCLEANFILES): Add Doxyfile_user and Doxyfile_devel. ($(DOXYFILE_USER_PDF), $(DOXYFILE_USER_HTML)) ($(DOXYFILE_DEVEL_PDF), $(DOXYFILE_DEVEL_HTML)): Remove targets. ($(DOXYFILE_USER), $(DOXYFILE_DEVEL)): New targets. --- milena/ChangeLog | 56 +++++++++ milena/doc/.gitignore | 8 +- milena/doc/Doxyfile.in | 8 +- milena/doc/Makefile.am | 322 +++++++++++++++++------------------------------- 4 files changed, 176 insertions(+), 218 deletions(-) diff --git a/milena/ChangeLog b/milena/ChangeLog index b32170e..00c949c 100644 --- a/milena/ChangeLog +++ b/milena/ChangeLog @@ -1,5 +1,61 @@ 2010-03-08 Roland Levillain <roland(a)lrde.epita.fr> + Generate the HTML and LaTeX Doxygen documentation in a single pass. + + * doc/Doxyfile.in (GENERATE_LATEX): Enable. + (EXCLUDE): Adjust. + * doc/Makefile.am (ref-doc-html, ref-doc-devel-html): + Remove (phony) targets. + (ref-doc, ref-doc-devel): + New (phony) targets. + (doc-html, doc-devel-html): + Adjust targets. + (DOXYFILE_USER_PDF, DOXYFILE_USER_HTML) + (DOXYFILE_DEVEL_PDF, DOXYFILE_DEVEL_HTML): + Remove variables. + (DOXYFILE_USER_PDF, DOXYFILE_DEVEL): + New variables. + (USER_REFMAN_LATEX, USER_REFMAN_HTML) + (DEVEL_REFMAN_LATEX, DEVEL_REFMAN_HTML): + Remove variables. + (USER_REFMAN): New variable. + (all-local): Adjust. + ($(srcdir)/user-refman-latex.stamp) + ($(srcdir)/$(USER_REFMAN_LATEX)) + ($(srcdir)/user-refman-html.stamp) + ($(srcdir)/$(USER_REFMAN_HTML)) + ($(srcdir)/devel-refman-latex.stamp) + ($(srcdir)/$(DEVEL_REFMAN_LATEX)) + ($(srcdir)/devel-refman-html.stamp) + ($(srcdir)/$(DEVEL_REFMAN_HTML)): + Remove targets. + ($(srcdir)/user-refman.stamp) + ($(srcdir)/$(USER_REFMAN)) + ($(srcdir)/devel-refman.stamp) + ($(srcdir)/$(DEVEL_REFMAN)): + New targets. + ($(srcdir)/$(USER_REFMAN_PDF), $(srcdir)/$(DEVEL_REFMAN_PDF)): + Adjust targets. + (regen-doc, regen-devel-doc): New (phony) targets. + (clean-user-refman-latex, clean-user-refman-html) + (clean-devel-refman-latex, clean-devel-refman-html): + Remove (phony) targets. + (maintainer-clean-local): Adjust. + (edit_pdf): Remove variable. + (EXTRA_DIST): Remove $(USER_REFMAN_HTML). + Add $(USER_REFMAN)/html. + (install-data-local, uninstall-local): Adjust. + (CLEANFILES): Remove Doxyfile_user, Doxyfile_user_pdf, + Doxyfile_devel, Doxyfile_devel_pdf, devel and user. + (MAINTAINERCLEANFILES): Add Doxyfile_user and Doxyfile_devel. + ($(DOXYFILE_USER_PDF), $(DOXYFILE_USER_HTML)) + ($(DOXYFILE_DEVEL_PDF), $(DOXYFILE_DEVEL_HTML)): + Remove targets. + ($(DOXYFILE_USER), $(DOXYFILE_DEVEL)): + New targets. + +2010-03-08 Roland Levillain <roland(a)lrde.epita.fr> + Shorten the list of files visited by Doxygen. * doc/Doxyfile.in (STRIP_FROM_PATH, INPUT, IMAGE_PATH): diff --git a/milena/doc/.gitignore b/milena/doc/.gitignore index 8670dd7..4b96d25 100644 --- a/milena/doc/.gitignore +++ b/milena/doc/.gitignore @@ -1,9 +1,11 @@ /Doxyfile_devel -/Doxyfile_devel_pdf /Doxyfile_user -/Doxyfile_user_pdf /devel +/devel-refman +/devel-refman.pdf /user +/user-refman +/user-refman.pdf /figures/*.png /ref_guide/ref_guide.haux /ref_guide/ref_guide.hh @@ -21,8 +23,6 @@ /tutorial/tutorial.hh-e /tutorial/tutorial.html /tutorial/tutorial.pdf -/user-refman-html -/user-refman.pdf /white_paper/figures/house.eps /white_paper/figures/house_rag.eps /white_paper/figures/house_wshed.eps diff --git a/milena/doc/Doxyfile.in b/milena/doc/Doxyfile.in index e8f06cb..505480a 100644 --- a/milena/doc/Doxyfile.in +++ b/milena/doc/Doxyfile.in @@ -102,11 +102,9 @@ EXCLUDE = @top_srcdir@/milena/sandbox \ @top_srcdir@/milena/mln/core/concept/proxy.hxx \ @top_srcdir@/milena/doc/examples/trash \ @top_srcdir@/milena/doc/user \ - @top_srcdir@/milena/doc/user-refman-html \ - @top_srcdir@/milena/doc/user-refman-latex \ + @top_srcdir@/milena/doc/user-refman @top_srcdir@/milena/doc/devel \ - @top_srcdir@/milena/doc/devel-refman-html \ - @top_srcdir@/milena/doc/devel-refman-latex \ + @top_srcdir@/milena/doc/devel-refman @top_srcdir@/milena/tests/unit_test EXCLUDE_SYMLINKS = YES EXCLUDE_PATTERNS = *spe.hh @@ -167,7 +165,7 @@ TREEVIEW_WIDTH = 250 #--------------------------------------------------------------------------- # configuration options related to the LaTeX output #--------------------------------------------------------------------------- -GENERATE_LATEX = NO +GENERATE_LATEX = YES LATEX_OUTPUT = latex LATEX_CMD_NAME = latex MAKEINDEX_CMD_NAME = makeindex diff --git a/milena/doc/Makefile.am b/milena/doc/Makefile.am index 3d5f4d9..b37044f 100644 --- a/milena/doc/Makefile.am +++ b/milena/doc/Makefile.am @@ -35,8 +35,8 @@ CLEANFILES = .PHONY: doc \ doc-user doc-devel \ doc-pdf doc-html doc-devel-pdf doc-devel-html \ - ref-doc-pdf ref-doc-html \ - ref-doc-devel-pdf ref-doc-devel-html + ref-doc ref-doc-pdf \ + ref-doc-devel ref-doc-devel-pdf doc: doc-user doc-devel @@ -45,12 +45,12 @@ doc-devel: doc-devel-pdf doc-devel-html doc-pdf: tutorial-pdf white-paper-pdf ref-guide-pdf ref-doc-pdf -doc-html: tutorial-html white-paper-html ref-guide-html ref-doc-html +doc-html: tutorial-html white-paper-html ref-guide-html ref-doc doc-devel-pdf: tutorial-pdf ref-guide-pdf white-paper-pdf ref-doc-devel-pdf doc-devel-html: tutorial-html ref-guide-html white-paper-html \ - ref-doc-devel-html + ref-doc-devel ## -------------------------------------------------- ## @@ -65,204 +65,127 @@ EXTRA_DEPS = $(srcdir)/tutorial/tutorial.hh $(srcdir)/ref_guide/ref_guide.hh ## Doxygen documentation. ## ## ----------------------- ## -## FIXME: We should use a stamp file and generate the documentation in -## a temporary directory in the _build_ tree, then copy it into a -## directory of the _source_ tree. See how this is implemented in -## Vaucanson's doc build system. (Do not forget to adjust Doxyfiles.) +# ----------------------- # +# User reference manual. # +# ----------------------- # -# ----------------------------- # -# User reference manual (PDF). # -# ----------------------------- # +all-local: $(srcdir)/$(USER_REFMAN) $(srcdir)/$(USER_REFMAN_PDF) -# FIXME: Keep it or throw it away? -all-local: $(srcdir)/$(USER_REFMAN_PDF) +# Run "make regen-doc" to forcefully rebuild the Doxygen documentation. +.PHONY: regen-doc +regen-doc: + -rm -f $(srcdir)/user-refman.stamp + $(MAKE) $(AM_MAKEFLAGS) $(srcdir)/user-refman.stamp -DOXYFILE_USER_PDF = Doxyfile_user_pdf +DOXYFILE_USER = Doxyfile_user ## FIXME: Rename USER_REFMAN_PDF to something else? USER_REFMAN_PDF = user-refman.pdf ## FIXME: Likewise? -USER_REFMAN_LATEX = user-refman-latex +USER_REFMAN = user-refman ref-doc-pdf: $(srcdir)/$(USER_REFMAN_PDF) +ref-doc: $(srcdir)/$(USER_REFMAN) # FIXME: Use texi2dvi instead of Doxygen's generated Makefile? # (The LaTeX to PDF rule could be factored using a suffix rule, as in # LRDE's share/). -$(srcdir)/$(USER_REFMAN_PDF): $(srcdir)/$(USER_REFMAN_LATEX) - cd $(srcdir)/$(USER_REFMAN_LATEX) && $(MAKE) $(AM_MAKEFLAGS) pdf - cp -f $(srcdir)/$(USER_REFMAN_LATEX)/refman.pdf $@ +$(srcdir)/$(USER_REFMAN_PDF): $(srcdir)/$(USER_REFMAN) + cd $(srcdir)/$(USER_REFMAN)/latex && $(MAKE) $(AM_MAKEFLAGS) pdf + cp -f $(srcdir)/$(USER_REFMAN)/latex/refman.pdf $@ -## FIXME: Use a variable instead of `$(srcdir)/user/latex'. +## FIXME: Use a variable instead of `$(srcdir)/user' directly? ## ## FIXME: Are dependencies $(srcdir)/figures.stamp $(EXTRA_DEPS) set ## on the right rule? Does Doxygen make a copy of figures, or does it ## generate LaTeX inputs relying on the existence of such figures in ## the initial location? Investigate. -$(srcdir)/user-refman-latex.stamp: $(srcdir)/$(DOXYFILE).in $(srcdir)/figures.stamp $(EXTRA_DEPS) +$(srcdir)/user-refman.stamp: $(srcdir)/$(DOXYFILE).in $(srcdir)/figures.stamp $(EXTRA_DEPS) @rm -f $@.tmp @touch $@.tmp - -rm -rf $(srcdir)/user/latex - $(MAKE) $(AM_MAKE_FLAGS) $(DOXYFILE_USER_PDF) - $(DOXYGEN) $(DOXYFILE_USER_PDF) + -rm -rf $(srcdir)/user + $(MAKE) $(AM_MAKE_FLAGS) $(DOXYFILE_USER) + $(DOXYGEN) $(DOXYFILE_USER) ## Doxygen may generate an incomplete output and exit with success! ## Check some files before deeming the output as acceptable. test -f $(srcdir)/user/latex/refman.tex - -rm -rf $(srcdir)/$(USER_REFMAN_LATEX) -## FIXME: moving directories between file systems is not portable. - mv $(srcdir)/user/latex $(srcdir)/$(USER_REFMAN_LATEX) + -rm -rf $(srcdir)/$(USER_REFMAN) +## FIXME: Moving directories between file systems is not portable. + mv $(srcdir)/user $(srcdir)/$(USER_REFMAN) @mv -f $@.tmp $@ -# FIXME: Probably superfluous. Should vanish when HTML and LaTeX -# genarations are merged. -$(srcdir)/$(USER_REFMAN_LATEX): $(srcdir)/user-refman-latex.stamp +$(srcdir)/$(USER_REFMAN): $(srcdir)/user-refman.stamp ## Recover from the removal of $@ @if test -d $@; then :; else \ rm -f $<; \ $(MAKE) $(AM_MAKEFLAGS) $<; \ fi -# Clean Doxygen products. -.PHONY: clean-user-refman-latex -clean-user-refman-latex: - rm -rf $(srcdir)/user/latex $(srcdir)/$(USER_REFMAN_LATEX) - -# ------------------------------ # -# User reference manual (HTML). # -# ------------------------------ # - -# FIXME: Keep it or throw it away? -all-local: $(srcdir)/user-refman-html.stamp - -# FIXME: Rename USER_REFMAN_HTML as DOCDIR_USER_HTML? -USER_REFMAN_HTML = user-refman-html +# ---------------------------- # +# Developer reference manual. # +# ---------------------------- # -DOXYFILE_USER_HTML = Doxyfile_user_html +# Run "make regen-devel-doc" to forcefully rebuild the Doxygen +# developer documentation. +.PHONY: regen-devel-doc +regen-devel-doc: + -rm -f $(srcdir)/devel-refman.stamp + $(MAKE) $(AM_MAKEFLAGS) $(srcdir)/devel-refman.stamp -ref-doc-html: $(srcdir)/$(USER_REFMAN_HTML) - -# FIXME: Use `$(USER_REFMAN_HTML).tmp' instead of `$(srcdir)/user/html'. -$(srcdir)/user-refman-html.stamp: $(srcdir)/$(DOXYFILE).in $(srcdir)/figures.stamp $(EXTRA_DEPS) - @rm -f $@.tmp - @touch $@.tmp - -rm -rf $(srcdir)/user/html - $(MAKE) $(AM_MAKE_FLAGS) $(DOXYFILE_USER_HTML) - $(DOXYGEN) $(DOXYFILE_USER_HTML) - -rm -rf $(srcdir)/$(USER_REFMAN_HTML) -## FIXME: moving directories between file systems is not portable. - mv $(srcdir)/user/html $(srcdir)/$(USER_REFMAN_HTML) - @mv -f $@.tmp $@ - -$(srcdir)/$(USER_REFMAN_HTML): $(srcdir)/user-refman-html.stamp -## Recover from the removal of $@ - @if test -d $@; then :; else \ - rm -f $<; \ - $(MAKE) $(AM_MAKEFLAGS) $<; \ - fi - -# Clean Doxygen products. -.PHONY: clean-user-refman-html -clean-user-refman-html: - rm -rf $(srcdir)/user/html $(srcdir)/$(USER_REFMAN_HTML) - -# ---------------------------------- # -# Developer reference manual (PDF). # -# ---------------------------------- # - -DOXYFILE_DEVEL_PDF = Doxyfile_devel_pdf +DOXYFILE_DEVEL = Doxyfile_devel ## FIXME: Rename DEVEL_REFMAN_PDF to something else? DEVEL_REFMAN_PDF = devel-refman-pdf ## FIXME: Likewise? -DEVEL_REFMAN_LATEX = devel-refman-latex +DEVEL_REFMAN = devel-refman ref-doc-devel-pdf: $(srcdir)/$(DEVEL_REFMAN_PDF) +ref-doc-devel: $(srcdir)/$(DEVEL_REFMAN) +# Be warned, most LaTeX installations will not be able to compile the +# PDF development documentation as-is, as TeX's default memory +# capacities are usually too small to handle such a large document. +# ## FIXME: Use texi2dvi instead of Doxygen's generated Makefile? (The ## LaTeX to PDF rule could be factored using a suffix rule, as in ## LRDE's share/). -$(srcdir)/$(DEVEL_REFMAN_PDF): $(srcdir)/$(DEVEL_REFMAN_LATEX) - cd $(srcdir)/$(DEVEL_REFMAN_LATEX) && $(MAKE) $(AM_MAKEFLAGS) pdf - cp -f $(srcdir)/$(DEVEL_REFMAN_LATEX)/refman.pdf $@ +$(srcdir)/$(DEVEL_REFMAN_PDF): $(srcdir)/$(DEVEL_REFMAN) + cd $(srcdir)/$(DEVEL_REFMAN)/latex && $(MAKE) $(AM_MAKEFLAGS) pdf + cp -f $(srcdir)/$(DEVEL_REFMAN)/latex/refman.pdf $@ -## FIXME: Use a variable instead of `$(srcdir)/devel/latex'. +## FIXME: Use a variable instead of `$(srcdir)/devel' directly? ## ## FIXME: Are dependencies $(srcdir)/figures.stamp $(EXTRA_DEPS) set ## on the right rule? Does Doxygen make a copy of figures, or does it ## generate LaTeX inputs relying on the existence of such figures in ## the initial location? Investigate. -$(srcdir)/devel-refman-latex.stamp: $(srcdir)/$(DOXYFILE).in $(srcdir)/figures.stamp $(EXTRA_DEPS) +$(srcdir)/devel-refman.stamp: $(srcdir)/$(DOXYFILE).in $(srcdir)/figures.stamp $(EXTRA_DEPS) @rm -f $@.tmp @touch $@.tmp - -rm -rf $(srcdir)/devel/latex - $(MAKE) $(AM_MAKE_FLAGS) $(DOXYFILE_DEVEL_PDF) - $(DOXYGEN) $(DOXYFILE_DEVEL_PDF) + -rm -rf $(srcdir)/devel + $(MAKE) $(AM_MAKE_FLAGS) $(DOXYFILE_DEVEL) + $(DOXYGEN) $(DOXYFILE_DEVEL) ## Doxygen may generate an incomplete output and exit with success! ## Check some files before deeming the output as acceptable. test -f $(srcdir)/devel/latex/refman.tex - -rm -rf $(srcdir)/$(DEVEL_REFMAN_LATEX) -## FIXME: moving directories between file systems is not portable. - mv $(srcdir)/devel/latex $(srcdir)/$(DEVEL_REFMAN_LATEX) + -rm -rf $(srcdir)/$(DEVEL_REFMAN) +## FIXME: Moving directories between file systems is not portable. + mv $(srcdir)/devel $(srcdir)/$(DEVEL_REFMAN) @mv -f $@.tmp $@ -# FIXME: Probably superfluous. Should vanish when HTML and LaTeX -# genarations are merged. -$(srcdir)/$(DEVEL_REFMAN_LATEX): $(srcdir)/devel-refman-latex.stamp +$(srcdir)/$(DEVEL_REFMAN): $(srcdir)/devel-refman.stamp ## Recover from the removal of $@ @if test -d $@; then :; else \ rm -f $<; \ $(MAKE) $(AM_MAKEFLAGS) $<; \ fi -# Clean Doxygen products. -.PHONY: clean-devel-refman-latex -clean-devel-refman-latex: - rm -rf $(srcdir)/devel/latex $(srcdir)/$(DEVEL_REFMAN_LATEX) - -# ----------------------------------- # -# Developer reference manual (HTML). # -# ----------------------------------- # - -# FIXME: Rename DEVEL_REFMAN_HTML as DOCDIR_DEVEL_HTML? -DEVEL_REFMAN_HTML = devel-refman-html - -DOXYFILE_DEVEL_HTML = Doxyfile_devel_html - -ref-doc-devel-html: $(srcdir)/$(DEVEL_REFMAN_HTML) - -# FIXME: Use `$(DEVEL_REFMAN_HTML).tmp' instead of `$(srcdir)/devel/html'. -$(srcdir)/devel-refman-html.stamp: $(srcdir)/$(DOXYFILE).in $(srcdir)/figures.stamp $(EXTRA_DEPS) - @rm -f $@.tmp - @touch $@.tmp - -rm -rf $(srcdir)/devel/html - $(MAKE) $(AM_MAKE_FLAGS) $(DOXYFILE_DEVEL_HTML) - $(DOXYGEN) $(DOXYFILE_DEVEL_HTML) - -rm -rf $(srcdir)/$(DEVEL_REFMAN_HTML) -## FIXME: moving directories between file systems is not portable. - mv $(srcdir)/devel/html $(srcdir)/$(DEVEL_REFMAN_HTML) - @mv -f $@.tmp $@ - -$(srcdir)/$(DEVEL_REFMAN_HTML): $(srcdir)/devel-refman-html.stamp -## Recover from the removal of $@ - @if test -d $@; then :; else \ - rm -f $<; \ - $(MAKE) $(AM_MAKEFLAGS) $<; \ - fi # Clean Doxygen products. -.PHONY: clean-devel-refman-html -clean-devel-refman-html: - rm -rf $(srcdir)/devel/html $(srcdir)/$(DEVEL_REFMAN_HTML) - -# ---------- # -# Cleaning. # -# ---------- # - -maintainer-clean-local: clean-user-refman-latex clean-user-refman-html -maintainer-clean-local: clean-devel-refman-latex clean-devel-refman-html maintainer-clean-local: - rm -rf $(srcdir)/user - rm -rf $(srcdir)/devel + -rm -rf $(srcdir)/user $(srcdir)/$(USER_REFMAN) + -rm -rf $(srcdir)/devel $(srcdir)/$(DEVEL_REFMAN) + ## ------------------------- ## ## Technical Documentation. ## @@ -270,18 +193,21 @@ maintainer-clean-local: include $(srcdir)/technical/technical.mk + ## ---------- ## ## Tutorial. ## ## ---------- ## include $(srcdir)/tutorial/tutorial.mk + ## ------------- ## ## White Paper. ## ## ------------- ## include $(srcdir)/white_paper/white_paper.mk + ## ----------------- ## ## Reference Guide. ## ## ----------------- ## @@ -289,6 +215,9 @@ include $(srcdir)/white_paper/white_paper.mk include $(srcdir)/ref_guide/ref_guide.mk +## --------- ## +## Figures. ## +## --------- ## # Make sure the figures are the first files in EXTRA_DIST. # Make the 'fake-doc' rule works correctly. @@ -315,39 +244,6 @@ $(srcdir)/figures.stamp: $(FIGURES_SRCDIR)/*.p*m mv -f $@.tmp $@ -edit = sed -e "s|@ID@|$$Id|" \ - -e 's,@PACKAGE_NAME\@,$(PACKAGE_NAME),g' \ - -e 's,@PACKAGE_VERSION\@,$(PACKAGE_VERSION),g' \ - -e 's,@top_srcdir\@,$(top_srcdir),g' \ - -e 's,@top_builddir\@,$(top_builddir),g' \ - -e 's,@srcdir\@,$(srcdir),g' \ - -e 's,@builddir\@,$(builddir),g' - -## FIXME: Instead of generating HTML and PDF (LaTeX actualy) output in -## two passes, do it in a row. It will save us a lot of time. -edit_pdf = sed -e 's,GENERATE_LATEX = NO,GENERATE_LATEX = YES,g' \ - -e 's,GENERATE_HTML = YES,GENERATE_HTML = NO,g' - -# FIXME: This is not good. We should set these parameters for both -# documentation (devel and user) using @VARIABLES@. Don't generate -# Doxyfile_user_html from Doxyfile_devel_html! Both should be a product -# derived from a single source, Doxyfile.in. -edit_user = sed \ - -e 's,OUTPUT_DIRECTORY = @srcdir@/devel/,OUTPUT_DIRECTORY = @srcdir@/user/,g' \ - -e 's,EXTRACT_ALL = YES,EXTRACT_ALL = NO,g' \ - -e 's,EXTRACT_PRIVATE = YES,EXTRACT_PRIVATE = NO,g' \ - -e 's,EXTRACT_STATIC = YES,EXTRACT_STATIC = NO,g' \ - -e 's,EXTRACT_LOCAL_CLASSES = YES,EXTRACT_LOCAL_CLASSES = NO,g' \ - -e 's,HIDE_UNDOC_MEMBERS = NO,HIDE_UNDOC_MEMBERS = YES,g' \ - -e 's,HIDE_UNDOC_CLASSES = NO,HIDE_UNDOC_CLASSES = YES,g' \ - -e 's,HIDE_FRIEND_COMPOUNDS = NO,HIDE_FRIEND_COMPOUNDS = YES,g' \ - -e 's,HIDE_IN_BODY_DOCS = NO,HIDE_IN_BODY_DOCS = YES,g' \ - -e 's,INTERNAL_DOCS = YES,INTERNAL_DOCS = NO,g' \ - -e 's,GENERATE_TODOLIST = YES,GENERATE_TODOLIST = NO,g' \ - -e 's,PROJECT_NUMBER = \",PROJECT_NUMBER = \"User documentation ,g' \ - -e 's,EXCLUDE_SYMBOLS =,EXCLUDE_SYMBOLS = *::internal* *_ mln::trait::*,g' - - ## ---------- ## ## Examples. ## ## ---------- ## @@ -384,21 +280,27 @@ include $(srcdir)/examples/examples.mk include $(srcdir)/outputs/outputs.mk +## -------------- ## +## Installation. ## +## -------------- ## + +# PDF. dist_doc_DATA += $(USER_REFMAN_PDF) +# HTML. # Installing a directory located in the source dir is not supported by -# Automake by default, so we cannot add `USER_REFMAN_HTML' to +# Automake by default, so we cannot add `$(USER_REFMAN)/html' to # `dist_doc_DATA'. The following two rules are are workaround from # the Vaucanson project. -EXTRA_DIST += $(USER_REFMAN_HTML) +EXTRA_DIST += $(USER_REFMAN)/html # We install by hand, otherwise Automake produces "install .../srcdoc # .../srcdoc", which installs our dir into the previous one, instead # of replacing it. install-data-local: - rm -rf $(DESTDIR)$(htmldir)/$(USER_REFMAN_HTML) + rm -rf $(DESTDIR)$(htmldir)/$(USER_REFMAN)/html $(mkdir_p) $(DESTDIR)$(htmldir) - cp -r $(srcdir)/$(USER_REFMAN_HTML) $(DESTDIR)$(htmldir) + cp -r $(srcdir)/$(USER_REFMAN)/html $(DESTDIR)$(htmldir)/user-refman ## Try GNU chmod's X mode before resorting to something slower but ## more standard. chmod -R a+rX $(DESTDIR)$(htmldir) || \ @@ -406,18 +308,12 @@ install-data-local: -o -exec chmod a+r {} \; uninstall-local: - chmod -R 700 $(DESTDIR)$(htmldir)/$(USER_REFMAN_HTML) - rm -rf $(DESTDIR)$(htmldir)/$(USER_REFMAN_HTML) + chmod -R 700 $(DESTDIR)$(htmldir)/user-refman + rm -rf $(DESTDIR)$(htmldir)/user-refman -## FIXME: These are now generated in the build directory. -# EXTRA_DIST += \ -# Doxyfile_devel_html \ -# Doxyfile_devel_pdf \ -# Doxyfile_user_html \ -# Doxyfile_user_pdf EXTRA_DIST += \ - $(DOXYFILE).in \ + $(DOXYFILE).in \ groups/accu.hh \ groups/graph.hh \ groups/images.hh \ @@ -435,45 +331,53 @@ EXTRA_DIST += \ tools/split_sample.sh \ tools/todoxygen.sh -## FIXME: Unsure about this. If the directory of the generated -## documentation is to be removed during `maintainer-clean' (see -## Vaucanson's doc/Makefile.am), then the source Doxyfiles should not -## be removed earlier (i.e. at `clean') ! -## -## Note: if configure is used to generate Doxyfiles (see below), these -## files should be (and will be automatically) remove by `distclean'. -CLEANFILES += \ +MAINTAINERCLEANFILES = \ Doxyfile_user \ - Doxyfile_user_pdf \ - Doxyfile_devel \ - Doxyfile_devel_pdf \ - devel \ - user + Doxyfile_devel + +edit = sed -e "s|@ID@|$$Id|" \ + -e 's,@PACKAGE_NAME\@,$(PACKAGE_NAME),g' \ + -e 's,@PACKAGE_VERSION\@,$(PACKAGE_VERSION),g' \ + -e 's,@top_srcdir\@,$(top_srcdir),g' \ + -e 's,@top_builddir\@,$(top_builddir),g' \ + -e 's,@srcdir\@,$(srcdir),g' \ + -e 's,@builddir\@,$(builddir),g' + +# FIXME: This is not good. We should set these parameters for both +# documentation (devel and user) using @VARIABLES@. Don't generate +# Doxyfile_user_html from Doxyfile_devel_html! Both should be a product +# derived from a single source, Doxyfile.in. +edit_user = sed \ + -e 's,OUTPUT_DIRECTORY = @srcdir@/devel/,OUTPUT_DIRECTORY = @srcdir@/user/,g' \ + -e 's,EXTRACT_ALL = YES,EXTRACT_ALL = NO,g' \ + -e 's,EXTRACT_PRIVATE = YES,EXTRACT_PRIVATE = NO,g' \ + -e 's,EXTRACT_STATIC = YES,EXTRACT_STATIC = NO,g' \ + -e 's,EXTRACT_LOCAL_CLASSES = YES,EXTRACT_LOCAL_CLASSES = NO,g' \ + -e 's,HIDE_UNDOC_MEMBERS = NO,HIDE_UNDOC_MEMBERS = YES,g' \ + -e 's,HIDE_UNDOC_CLASSES = NO,HIDE_UNDOC_CLASSES = YES,g' \ + -e 's,HIDE_FRIEND_COMPOUNDS = NO,HIDE_FRIEND_COMPOUNDS = YES,g' \ + -e 's,HIDE_IN_BODY_DOCS = NO,HIDE_IN_BODY_DOCS = YES,g' \ + -e 's,INTERNAL_DOCS = YES,INTERNAL_DOCS = NO,g' \ + -e 's,GENERATE_TODOLIST = YES,GENERATE_TODOLIST = NO,g' \ + -e 's,PROJECT_NUMBER = \",PROJECT_NUMBER = \"User documentation ,g' \ + -e 's,EXCLUDE_SYMBOLS =,EXCLUDE_SYMBOLS = *::internal* *_ mln::trait::*,g' # Sed is used to generate Doxyfile from Doxyfile.in instead of # configure, because the former is way faster than the latter. # ## FIXME: This is because, as in TC, we depend on $Id$ from the ## ChangeLog. Maybe we should depend from something less prone to -## change. +## change. See Bison's build system. ## ## FIXME: Move these rules higher, closer to their use sites. ## -## FIXME: There are too many indirect generations here. Simplify. - -# FIXME: Directly depend on $(DOXYFILE).in instead. -$(DOXYFILE_USER_PDF): $(DOXYFILE_USER_HTML) - $(edit_pdf) $< >$@ +## FIXME: It'd be more logical to generate $(DOXYFILE_DEVEL) from +## $(DOXYFILE_USER), not the reverse. -# FIXME: Directly depend on $(DOXYFILE).in instead. -$(DOXYFILE_USER_HTML): $(DOXYFILE_DEVEL_HTML) +$(DOXYFILE_USER): $(DOXYFILE_DEVEL) $(edit_user) $< >$@ -# FIXME: Directly depend on $(DOXYFILE).in instead. -$(DOXYFILE_DEVEL_PDF): $(DOXYFILE_DEVEL_HTML) - $(edit_pdf) $< >$@ - -$(DOXYFILE_DEVEL_HTML): $(srcdir)/$(DOXYFILE).in +$(DOXYFILE_DEVEL): $(srcdir)/$(DOXYFILE).in Id=`grep '^\$$Id' $(top_srcdir)/milena/ChangeLog \ | sed -e 's/\\\$$//g'`; \ - $(edit) $< >$@ + $(edit) $< >$@ -- 1.5.6.5

14 years, 1 month

last-svn-commit-27-g6bfa9af Shorten the list of files visited by Doxygen.

by Roland Levillain

* doc/Doxyfile.in (STRIP_FROM_PATH, INPUT, IMAGE_PATH): Remove all paths from the build directory. (EXCLUDE): Add paths to generated documentation and generated unit tests. --- milena/ChangeLog | 9 +++++++++ milena/doc/Doxyfile.in | 26 +++++++++++++++++--------- 2 files changed, 26 insertions(+), 9 deletions(-) diff --git a/milena/ChangeLog b/milena/ChangeLog index 7ae6d55..b32170e 100644 --- a/milena/ChangeLog +++ b/milena/ChangeLog @@ -1,5 +1,14 @@ 2010-03-08 Roland Levillain <roland(a)lrde.epita.fr> + Shorten the list of files visited by Doxygen. + + * doc/Doxyfile.in (STRIP_FROM_PATH, INPUT, IMAGE_PATH): + Remove all paths from the build directory. + (EXCLUDE): Add paths to generated documentation and generated unit + tests. + +2010-03-08 Roland Levillain <roland(a)lrde.epita.fr> + * apps/graph-morpho/morpho.hh: Help Doxygen compile LaTeX formulas. 2010-03-04 Roland Levillain <roland(a)lrde.epita.fr> diff --git a/milena/doc/Doxyfile.in b/milena/doc/Doxyfile.in index 503a696..e8f06cb 100644 --- a/milena/doc/Doxyfile.in +++ b/milena/doc/Doxyfile.in @@ -1,4 +1,4 @@ -# Copyright (C) 2007, 2008, 2009 EPITA Research and Development +# Copyright (C) 2007, 2008, 2009, 2010 EPITA Research and Development # Laboratory (LRDE) # # This file is part of Olena. @@ -31,8 +31,7 @@ ABBREVIATE_BRIEF = ALWAYS_DETAILED_SEC = YES INLINE_INHERITED_MEMB = YES FULL_PATH_NAMES = NO -STRIP_FROM_PATH = @top_srcdir@/milena \ - @top_builddir@/milena +STRIP_FROM_PATH = @top_srcdir@/milena STRIP_FROM_INC_PATH = SHORT_NAMES = YES JAVADOC_AUTOBRIEF = YES @@ -92,17 +91,23 @@ WARN_LOGFILE = #--------------------------------------------------------------------------- # configuration options related to the input files #--------------------------------------------------------------------------- -INPUT = @top_srcdir@/milena \ - @top_builddir@/milena +INPUT = @top_srcdir@/milena FILE_PATTERNS = *.cc \ *.hh \ *.hxx \ *.hcc RECURSIVE = YES EXCLUDE = @top_srcdir@/milena/sandbox \ - @top_srcdir@/milena/mln/core/concept/proxy.hxx \ @top_srcdir@/milena/trash \ - @top_srcdir@/milena/doc/examples/trash + @top_srcdir@/milena/mln/core/concept/proxy.hxx \ + @top_srcdir@/milena/doc/examples/trash \ + @top_srcdir@/milena/doc/user \ + @top_srcdir@/milena/doc/user-refman-html \ + @top_srcdir@/milena/doc/user-refman-latex \ + @top_srcdir@/milena/doc/devel \ + @top_srcdir@/milena/doc/devel-refman-html \ + @top_srcdir@/milena/doc/devel-refman-latex \ + @top_srcdir@/milena/tests/unit_test EXCLUDE_SYMLINKS = YES EXCLUDE_PATTERNS = *spe.hh EXCLUDE_SYMBOLS = @@ -116,8 +121,7 @@ EXAMPLE_PATTERNS = *.cc \ EXAMPLE_RECURSIVE = NO IMAGE_PATH = @top_srcdir@/milena/doc/devel/figures \ @top_srcdir@/milena/doc/img \ - @top_srcdir@/milena/doc/figures \ - @top_builddir@/milena/doc/figures + @top_srcdir@/milena/doc/figures INPUT_FILTER = FILTER_PATTERNS = FILTER_SOURCE_FILES = NO @@ -362,3 +366,7 @@ DOT_CLEANUP = YES # Configuration::additions related to the search engine #--------------------------------------------------------------------------- SEARCHENGINE = YES + +# Local Variables: +# mode: Makefile +# End: -- 1.5.6.5

14 years, 1 month

last-svn-commit-26-gcae77fd apps/graph-morpho/morpho.hh: Help Doxygen compile LaTeX formulas.

by Roland Levillain

--- milena/ChangeLog | 4 ++++ milena/apps/graph-morpho/morpho.hh | 31 ++++++++++++++++++------------- 2 files changed, 22 insertions(+), 13 deletions(-) diff --git a/milena/ChangeLog b/milena/ChangeLog index 1791f6e..7ae6d55 100644 --- a/milena/ChangeLog +++ b/milena/ChangeLog @@ -1,3 +1,7 @@ +2010-03-08 Roland Levillain <roland(a)lrde.epita.fr> + + * apps/graph-morpho/morpho.hh: Help Doxygen compile LaTeX formulas. + 2010-03-04 Roland Levillain <roland(a)lrde.epita.fr> Clean up Doxygen-related Make rules in milena/doc/. diff --git a/milena/apps/graph-morpho/morpho.hh b/milena/apps/graph-morpho/morpho.hh index 2288995..bcdcdd9 100644 --- a/milena/apps/graph-morpho/morpho.hh +++ b/milena/apps/graph-morpho/morpho.hh @@ -172,8 +172,13 @@ namespace trait | Vertices-edges combinator. | `----------------------------*/ +/* The original paper uses an operator `\ovee' to combine node and + edge graphs. However, this symbol requires the use of the + `stmaryrd' package, and Doyxgen provides no means to require it. + So, we use a more ``standard'' symbol instead (`\oplus'). */ + /// Combine the vertices and the edges of two images to create a new -/// graph image (``operator'' \f$\ovee\f$). +/// graph image (``operator'' \f$\oplus\f$). template <typename I> inline mln_concrete(I) @@ -290,7 +295,7 @@ dilation_v2e(const mln::Image& input) // Other dilations and erosions. // // ------------------------------ // -/// Vertex dilation (\f$delta\f$). +/// Vertex dilation (\f$\delta\f$). template <typename I> inline mln_concrete(I) @@ -299,7 +304,7 @@ dilation_vertex(const mln::Image& input) return dilation_e2v(dilation_v2e(input)); } -/// Vertex erosion (\f$epsilon\f$). +/// Vertex erosion (\f$\epsilon\f$). template <typename I> inline mln_concrete(I) @@ -309,7 +314,7 @@ erosion_vertex(const mln::Image& input) } -/// Edge dilation (\f$Delta\f$). +/// Edge dilation (\f$\Delta\f$). template <typename I> inline mln_concrete(I) @@ -318,7 +323,7 @@ dilation_edge(const mln::Image& input) return dilation_v2e(dilation_e2v(input)); } -/// Edge erosion (\f$Epsilon\f$). +/// Edge erosion (\f$\mathcal{E}\f$). template <typename I> inline mln_concrete(I) @@ -328,7 +333,7 @@ erosion_edge(const mln::Image& input) } -/// Graph dilation (\f$delta \ovee Delta\f$). +/// Graph dilation (\f$\delta \oplus \Delta\f$). template <typename I> inline mln_concrete(I) @@ -337,7 +342,7 @@ dilation_graph(const mln::Image& input) return combine(dilation_vertex(input), dilation_edge(input)); } -/// Graph erosion (\f$epsilon \ovee Epsilon\f$). +/// Graph erosion (\f$\epsilon \oplus \mathcal{E}\f$). template <typename I> inline mln_concrete(I) @@ -448,7 +453,7 @@ closing_edge(const mln::Image& input) } -/// Graph opening (\f${\gamma \ovee \Gamma}_1\f$). +/// Graph opening (\f${\gamma \oplus \Gamma}_1\f$). template <typename I> inline mln_concrete(I) @@ -457,7 +462,7 @@ opening_graph(const mln::Image& input) return combine(opening_vertex(input), opening_edge(input)); } -/// Graph closing (\f${\phi \ovee \Phi}_1\f$). +/// Graph closing (\f${\phi \oplus \Phi}_1\f$). template <typename I> inline mln_concrete(I) @@ -509,7 +514,7 @@ half_closing_edge(const mln::Image& input) } -/// Graph half-opening (\f${\gamma \ovee \Gamma}_{1/2}\f$). +/// Graph half-opening (\f${\gamma \oplus \Gamma}_{1/2}\f$). template <typename I> inline mln_concrete(I) @@ -518,7 +523,7 @@ half_opening_graph(const mln::Image& input) return combine(half_opening_vertex(input), half_opening_edge(input)); } -/// Graph half-closing (\f${\phi \ovee \Phi}_{1/2}\f$). +/// Graph half-closing (\f${\phi \oplus \Phi}_{1/2}\f$). template <typename I> inline mln_concrete(I) @@ -532,7 +537,7 @@ half_closing_graph(const mln::Image& input) | Parameterized openings and closings (granulometries). | `-------------------------------------------------------*/ -/// Opening (\f${\gamma \ovee \Gamma}_{\lambda/2}\f$). +/// Opening (\f${\gamma \oplus \Gamma}_{\lambda/2}\f$). template <typename I> inline mln_concrete(I) @@ -550,7 +555,7 @@ opening(const mln::Image& input, unsigned lambda) return output; } -/// Opening (\f${\phi \ovee \Phi}_{\lambda/2}\f$). +/// Opening (\f${\phi \oplus \Phi}_{\lambda/2}\f$). template <typename I> inline mln_concrete(I) -- 1.5.6.5

14 years, 1 month

last-svn-commit-25-g76860ad Clean up Doxygen-related Make rules in milena/doc/.

by Roland Levillain

* doc/Makefile.am (DOXYFILE) (DOXYFILE_USER_PDF, DOXYFILE_USER_HTML) (DOXYFILE_DEVEL_PDF, DOXYFILE_DEVEL_HTML): New variables. (USER_REFMAN_LATEX) (DEVEL_REFMAN_PDF, DEVEL_REFMAN_LATEX, DEVEL_REFMAN_HTML): New variables. (all-local): Depend on $(srcdir)/$(USER_REFMAN_PDF), $(srcdir)/user-refman-html.stamp. ($(srcdir)/$(USER_REFMAN_PDF)): Split these targets and move the generation of the LaTeX sources... ($(srcdir)/user-refman-latex.stamp) ($(srcdir)/$(USER_REFMAN_LATEX)) ($(srcdir)/devel-refman-latex.stamp) ($(srcdir)/$(DEVEL_REFMAN_LATEX)): ...here (new targets). ($(srcdir)/$(USER_REFMAN_HTML)) ($(srcdir)/$(DEVEL_REFMAN_HTML)): Delegate the actions to... ($(srcdir)/user-refman-html.stamp) ($(srcdir)/devel-refman-html.stamp): ...these (new) targets. (clean-user-refman-latex, clean-user-refman-html) (clean-devel-refman-latex, clean-devel-refman-html): New (phony) targets. (maintainer-clean-local): Depend on clean-user-refman-latex, clean-user-refman-html, clean-devel-refman-latex and clean-devel-refman-html. (EXTRA_DIST): Disable Doxyfile_devel_html, Doxyfile_devel_pdf, Doxyfile_user_html and Doxyfile_user_pdf. Add $(DOXYFILE).in. ($(srcdir)/Doxyfile_user, $(srcdir)/Doxyfile_user_pdf) ($(srcdir)/Doxyfile_devel, $(srcdir)/Doxyfile_devel_pdf): Rename targets as... ($(DOXYFILE_USER_HTML), $(DOXYFILE_USER_PDF)) ($(DOXYFILE_DEVEL_HTML), $(DOXYFILE_DEVEL_PDF)): ...these. --- milena/ChangeLog | 42 ++++++++ milena/doc/Makefile.am | 269 ++++++++++++++++++++++++++++++++++++++++-------- 2 files changed, 267 insertions(+), 44 deletions(-) diff --git a/milena/ChangeLog b/milena/ChangeLog index 4d881fe..1791f6e 100644 --- a/milena/ChangeLog +++ b/milena/ChangeLog @@ -1,3 +1,45 @@ +2010-03-04 Roland Levillain <roland(a)lrde.epita.fr> + + Clean up Doxygen-related Make rules in milena/doc/. + + * doc/Makefile.am (DOXYFILE) + (DOXYFILE_USER_PDF, DOXYFILE_USER_HTML) + (DOXYFILE_DEVEL_PDF, DOXYFILE_DEVEL_HTML): + New variables. + (USER_REFMAN_LATEX) + (DEVEL_REFMAN_PDF, DEVEL_REFMAN_LATEX, DEVEL_REFMAN_HTML): + New variables. + (all-local): Depend on $(srcdir)/$(USER_REFMAN_PDF), + $(srcdir)/user-refman-html.stamp. + ($(srcdir)/$(USER_REFMAN_PDF)): Split these targets and move the + generation of the LaTeX sources... + ($(srcdir)/user-refman-latex.stamp) + ($(srcdir)/$(USER_REFMAN_LATEX)) + ($(srcdir)/devel-refman-latex.stamp) + ($(srcdir)/$(DEVEL_REFMAN_LATEX)): + ...here (new targets). + ($(srcdir)/$(USER_REFMAN_HTML)) + ($(srcdir)/$(DEVEL_REFMAN_HTML)): + Delegate the actions to... + ($(srcdir)/user-refman-html.stamp) + ($(srcdir)/devel-refman-html.stamp): + ...these (new) targets. + (clean-user-refman-latex, clean-user-refman-html) + (clean-devel-refman-latex, clean-devel-refman-html): + New (phony) targets. + (maintainer-clean-local): Depend on clean-user-refman-latex, + clean-user-refman-html, clean-devel-refman-latex and + clean-devel-refman-html. + (EXTRA_DIST): Disable Doxyfile_devel_html, Doxyfile_devel_pdf, + Doxyfile_user_html and Doxyfile_user_pdf. + Add $(DOXYFILE).in. + ($(srcdir)/Doxyfile_user, $(srcdir)/Doxyfile_user_pdf) + ($(srcdir)/Doxyfile_devel, $(srcdir)/Doxyfile_devel_pdf): + Rename targets as... + ($(DOXYFILE_USER_HTML), $(DOXYFILE_USER_PDF)) + ($(DOXYFILE_DEVEL_HTML), $(DOXYFILE_DEVEL_PDF)): + ...these. + 2010-03-03 Roland Levillain <roland(a)lrde.epita.fr> Stop make from recurring in doc/examples. diff --git a/milena/doc/Makefile.am b/milena/doc/Makefile.am index 52e1851..3d5f4d9 100644 --- a/milena/doc/Makefile.am +++ b/milena/doc/Makefile.am @@ -22,11 +22,15 @@ include $(top_srcdir)/milena/doc/doc.mk DOXYGEN = doxygen +DOXYFILE = Doxyfile + # Initialiaze variables. EXTRA_DIST = dist_doc_DATA = CLEANFILES = +# FIXME: Simplify all of this. ``Devel'' targets are really +# secondary. And we probably don't need so much target aliases! .PHONY: doc \ doc-user doc-devel \ @@ -66,45 +70,199 @@ EXTRA_DEPS = $(srcdir)/tutorial/tutorial.hh $(srcdir)/ref_guide/ref_guide.hh ## directory of the _source_ tree. See how this is implemented in ## Vaucanson's doc build system. (Do not forget to adjust Doxyfiles.) -# Doxygen PDF documentation outputs. +# ----------------------------- # +# User reference manual (PDF). # +# ----------------------------- # + +# FIXME: Keep it or throw it away? +all-local: $(srcdir)/$(USER_REFMAN_PDF) + +DOXYFILE_USER_PDF = Doxyfile_user_pdf + +## FIXME: Rename USER_REFMAN_PDF to something else? USER_REFMAN_PDF = user-refman.pdf +## FIXME: Likewise? +USER_REFMAN_LATEX = user-refman-latex + ref-doc-pdf: $(srcdir)/$(USER_REFMAN_PDF) -# FIXME: Split in two rules: one generating the LaTeX file from the -# Doxyfile, and another one generating the PDF from the LaTeX source. -# Moreover, the LaTeX to PDF rule could be factored using a suffix -# rule (as in LRDE's share/). -$(srcdir)/$(USER_REFMAN_PDF): $(srcdir)/Doxyfile_user_pdf $(srcdir)/figures.stamp $(EXTRA_DEPS) - $(DOXYGEN) $< \ - && cd $(srcdir)/user/latex \ - && $(MAKE) pdf \ - && cp -f refman.pdf ../../$(USER_REFMAN_PDF) - -# FIXME: Careful, `user-refman-pdf' is a directory, and this make rule -# depends on its timestamp, which is wrong. + +# FIXME: Use texi2dvi instead of Doxygen's generated Makefile? +# (The LaTeX to PDF rule could be factored using a suffix rule, as in +# LRDE's share/). +$(srcdir)/$(USER_REFMAN_PDF): $(srcdir)/$(USER_REFMAN_LATEX) + cd $(srcdir)/$(USER_REFMAN_LATEX) && $(MAKE) $(AM_MAKEFLAGS) pdf + cp -f $(srcdir)/$(USER_REFMAN_LATEX)/refman.pdf $@ + +## FIXME: Use a variable instead of `$(srcdir)/user/latex'. +## +## FIXME: Are dependencies $(srcdir)/figures.stamp $(EXTRA_DEPS) set +## on the right rule? Does Doxygen make a copy of figures, or does it +## generate LaTeX inputs relying on the existence of such figures in +## the initial location? Investigate. +$(srcdir)/user-refman-latex.stamp: $(srcdir)/$(DOXYFILE).in $(srcdir)/figures.stamp $(EXTRA_DEPS) + @rm -f $@.tmp + @touch $@.tmp + -rm -rf $(srcdir)/user/latex + $(MAKE) $(AM_MAKE_FLAGS) $(DOXYFILE_USER_PDF) + $(DOXYGEN) $(DOXYFILE_USER_PDF) +## Doxygen may generate an incomplete output and exit with success! +## Check some files before deeming the output as acceptable. + test -f $(srcdir)/user/latex/refman.tex + -rm -rf $(srcdir)/$(USER_REFMAN_LATEX) +## FIXME: moving directories between file systems is not portable. + mv $(srcdir)/user/latex $(srcdir)/$(USER_REFMAN_LATEX) + @mv -f $@.tmp $@ + +# FIXME: Probably superfluous. Should vanish when HTML and LaTeX +# genarations are merged. +$(srcdir)/$(USER_REFMAN_LATEX): $(srcdir)/user-refman-latex.stamp +## Recover from the removal of $@ + @if test -d $@; then :; else \ + rm -f $<; \ + $(MAKE) $(AM_MAKEFLAGS) $<; \ + fi + +# Clean Doxygen products. +.PHONY: clean-user-refman-latex +clean-user-refman-latex: + rm -rf $(srcdir)/user/latex $(srcdir)/$(USER_REFMAN_LATEX) + +# ------------------------------ # +# User reference manual (HTML). # +# ------------------------------ # + +# FIXME: Keep it or throw it away? +all-local: $(srcdir)/user-refman-html.stamp + +# FIXME: Rename USER_REFMAN_HTML as DOCDIR_USER_HTML? USER_REFMAN_HTML = user-refman-html + +DOXYFILE_USER_HTML = Doxyfile_user_html + ref-doc-html: $(srcdir)/$(USER_REFMAN_HTML) -$(srcdir)/$(USER_REFMAN_HTML): $(srcdir)/Doxyfile_user $(srcdir)/figures.stamp $(EXTRA_DEPS) - $(DOXYGEN) $< \ - && rm -fr $(srcdir)/$(USER_REFMAN_HTML) \ - && mv $(srcdir)/user/html $(srcdir)/$(USER_REFMAN_HTML) -# Doxygen HTML documentation output directories. -DEVEL_REFMAN_PDF = devel/latex/refman.pdf +# FIXME: Use `$(USER_REFMAN_HTML).tmp' instead of `$(srcdir)/user/html'. +$(srcdir)/user-refman-html.stamp: $(srcdir)/$(DOXYFILE).in $(srcdir)/figures.stamp $(EXTRA_DEPS) + @rm -f $@.tmp + @touch $@.tmp + -rm -rf $(srcdir)/user/html + $(MAKE) $(AM_MAKE_FLAGS) $(DOXYFILE_USER_HTML) + $(DOXYGEN) $(DOXYFILE_USER_HTML) + -rm -rf $(srcdir)/$(USER_REFMAN_HTML) +## FIXME: moving directories between file systems is not portable. + mv $(srcdir)/user/html $(srcdir)/$(USER_REFMAN_HTML) + @mv -f $@.tmp $@ + +$(srcdir)/$(USER_REFMAN_HTML): $(srcdir)/user-refman-html.stamp +## Recover from the removal of $@ + @if test -d $@; then :; else \ + rm -f $<; \ + $(MAKE) $(AM_MAKEFLAGS) $<; \ + fi + +# Clean Doxygen products. +.PHONY: clean-user-refman-html +clean-user-refman-html: + rm -rf $(srcdir)/user/html $(srcdir)/$(USER_REFMAN_HTML) + +# ---------------------------------- # +# Developer reference manual (PDF). # +# ---------------------------------- # + +DOXYFILE_DEVEL_PDF = Doxyfile_devel_pdf + +## FIXME: Rename DEVEL_REFMAN_PDF to something else? +DEVEL_REFMAN_PDF = devel-refman-pdf +## FIXME: Likewise? +DEVEL_REFMAN_LATEX = devel-refman-latex + ref-doc-devel-pdf: $(srcdir)/$(DEVEL_REFMAN_PDF) -# FIXME: Split in two rules: one generating the LaTeX file from the -# Doxyfile, and another one generating the PDF from the LaTeX source. -# Moreover, the LaTeX to PDF rule could be factored using a suffix -# rule (as in LRDE's share/). -$(srcdir)/$(DEVEL_REFMAN_PDF): $(srcdir)/Doxyfile_devel_pdf $(srcdir)/figures.stamp $(EXTRA_DEPS) - $(DOXYGEN) $< - cd $(srcdir)/devel/latex && $(MAKE) $(AM_MAKEFLAGS) - -# FIXME: Careful, `devel/html' is a directory, and this make rule -# depends on its timestamp, which is wrong. -DEVEL_REFMAN_HTML = devel/html + +## FIXME: Use texi2dvi instead of Doxygen's generated Makefile? (The +## LaTeX to PDF rule could be factored using a suffix rule, as in +## LRDE's share/). +$(srcdir)/$(DEVEL_REFMAN_PDF): $(srcdir)/$(DEVEL_REFMAN_LATEX) + cd $(srcdir)/$(DEVEL_REFMAN_LATEX) && $(MAKE) $(AM_MAKEFLAGS) pdf + cp -f $(srcdir)/$(DEVEL_REFMAN_LATEX)/refman.pdf $@ + +## FIXME: Use a variable instead of `$(srcdir)/devel/latex'. +## +## FIXME: Are dependencies $(srcdir)/figures.stamp $(EXTRA_DEPS) set +## on the right rule? Does Doxygen make a copy of figures, or does it +## generate LaTeX inputs relying on the existence of such figures in +## the initial location? Investigate. +$(srcdir)/devel-refman-latex.stamp: $(srcdir)/$(DOXYFILE).in $(srcdir)/figures.stamp $(EXTRA_DEPS) + @rm -f $@.tmp + @touch $@.tmp + -rm -rf $(srcdir)/devel/latex + $(MAKE) $(AM_MAKE_FLAGS) $(DOXYFILE_DEVEL_PDF) + $(DOXYGEN) $(DOXYFILE_DEVEL_PDF) +## Doxygen may generate an incomplete output and exit with success! +## Check some files before deeming the output as acceptable. + test -f $(srcdir)/devel/latex/refman.tex + -rm -rf $(srcdir)/$(DEVEL_REFMAN_LATEX) +## FIXME: moving directories between file systems is not portable. + mv $(srcdir)/devel/latex $(srcdir)/$(DEVEL_REFMAN_LATEX) + @mv -f $@.tmp $@ + +# FIXME: Probably superfluous. Should vanish when HTML and LaTeX +# genarations are merged. +$(srcdir)/$(DEVEL_REFMAN_LATEX): $(srcdir)/devel-refman-latex.stamp +## Recover from the removal of $@ + @if test -d $@; then :; else \ + rm -f $<; \ + $(MAKE) $(AM_MAKEFLAGS) $<; \ + fi + +# Clean Doxygen products. +.PHONY: clean-devel-refman-latex +clean-devel-refman-latex: + rm -rf $(srcdir)/devel/latex $(srcdir)/$(DEVEL_REFMAN_LATEX) + +# ----------------------------------- # +# Developer reference manual (HTML). # +# ----------------------------------- # + +# FIXME: Rename DEVEL_REFMAN_HTML as DOCDIR_DEVEL_HTML? +DEVEL_REFMAN_HTML = devel-refman-html + +DOXYFILE_DEVEL_HTML = Doxyfile_devel_html + ref-doc-devel-html: $(srcdir)/$(DEVEL_REFMAN_HTML) -$(srcdir)/$(DEVEL_REFMAN_HTML): $(srcdir)/Doxyfile_devel $(srcdir)/figures.stamp $(EXTRA_DEPS) - $(DOXYGEN) $< + +# FIXME: Use `$(DEVEL_REFMAN_HTML).tmp' instead of `$(srcdir)/devel/html'. +$(srcdir)/devel-refman-html.stamp: $(srcdir)/$(DOXYFILE).in $(srcdir)/figures.stamp $(EXTRA_DEPS) + @rm -f $@.tmp + @touch $@.tmp + -rm -rf $(srcdir)/devel/html + $(MAKE) $(AM_MAKE_FLAGS) $(DOXYFILE_DEVEL_HTML) + $(DOXYGEN) $(DOXYFILE_DEVEL_HTML) + -rm -rf $(srcdir)/$(DEVEL_REFMAN_HTML) +## FIXME: moving directories between file systems is not portable. + mv $(srcdir)/devel/html $(srcdir)/$(DEVEL_REFMAN_HTML) + @mv -f $@.tmp $@ + +$(srcdir)/$(DEVEL_REFMAN_HTML): $(srcdir)/devel-refman-html.stamp +## Recover from the removal of $@ + @if test -d $@; then :; else \ + rm -f $<; \ + $(MAKE) $(AM_MAKEFLAGS) $<; \ + fi + +# Clean Doxygen products. +.PHONY: clean-devel-refman-html +clean-devel-refman-html: + rm -rf $(srcdir)/devel/html $(srcdir)/$(DEVEL_REFMAN_HTML) + +# ---------- # +# Cleaning. # +# ---------- # + +maintainer-clean-local: clean-user-refman-latex clean-user-refman-html +maintainer-clean-local: clean-devel-refman-latex clean-devel-refman-html +maintainer-clean-local: + rm -rf $(srcdir)/user + rm -rf $(srcdir)/devel ## ------------------------- ## ## Technical Documentation. ## @@ -165,12 +323,14 @@ edit = sed -e "s|@ID@|$$Id|" \ -e 's,@srcdir\@,$(srcdir),g' \ -e 's,@builddir\@,$(builddir),g' +## FIXME: Instead of generating HTML and PDF (LaTeX actualy) output in +## two passes, do it in a row. It will save us a lot of time. edit_pdf = sed -e 's,GENERATE_LATEX = NO,GENERATE_LATEX = YES,g' \ -e 's,GENERATE_HTML = YES,GENERATE_HTML = NO,g' # FIXME: This is not good. We should set these parameters for both # documentation (devel and user) using @VARIABLES@. Don't generate -# Doxyfile_user from Doxyfile_devel! Both should be a product +# Doxyfile_user_html from Doxyfile_devel_html! Both should be a product # derived from a single source, Doxyfile.in. edit_user = sed \ -e 's,OUTPUT_DIRECTORY = @srcdir@/devel/,OUTPUT_DIRECTORY = @srcdir@/user/,g' \ @@ -249,13 +409,15 @@ uninstall-local: chmod -R 700 $(DESTDIR)$(htmldir)/$(USER_REFMAN_HTML) rm -rf $(DESTDIR)$(htmldir)/$(USER_REFMAN_HTML) +## FIXME: These are now generated in the build directory. +# EXTRA_DIST += \ +# Doxyfile_devel_html \ +# Doxyfile_devel_pdf \ +# Doxyfile_user_html \ +# Doxyfile_user_pdf EXTRA_DIST += \ - Doxyfile.in \ - Doxyfile_devel \ - Doxyfile_devel_pdf \ - Doxyfile_user \ - Doxyfile_user_pdf \ + $(DOXYFILE).in \ groups/accu.hh \ groups/graph.hh \ groups/images.hh \ @@ -273,6 +435,13 @@ EXTRA_DIST += \ tools/split_sample.sh \ tools/todoxygen.sh +## FIXME: Unsure about this. If the directory of the generated +## documentation is to be removed during `maintainer-clean' (see +## Vaucanson's doc/Makefile.am), then the source Doxyfiles should not +## be removed earlier (i.e. at `clean') ! +## +## Note: if configure is used to generate Doxyfiles (see below), these +## files should be (and will be automatically) remove by `distclean'. CLEANFILES += \ Doxyfile_user \ Doxyfile_user_pdf \ @@ -283,16 +452,28 @@ CLEANFILES += \ # Sed is used to generate Doxyfile from Doxyfile.in instead of # configure, because the former is way faster than the latter. -$(srcdir)/Doxyfile_user: Doxyfile_devel +# +## FIXME: This is because, as in TC, we depend on $Id$ from the +## ChangeLog. Maybe we should depend from something less prone to +## change. +## +## FIXME: Move these rules higher, closer to their use sites. +## +## FIXME: There are too many indirect generations here. Simplify. + +# FIXME: Directly depend on $(DOXYFILE).in instead. +$(DOXYFILE_USER_PDF): $(DOXYFILE_USER_HTML) + $(edit_pdf) $< >$@ + +# FIXME: Directly depend on $(DOXYFILE).in instead. +$(DOXYFILE_USER_HTML): $(DOXYFILE_DEVEL_HTML) $(edit_user) $< >$@ -$(srcdir)/Doxyfile_user_pdf: Doxyfile_user +# FIXME: Directly depend on $(DOXYFILE).in instead. +$(DOXYFILE_DEVEL_PDF): $(DOXYFILE_DEVEL_HTML) $(edit_pdf) $< >$@ -$(srcdir)/Doxyfile_devel: $(srcdir)/Doxyfile.in +$(DOXYFILE_DEVEL_HTML): $(srcdir)/$(DOXYFILE).in Id=`grep '^\$$Id' $(top_srcdir)/milena/ChangeLog \ | sed -e 's/\\\$$//g'`; \ $(edit) $< >$@ - -$(srcdir)/Doxyfile_devel_pdf: Doxyfile_devel - $(edit_pdf) $< >$@ -- 1.5.6.5

14 years, 1 month

last-svn-commit-24-g9dd6263 configure.ac: Do not configure milena/doc/examples/Makefile.

by Roland Levillain

--- ChangeLog | 4 ++++ configure.ac | 1 - 2 files changed, 4 insertions(+), 1 deletions(-) diff --git a/ChangeLog b/ChangeLog index 1db6abf..f8f1880 100644 --- a/ChangeLog +++ b/ChangeLog @@ -1,5 +1,9 @@ 2010-03-03 Roland Levillain <roland(a)lrde.epita.fr> + * configure.ac: Do not configure milena/doc/examples/Makefile. + +2010-03-03 Roland Levillain <roland(a)lrde.epita.fr> + * configure.ac: Do not configure milena/doc/white_paper/Makefile. 2010-03-03 Roland Levillain <roland(a)lrde.epita.fr> diff --git a/configure.ac b/configure.ac index a41372c..87730ef 100644 --- a/configure.ac +++ b/configure.ac @@ -251,7 +251,6 @@ AC_CONFIG_FILES([ external/Makefile milena/Makefile milena/doc/Makefile - milena/doc/examples/Makefile milena/mesh/Makefile ]) -- 1.5.6.5

14 years, 1 month

last-svn-commit-23-ge0ecffb Stop make from recurring in doc/examples.

by Roland Levillain

* doc/Makefile.am: Include $(top_srcdir)/milena/doc/examples/make.mk. (SUBDIRS): Remove variable. (examples, data-regen, fig-convert): Remove (phony) targets. * doc/examples/Makefile.am: Rename as... * doc/examples/make.mk: ...this. Adjust. * doc/examples/ima-save.cc, * doc/tools/sample_utils.hh: Adjust as well. * milena/doc/examples/split/ima-save-1.cc.raw: Regen. --- milena/ChangeLog | 16 +++ milena/doc/Makefile.am | 21 ++--- milena/doc/examples/ima-save.cc | 4 +- milena/doc/examples/{Makefile.am => make.mk} | 127 +++++++++++++------------ milena/doc/examples/split/ima-save-1.cc.raw | 4 +- milena/doc/tools/sample_utils.hh | 4 +- 6 files changed, 98 insertions(+), 78 deletions(-) rename milena/doc/examples/{Makefile.am => make.mk} (68%) diff --git a/milena/ChangeLog b/milena/ChangeLog index f010f44..4d881fe 100644 --- a/milena/ChangeLog +++ b/milena/ChangeLog @@ -1,5 +1,21 @@ 2010-03-03 Roland Levillain <roland(a)lrde.epita.fr> + Stop make from recurring in doc/examples. + + * doc/Makefile.am: Include + $(top_srcdir)/milena/doc/examples/make.mk. + (SUBDIRS): Remove variable. + (examples, data-regen, fig-convert): Remove (phony) targets. + * doc/examples/Makefile.am: Rename as... + * doc/examples/make.mk: ...this. + Adjust. + * doc/examples/ima-save.cc, + * doc/tools/sample_utils.hh: + Adjust as well. + * milena/doc/examples/split/ima-save-1.cc.raw: Regen. + +2010-03-03 Roland Levillain <roland(a)lrde.epita.fr> + Stop make from recurring in doc/white_paper. * doc/white_paper/Makefile.am: Rename as... diff --git a/milena/doc/Makefile.am b/milena/doc/Makefile.am index c0d53f0..52e1851 100644 --- a/milena/doc/Makefile.am +++ b/milena/doc/Makefile.am @@ -20,9 +20,6 @@ include $(top_srcdir)/milena/doc/doc.mk -SUBDIRS = \ - examples - DOXYGEN = doxygen # Initialiaze variables. @@ -35,9 +32,7 @@ CLEANFILES = doc-user doc-devel \ doc-pdf doc-html doc-devel-pdf doc-devel-html \ ref-doc-pdf ref-doc-html \ - ref-doc-devel-pdf ref-doc-devel-html \ - examples data-regen fig-convert - + ref-doc-devel-pdf ref-doc-devel-html doc: doc-user doc-devel @@ -136,14 +131,6 @@ include $(srcdir)/white_paper/white_paper.mk include $(srcdir)/ref_guide/ref_guide.mk -# FIXME: Adress the construction of examples (see examples/Makefile.am). -data-regen: - cd examples && $(MAKE) $(AM_MAKEFLAGS) $@ - - -fix-refdata: - cd examples && $(MAKE) $(AM_MAKEFLAGS) $@ - # Make sure the figures are the first files in EXTRA_DIST. # Make the 'fake-doc' rule works correctly. @@ -201,6 +188,12 @@ edit_user = sed \ -e 's,EXCLUDE_SYMBOLS =,EXCLUDE_SYMBOLS = *::internal* *_ mln::trait::*,g' +## ---------- ## +## Examples. ## +## ---------- ## + +include $(top_srcdir)/milena/doc/examples/make.mk + # Regen files. EXTRA_DIST += generate_dist_files.sh headers.stamp include $(top_srcdir)/build-aux/regen-recursive.mk diff --git a/milena/doc/examples/ima-save.cc b/milena/doc/examples/ima-save.cc index c9cb0aa..91c8226 100644 --- a/milena/doc/examples/ima-save.cc +++ b/milena/doc/examples/ima-save.cc @@ -15,6 +15,8 @@ int main() image2d<bool> ima = make::image(vals); // \{ - io::pbm::save(ima, "../figures/ima_save.pbm"); + /* FIXME: Hard-coded paths are bad! Use something like + milena/tests/data.hh.in instead. */ + io::pbm::save(ima, "figures/ima_save.pbm"); // \} } diff --git a/milena/doc/examples/Makefile.am b/milena/doc/examples/make.mk similarity index 68% rename from milena/doc/examples/Makefile.am rename to milena/doc/examples/make.mk index e6c3cd6..d83a742 100644 --- a/milena/doc/examples/Makefile.am +++ b/milena/doc/examples/make.mk @@ -1,4 +1,6 @@ -# Copyright (C) 2009 EPITA Research and Development Laboratory (LRDE). +# -*- Automake -*- + +# Copyright (C) 2009, 2010 EPITA Research and Development Laboratory (LRDE). # # This file is part of Olena. # @@ -17,9 +19,9 @@ ## Process this file through Automake to create Makefile.in. -include $(top_srcdir)/milena/doc/doc.mk +examples_dir = $(doc_dir)/examples -EXTRA_PROGRAMS = \ +PROGRAMS_examples = \ accu-right-instanciation \ borderthickness \ box2d-bbox \ @@ -63,90 +65,93 @@ EXTRA_PROGRAMS = \ win-create-1 \ win-create-2 -EXTRA_PROGRAMS += \ +PROGRAMS_examples += \ tuto2_first_image \ tuto3_rw_image \ tuto4_genericity_and_algorithms # Tuto3 -EXTRA_PROGRAMS += \ +PROGRAMS_examples += \ tuto3_colorize \ tuto3_println \ tuto3_trace # Tuto4 -EXTRA_PROGRAMS += \ +PROGRAMS_examples += \ tuto4_point2d \ tuto4_site_set_create -CLEANFILES = $(EXTRA_PROGRAMS) +EXTRA_PROGRAMS = $(PROGRAMS_examples) + +# FIXME: Is this really needed? +CLEANFILES += $(PROGRAMS_examples) -accu_right_instanciation_SOURCES = accu-right-instanciation.cc -borderthickness_SOURCES = borderthickness.cc -box2d_bbox_SOURCES = box2d-bbox.cc -domain_display_SOURCES = domain-display.cc -dpoint_1_SOURCES = dpoint-1.cc -estim_sites_SOURCES = estim-sites.cc -extend_SOURCES = extend.cc -extension_ignore_SOURCES = extension-ignore.cc -fill_SOURCES = fill.cc -fill_call_1_SOURCES = fill-call-1.cc -fill_part_image_SOURCES = fill-part-image.cc -fill_subdomain_SOURCES = fill-subdomain.cc -fill_subdomain_shorter_SOURCES = fill-subdomain-shorter.cc -fill_imageif_cfun_SOURCES = fill-imageif-cfun.cc -first_routine_SOURCES = tuto3/first_routine.cc -forall_piter_SOURCES = forall-piter.cc -fun_p2v_1_SOURCES = fun-p2v-1.cc -graph_data_SOURCES = graph-data.cc -graph_iter_SOURCES = graph-iter.cc -ima_has_SOURCES = ima-has.cc -ima_save_SOURCES = ima-save.cc -ima_size_SOURCES = ima-size.cc -ima2d_1_SOURCES = ima2d-1.cc -ima2d_2_SOURCES = ima2d-2.cc -ima2d_3_SOURCES = ima2d-3.cc -ima2d_4_SOURCES = ima2d-4.cc -ima2d_5_SOURCES = ima2d-5.cc -ima2d_6_clone_SOURCES = ima2d-6-clone.cc -ima2d_7_SOURCES = ima2d-7.cc -ima2d_rot_SOURCES = ima2d-rot.cc -labeling_compute_SOURCES = labeling-compute.cc -logical_not_SOURCES = logical-not.cc -mln_var_SOURCES = mln_var.cc -paste_SOURCES = paste.cc -paste_call_1_SOURCES = paste-call-1.cc -parray_append_SOURCES = parray-append.cc -parray_bbox_SOURCES = parray-bbox.cc -point_1_SOURCES = point-1.cc -predicate_1_SOURCES = predicate-1.cc -win_create_1_SOURCES = win-create-1.cc -win_create_2_SOURCES = win-create-2.cc +accu_right_instanciation_SOURCES = $(examples_dir)/accu-right-instanciation.cc +borderthickness_SOURCES = $(examples_dir)/borderthickness.cc +box2d_bbox_SOURCES = $(examples_dir)/box2d-bbox.cc +domain_display_SOURCES = $(examples_dir)/domain-display.cc +dpoint_1_SOURCES = $(examples_dir)/dpoint-1.cc +estim_sites_SOURCES = $(examples_dir)/estim-sites.cc +extend_SOURCES = $(examples_dir)/extend.cc +extension_ignore_SOURCES = $(examples_dir)/extension-ignore.cc +fill_SOURCES = $(examples_dir)/fill.cc +fill_call_1_SOURCES = $(examples_dir)/fill-call-1.cc +fill_part_image_SOURCES = $(examples_dir)/fill-part-image.cc +fill_subdomain_SOURCES = $(examples_dir)/fill-subdomain.cc +fill_subdomain_shorter_SOURCES = $(examples_dir)/fill-subdomain-shorter.cc +fill_imageif_cfun_SOURCES = $(examples_dir)/fill-imageif-cfun.cc +first_routine_SOURCES = $(examples_dir)/tuto3/first_routine.cc +forall_piter_SOURCES = $(examples_dir)/forall-piter.cc +fun_p2v_1_SOURCES = $(examples_dir)/fun-p2v-1.cc +graph_data_SOURCES = $(examples_dir)/graph-data.cc +graph_iter_SOURCES = $(examples_dir)/graph-iter.cc +ima_has_SOURCES = $(examples_dir)/ima-has.cc +ima_save_SOURCES = $(examples_dir)/ima-save.cc +ima_size_SOURCES = $(examples_dir)/ima-size.cc +ima2d_1_SOURCES = $(examples_dir)/ima2d-1.cc +ima2d_2_SOURCES = $(examples_dir)/ima2d-2.cc +ima2d_3_SOURCES = $(examples_dir)/ima2d-3.cc +ima2d_4_SOURCES = $(examples_dir)/ima2d-4.cc +ima2d_5_SOURCES = $(examples_dir)/ima2d-5.cc +ima2d_6_clone_SOURCES = $(examples_dir)/ima2d-6-clone.cc +ima2d_7_SOURCES = $(examples_dir)/ima2d-7.cc +ima2d_rot_SOURCES = $(examples_dir)/ima2d-rot.cc +labeling_compute_SOURCES = $(examples_dir)/labeling-compute.cc +logical_not_SOURCES = $(examples_dir)/logical-not.cc +mln_var_SOURCES = $(examples_dir)/mln_var.cc +paste_SOURCES = $(examples_dir)/paste.cc +paste_call_1_SOURCES = $(examples_dir)/paste-call-1.cc +parray_append_SOURCES = $(examples_dir)/parray-append.cc +parray_bbox_SOURCES = $(examples_dir)/parray-bbox.cc +point_1_SOURCES = $(examples_dir)/point-1.cc +predicate_1_SOURCES = $(examples_dir)/predicate-1.cc +win_create_1_SOURCES = $(examples_dir)/win-create-1.cc +win_create_2_SOURCES = $(examples_dir)/win-create-2.cc -tuto2_first_image_SOURCES = tuto2_first_image.cc -tuto3_rw_image_SOURCES = tuto3_rw_image.cc -tuto4_genericity_and_algorithms_SOURCES = tuto4_genericity_and_algorithms.cc +tuto2_first_image_SOURCES = $(examples_dir)/tuto2_first_image.cc +tuto3_rw_image_SOURCES = $(examples_dir)/tuto3_rw_image.cc +tuto4_genericity_and_algorithms_SOURCES = $(examples_dir)/tuto4_genericity_and_algorithms.cc # Tuto 3 -tuto3_colorize_SOURCES = tuto3/colorize.cc -tuto3_println_SOURCES = tuto3/println.cc -tuto3_trace_SOURCES = tuto3/trace.cc +tuto3_colorize_SOURCES = $(examples_dir)/tuto3/colorize.cc +tuto3_println_SOURCES = $(examples_dir)/tuto3/println.cc +tuto3_trace_SOURCES = $(examples_dir)/tuto3/trace.cc # Tuto 4 -tuto4_site_set_create_SOURCES = tuto4/site_set_create.cc -tuto4_point2d_SOURCES = tuto4/point2d.cc +tuto4_site_set_create_SOURCES = $(examples_dir)/tuto4/site_set_create.cc +tuto4_point2d_SOURCES = $(examples_dir)/tuto4/point2d.cc .PHONY : examples run-examples diff-data fix-refdata \ split-examples split-outputs -examples: $(EXTRA_PROGRAMS) +examples: $(PROGRAMS_examples) run-examples: examples test -d $(top_builddir)/milena/doc/figures \ || mkdir $(top_builddir)/milena/doc/figures; \ - @failcom='exit 1'; \ - list='$(EXTRA_PROGRAMS)'; for bin in $$list; do \ + failcom='exit 1'; \ + list='$(PROGRAMS_examples)'; for bin in $$list; do \ echo "Running $$bin"; \ ./$$bin > $(OUTPUTS_SRCDIR)/$$bin.txt || eval $$failcom; \ done diff --git a/milena/doc/examples/split/ima-save-1.cc.raw b/milena/doc/examples/split/ima-save-1.cc.raw index 331f954..98d029c 100644 --- a/milena/doc/examples/split/ima-save-1.cc.raw +++ b/milena/doc/examples/split/ima-save-1.cc.raw @@ -1 +1,3 @@ - io::pbm::save(ima, "../figures/ima_save.pbm"); + /* FIXME: Hard-coded paths are bad! Use something like + milena/tests/data.hh.in instead. */ + io::pbm::save(ima, "figures/ima_save.pbm"); diff --git a/milena/doc/tools/sample_utils.hh b/milena/doc/tools/sample_utils.hh index d0eddfe..6ef802d 100644 --- a/milena/doc/tools/sample_utils.hh +++ b/milena/doc/tools/sample_utils.hh @@ -43,7 +43,9 @@ namespace doc static int file_id = 1; std::ostringstream os; - os << "../figures/" + /* FIXME: Hard-coded paths are bad! Use something like + milena/tests/data.hh.in instead. */ + os << "figures/" << name << "-" << file_id++ -- 1.5.6.5

14 years, 1 month

last-svn-commit-22-g69c0a1d Tell Git to ignore files generated in milena/doc/white_paper/figures/.

by Roland Levillain

--- milena/doc/.gitignore | 4 ++++ 1 files changed, 4 insertions(+), 0 deletions(-) diff --git a/milena/doc/.gitignore b/milena/doc/.gitignore index 3f4a603..8670dd7 100644 --- a/milena/doc/.gitignore +++ b/milena/doc/.gitignore @@ -23,6 +23,10 @@ /tutorial/tutorial.pdf /user-refman-html /user-refman.pdf +/white_paper/figures/house.eps +/white_paper/figures/house_rag.eps +/white_paper/figures/house_wshed.eps +/white_paper/figures/house_wshed_mean_colors.eps /white_paper/white_paper_html/index.haux /white_paper/white_paper_html/index.html /white_paper/white_paper_html/index.html-e -- 1.5.6.5

14 years, 1 month

last-svn-commit-21-gdc704d3 configure.ac: Do not configure milena/doc/white_paper/Makefile.

by Roland Levillain

--- ChangeLog | 4 ++++ configure.ac | 1 - 2 files changed, 4 insertions(+), 1 deletions(-) diff --git a/ChangeLog b/ChangeLog index 4ba60b3..1db6abf 100644 --- a/ChangeLog +++ b/ChangeLog @@ -1,5 +1,9 @@ 2010-03-03 Roland Levillain <roland(a)lrde.epita.fr> + * configure.ac: Do not configure milena/doc/white_paper/Makefile. + +2010-03-03 Roland Levillain <roland(a)lrde.epita.fr> + * configure.ac: Do not configure milena/doc/technical/Makefile. 2010-03-03 Roland Levillain <roland(a)lrde.epita.fr> diff --git a/configure.ac b/configure.ac index a15dd72..a41372c 100644 --- a/configure.ac +++ b/configure.ac @@ -252,7 +252,6 @@ AC_CONFIG_FILES([ milena/Makefile milena/doc/Makefile milena/doc/examples/Makefile - milena/doc/white_paper/Makefile milena/mesh/Makefile ]) -- 1.5.6.5

14 years, 1 month

last-svn-commit-20-g2aade69 Stop make from recurring in doc/white_paper.

by Roland Levillain

* doc/white_paper/Makefile.am: Rename as... * doc/white_paper/white_paper.mk: ...this. Adjust. * doc/Makefile.am: Include $(srcdir)/white_paper/white_paper.mk. (SUBDIRS): Remove white_paper. (white-paper-pdf, white-paper-html): Remove (phony) targets. --- milena/ChangeLog | 11 ++++ milena/doc/Makefile.am | 10 +--- .../white_paper/{Makefile.am => white_paper.mk} | 57 +++++++++++--------- 3 files changed, 44 insertions(+), 34 deletions(-) rename milena/doc/white_paper/{Makefile.am => white_paper.mk} (62%) diff --git a/milena/ChangeLog b/milena/ChangeLog index 381d7af..f010f44 100644 --- a/milena/ChangeLog +++ b/milena/ChangeLog @@ -1,5 +1,16 @@ 2010-03-03 Roland Levillain <roland(a)lrde.epita.fr> + Stop make from recurring in doc/white_paper. + + * doc/white_paper/Makefile.am: Rename as... + * doc/white_paper/white_paper.mk: ...this. + Adjust. + * doc/Makefile.am: Include $(srcdir)/white_paper/white_paper.mk. + (SUBDIRS): Remove white_paper. + (white-paper-pdf, white-paper-html): Remove (phony) targets. + +2010-03-03 Roland Levillain <roland(a)lrde.epita.fr> + Stop make from recurring in doc/technical. * doc/technical/Makefile.am: Rename as... diff --git a/milena/doc/Makefile.am b/milena/doc/Makefile.am index d3a94cd..c0d53f0 100644 --- a/milena/doc/Makefile.am +++ b/milena/doc/Makefile.am @@ -21,8 +21,7 @@ include $(top_srcdir)/milena/doc/doc.mk SUBDIRS = \ - examples \ - white_paper + examples DOXYGEN = doxygen @@ -37,7 +36,6 @@ CLEANFILES = doc-pdf doc-html doc-devel-pdf doc-devel-html \ ref-doc-pdf ref-doc-html \ ref-doc-devel-pdf ref-doc-devel-html \ - white-paper-pdf white-paper-html \ examples data-regen fig-convert @@ -129,11 +127,7 @@ include $(srcdir)/tutorial/tutorial.mk ## White Paper. ## ## ------------- ## -white-paper-pdf: - cd white_paper && $(MAKE) $(AM_MAKEFLAGS) $@ - -white-paper-html: - cd white_paper && $(MAKE) $(AM_MAKEFLAGS) $@ +include $(srcdir)/white_paper/white_paper.mk ## ----------------- ## ## Reference Guide. ## diff --git a/milena/doc/white_paper/Makefile.am b/milena/doc/white_paper/white_paper.mk similarity index 62% rename from milena/doc/white_paper/Makefile.am rename to milena/doc/white_paper/white_paper.mk index 24d619d..0b75c44 100644 --- a/milena/doc/white_paper/Makefile.am +++ b/milena/doc/white_paper/white_paper.mk @@ -1,3 +1,5 @@ +# -*- Automake -*- + # Copyright (C) 2009, 2010 EPITA Research and Development Laboratory (LRDE). # # This file is part of Olena. @@ -15,15 +17,17 @@ # along with Olena. If not, see <http://www.gnu.org/licenses/>. # -include $(top_srcdir)/milena/doc/doc.mk +.PHONY: white-paper white-paper-html white-paper-pdf + +white_paper_dir = $(doc_dir)/white_paper -TEXINPUTS=$(DOC_SRCDIR):$(srcdir): +white_paper_TEXINPUTS = $(DOC_SRCDIR):$(white_paper_dir): -PNGS = \ - figures/house.png \ - figures/house_rag.png \ - figures/house_wshed.png \ - figures/house_wshed_mean_colors.png +PNGS = \ + $(white_paper_dir)/figures/house.png \ + $(white_paper_dir)/figures/house_rag.png \ + $(white_paper_dir)/figures/house_wshed.png \ + $(white_paper_dir)/figures/house_wshed_mean_colors.png EPSS = $(PNGS:png=eps) @@ -33,11 +37,8 @@ EPSS = $(PNGS:png=eps) convert $< $@ -.PHONY: white-paper white-paper-html white-paper-pdf - white-paper: white-paper-pdf white-paper-html - # FIXME: As in milena/doc/Makefile.am, we should probably strip # $(srcdir) prefixes from target variables, e.g. instead of: # @@ -62,37 +63,41 @@ white-paper: white-paper-pdf white-paper-html # product is a directory, also refresh a timestamp (in the source # dir). -WHITE_PAPER_HTML = $(srcdir)/white_paper_html/index.html +# FIXME: Use texi2dvi/TeX4ht instead of plain hevea. +WHITE_PAPER_HTML = $(white_paper_dir)/white_paper_html/index.html white-paper-html: $(WHITE_PAPER_HTML) -$(WHITE_PAPER_HTML): white_paper.tex $(EPSS) - test -d $(srcdir)/white_paper_html || mkdir $(srcdir)/white_paper_html - TEXINPUTS=$(TEXINPUTS) hevea -O -fix $< -o $@ - $(top_srcdir)/milena/doc/tools/clearbanner.sh $@ +$(WHITE_PAPER_HTML): $(white_paper_dir)/white_paper.tex $(EPSS) + test -d $(white_paper_dir)/white_paper_html \ + || mkdir $(white_paper_dir)/white_paper_html + TEXINPUTS=$(white_paper_TEXINPUTS) hevea -O -fix $< -o $@ + $(doc_dir)/tools/clearbanner.sh $@ -WHITE_PAPER_PDF = $(srcdir)/white_paper.pdf +WHITE_PAPER_PDF = $(white_paper_dir)/white_paper.pdf white-paper-pdf: $(WHITE_PAPER_PDF) -$(WHITE_PAPER_PDF): white_paper.tex $(PNGS) - TEXINPUTS=$(TEXINPUTS) pdflatex $< - TEXINPUTS=$(TEXINPUTS) pdflatex $< - TEXINPUTS=$(TEXINPUTS) pdflatex $< \ - test "$(top_srcdir)" == "$(top_builddir)" \ - || mv -f white_paper.pdf $(srcdir) +$(WHITE_PAPER_PDF): $(white_paper_dir)/white_paper.tex $(PNGS) + TEXINPUTS=$(white_paper_TEXINPUTS) pdflatex $< + TEXINPUTS=$(white_paper_TEXINPUTS) pdflatex $< + TEXINPUTS=$(white_paper_TEXINPUTS) pdflatex $< \ + test "x$(white_paper_dir)" != x. \ + && mv -f white_paper.pdf $(white_paper_dir) -dist_doc_DATA = \ +dist_doc_DATA += \ $(WHITE_PAPER_HTML) \ $(WHITE_PAPER_PDF) -EXTRA_DIST = \ - white_paper.tex \ +EXTRA_DIST += \ + $(white_paper_dir)/white_paper.tex \ $(PNGS) \ $(EPSS) -CLEANFILES = \ +# FIXME: Remove unnecessary patterns. +CLEANFILES += \ white_paper_image.* \ white_paper.pdf \ *.log *.idx *.out *.aux +# FIXME: Likewise. clean-local: -rm -rf white_paper_html figures -- 1.5.6.5

14 years, 1 month

last-svn-commit-19-gae7290b Tell Git to ignore files generated in milena/doc/technical/.

by Roland Levillain

--- milena/doc/.gitignore | 5 +++++ 1 files changed, 5 insertions(+), 0 deletions(-) diff --git a/milena/doc/.gitignore b/milena/doc/.gitignore index c0b9abd..3f4a603 100644 --- a/milena/doc/.gitignore +++ b/milena/doc/.gitignore @@ -11,6 +11,11 @@ /ref_guide/ref_guide.html /ref_guide/ref_guide.htoc /ref_guide/ref_guide.pdf +/technical/technical.haux +/technical/technical.hh +/technical/technical.hh-e +/technical/technical.html +/technical/technical.pdf /tutorial/tutorial.haux /tutorial/tutorial.hh /tutorial/tutorial.hh-e -- 1.5.6.5

14 years, 1 month

Jump to page:

2024

2023

2022

2021

2020

2019

2018

2017

2016

2015

2014

2013

2012

2011

2010

2009

2008

2007

2006

2005

2004

Olena-patches April 2010