Olena-patches March 2010

olena-patches@lrde.epita.fr

4 participants
277 discussions

last-svn-commit-20-g074db67 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 8882d87..e3a2d70 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, 2 months

last-svn-commit-19-g6095c47 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 aed1cb8..8882d87 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, 2 months

last-svn-commit-26-g9716b84 Have Doxygen generate its outputs in the build directory.

by Roland Levillain

* doc/Doxyfile.in (OUTPUT_DIRECTORY): s,@srcdir@/user/,@builddir@/user-refman.tmp,. (EXCLUDE): Adjust. * doc/Makefile.am (edit_devel): Adjust. ($(srcdir)/user-refman.stamp) ($(srcdir)/devel-refman.stamp) (maintainer-clean-local): Adjust targets. --- milena/ChangeLog | 13 +++++++++++++ milena/doc/.gitignore | 2 -- milena/doc/Doxyfile.in | 4 +--- milena/doc/Makefile.am | 22 +++++++++------------- 4 files changed, 23 insertions(+), 18 deletions(-) diff --git a/milena/ChangeLog b/milena/ChangeLog index 63c3c65..1c8f44f 100644 --- a/milena/ChangeLog +++ b/milena/ChangeLog @@ -1,5 +1,18 @@ 2010-03-08 Roland Levillain <roland(a)lrde.epita.fr> + Have Doxygen generate its outputs in the build directory. + + * doc/Doxyfile.in (OUTPUT_DIRECTORY): + s,@srcdir@/user/,@builddir@/user-refman.tmp,. + (EXCLUDE): Adjust. + * doc/Makefile.am (edit_devel): Adjust. + ($(srcdir)/user-refman.stamp) + ($(srcdir)/devel-refman.stamp) + (maintainer-clean-local): + Adjust targets. + +2010-03-08 Roland Levillain <roland(a)lrde.epita.fr> + Reorganize doc/Makefile.am. * doc/Makefile.am (edit, $(DOXYFILE_USER)): diff --git a/milena/doc/.gitignore b/milena/doc/.gitignore index 4b96d25..9c55456 100644 --- a/milena/doc/.gitignore +++ b/milena/doc/.gitignore @@ -1,9 +1,7 @@ /Doxyfile_devel /Doxyfile_user -/devel /devel-refman /devel-refman.pdf -/user /user-refman /user-refman.pdf /figures/*.png diff --git a/milena/doc/Doxyfile.in b/milena/doc/Doxyfile.in index a8c3400..5b20a7c 100644 --- a/milena/doc/Doxyfile.in +++ b/milena/doc/Doxyfile.in @@ -22,7 +22,7 @@ #--------------------------------------------------------------------------- PROJECT_NAME = "Milena (@PACKAGE_NAME@)" PROJECT_NUMBER = "User documentation @PACKAGE_VERSION@ @ID@" -OUTPUT_DIRECTORY = @srcdir@/user/ +OUTPUT_DIRECTORY = @builddir@/user-refman.tmp CREATE_SUBDIRS = YES OUTPUT_LANGUAGE = English BRIEF_MEMBER_DESC = YES @@ -101,9 +101,7 @@ EXCLUDE = @top_srcdir@/milena/sandbox \ @top_srcdir@/milena/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 - @top_srcdir@/milena/doc/devel \ @top_srcdir@/milena/doc/devel-refman @top_srcdir@/milena/tests/unit_test EXCLUDE_SYMLINKS = YES diff --git a/milena/doc/Makefile.am b/milena/doc/Makefile.am index d53c208..49cf5a5 100644 --- a/milena/doc/Makefile.am +++ b/milena/doc/Makefile.am @@ -113,8 +113,6 @@ $(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' 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 @@ -122,15 +120,15 @@ $(srcdir)/$(USER_REFMAN_PDF): $(srcdir)/$(USER_REFMAN) $(srcdir)/user-refman.stamp: $(srcdir)/$(DOXYFILE).in $(srcdir)/figures.stamp $(EXTRA_DEPS) @rm -f $@.tmp @touch $@.tmp - -rm -rf $(srcdir)/user + -rm -rf $(USER_REFMAN).tmp $(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 + test -f $(USER_REFMAN).tmp/latex/refman.tex -rm -rf $(srcdir)/$(USER_REFMAN) ## FIXME: Moving directories between file systems is not portable. - mv $(srcdir)/user $(srcdir)/$(USER_REFMAN) + mv $(USER_REFMAN).tmp $(srcdir)/$(USER_REFMAN) @mv -f $@.tmp $@ $(srcdir)/$(USER_REFMAN): $(srcdir)/user-refman.stamp @@ -154,7 +152,7 @@ regen-devel-doc: DOXYFILE_DEVEL = Doxyfile_devel edit_devel = sed \ - -e 's,OUTPUT_DIRECTORY = @srcdir@/user/,OUTPUT_DIRECTORY = @srcdir@/devel/,' \ + -e 's,OUTPUT_DIRECTORY = @builddir@/user-refman.tmp/,OUTPUT_DIRECTORY = @builddir@/devel-refman.tmp/,' \ -e 's,EXTRACT_ALL = NO,EXTRACT_ALL = YES,' \ -e 's,EXTRACT_PRIVATE = NO,EXTRACT_PRIVATE = YES,' \ -e 's,EXTRACT_STATIC = NO,EXTRACT_STATIC = YES,' \ @@ -195,8 +193,6 @@ $(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' 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 @@ -204,15 +200,15 @@ $(srcdir)/$(DEVEL_REFMAN_PDF): $(srcdir)/$(DEVEL_REFMAN) $(srcdir)/devel-refman.stamp: $(srcdir)/$(DOXYFILE).in $(srcdir)/figures.stamp $(EXTRA_DEPS) @rm -f $@.tmp @touch $@.tmp - -rm -rf $(srcdir)/devel + -rm -rf $(DEVEL_REFMAN).tmp $(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 + test -f $(DEVEL_REFMAN).tmp/latex/refman.tex -rm -rf $(srcdir)/$(DEVEL_REFMAN) ## FIXME: Moving directories between file systems is not portable. - mv $(srcdir)/devel $(srcdir)/$(DEVEL_REFMAN) + mv $(DEVEL_REFMAN).tmp $(srcdir)/$(DEVEL_REFMAN) @mv -f $@.tmp $@ $(srcdir)/$(DEVEL_REFMAN): $(srcdir)/devel-refman.stamp @@ -225,8 +221,8 @@ $(srcdir)/$(DEVEL_REFMAN): $(srcdir)/devel-refman.stamp # Clean Doxygen products. maintainer-clean-local: - -rm -rf $(srcdir)/user $(srcdir)/$(USER_REFMAN) - -rm -rf $(srcdir)/devel $(srcdir)/$(DEVEL_REFMAN) + -rm -rf $(USER_REFMAN).tmp $(srcdir)/$(USER_REFMAN) + -rm -rf $(DEVEL_REFMAN).tmp $(srcdir)/$(DEVEL_REFMAN) ## ------------------------- ## -- 1.5.6.5

14 years, 2 months

last-svn-commit-25-g52239ab Require Doxygen 1.5.6 at bootstrapping time.

by Roland Levillain

* bootstrap: Here. (require): Be more tolerant w.r.t. version messages. --- ChangeLog | 7 +++++++ bootstrap | 4 +++- 2 files changed, 10 insertions(+), 1 deletions(-) diff --git a/ChangeLog b/ChangeLog index bcb4064..dedc814 100644 --- a/ChangeLog +++ b/ChangeLog @@ -1,5 +1,12 @@ 2010-03-08 Roland Levillain <roland(a)lrde.epita.fr> + Require Doxygen 1.5.6 at bootstrapping time. + + * bootstrap: Here. + (require): Be more tolerant w.r.t. version messages. + +2010-03-08 Roland Levillain <roland(a)lrde.epita.fr> + * bootstrap: Fix a typo in an error message. 2010-03-03 Roland Levillain <roland(a)lrde.epita.fr> diff --git a/bootstrap b/bootstrap index fc71583..62cc724 100755 --- a/bootstrap +++ b/bootstrap @@ -83,7 +83,7 @@ version_compare () # Test that TOOL exists, and its version is at least REQUIREMENT. require () { - local version=$($1 --version | sed -n 's/.*[^0-9.]$[0-9][0-9.]*$.*/\1/p;q') + local version=$($1 --version | sed -n 's/[^0-9.]*$[0-9][0-9.]*$.*/\1/p;q') test x"$version" != x || fatal "$1 is required" case $(version_compare "$2" "$version") in @@ -125,6 +125,8 @@ done export LIBTOOLIZE=$libtoolize require $libtoolize 1.5.22 +require doxygen 1.5.6 + # Tell what's going on. set -x -- 1.5.6.5

14 years, 2 months

last-svn-commit-24-g42f2b71 bootstrap: Fix a typo in an error message.

by Roland Levillain

--- ChangeLog | 4 ++++ bootstrap | 2 +- 2 files changed, 5 insertions(+), 1 deletions(-) diff --git a/ChangeLog b/ChangeLog index c4bb5d5..bcb4064 100644 --- a/ChangeLog +++ b/ChangeLog @@ -1,3 +1,7 @@ +2010-03-08 Roland Levillain <roland(a)lrde.epita.fr> + + * bootstrap: Fix a typo in an error message. + 2010-03-03 Roland Levillain <roland(a)lrde.epita.fr> * configure.ac: Do not configure milena/doc/examples/Makefile. diff --git a/bootstrap b/bootstrap index 17324b4..fc71583 100755 --- a/bootstrap +++ b/bootstrap @@ -87,7 +87,7 @@ require () test x"$version" != x || fatal "$1 is required" case $(version_compare "$2" "$version") in - '>') fatal "$1 $2 or better is required: this is $1 $2";; + '>') fatal "$1 $2 or better is required: this is $1 $version";; esac } -- 1.5.6.5

14 years, 2 months

last-svn-commit-23-gbd915de Reorganize doc/Makefile.am.

by Roland Levillain

* doc/Makefile.am (edit, $(DOXYFILE_USER)): Move these definitions closer to their use site. (edit_devel, $(DOXYFILE_DEVEL)): Likewise. --- milena/ChangeLog | 8 ++++ milena/doc/Makefile.am | 87 +++++++++++++++++++++++------------------------- 2 files changed, 50 insertions(+), 45 deletions(-) diff --git a/milena/ChangeLog b/milena/ChangeLog index e906a63..63c3c65 100644 --- a/milena/ChangeLog +++ b/milena/ChangeLog @@ -1,5 +1,13 @@ 2010-03-08 Roland Levillain <roland(a)lrde.epita.fr> + Reorganize doc/Makefile.am. + + * doc/Makefile.am (edit, $(DOXYFILE_USER)): + Move these definitions closer to their use site. + (edit_devel, $(DOXYFILE_DEVEL)): Likewise. + +2010-03-08 Roland Levillain <roland(a)lrde.epita.fr> + Have Doxyfile.in generate the user documentation. * doc/Doxyfile.in: Switch settings to generate the user diff --git a/milena/doc/Makefile.am b/milena/doc/Makefile.am index 1126881..d53c208 100644 --- a/milena/doc/Makefile.am +++ b/milena/doc/Makefile.am @@ -79,6 +79,25 @@ regen-doc: DOXYFILE_USER = Doxyfile_user +# 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. See Bison's build system. +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' + +$(DOXYFILE_USER): $(srcdir)/$(DOXYFILE).in + Id=`grep '^\$$Id' $(top_srcdir)/milena/ChangeLog \ + | sed -e 's/\\\$$//g'`; \ + $(edit) $< >$@ + ## FIXME: Rename USER_REFMAN_PDF to something else? USER_REFMAN_PDF = user-refman.pdf ## FIXME: Likewise? @@ -134,6 +153,29 @@ regen-devel-doc: DOXYFILE_DEVEL = Doxyfile_devel +edit_devel = sed \ + -e 's,OUTPUT_DIRECTORY = @srcdir@/user/,OUTPUT_DIRECTORY = @srcdir@/devel/,' \ + -e 's,EXTRACT_ALL = NO,EXTRACT_ALL = YES,' \ + -e 's,EXTRACT_PRIVATE = NO,EXTRACT_PRIVATE = YES,' \ + -e 's,EXTRACT_STATIC = NO,EXTRACT_STATIC = YES,' \ + -e 's,EXTRACT_LOCAL_CLASSES = NO,EXTRACT_LOCAL_CLASSES = YES,' \ + -e 's,HIDE_UNDOC_MEMBERS = YES,HIDE_UNDOC_MEMBERS = NO,' \ + -e 's,HIDE_UNDOC_CLASSES = YES,HIDE_UNDOC_CLASSES = NO,' \ + -e 's,HIDE_FRIEND_COMPOUNDS = YES,HIDE_FRIEND_COMPOUNDS = NO,' \ + -e 's,HIDE_IN_BODY_DOCS = YES,HIDE_IN_BODY_DOCS = NO,' \ + -e 's,INTERNAL_DOCS = NO,INTERNAL_DOCS = YES,' \ + -e 's,GENERATE_TODOLIST = NO,GENERATE_TODOLIST = YES,' \ + -e 's,PROJECT_NUMBER = \"User documentation ,PROJECT_NUMBER = \",' \ + -e 's,EXCLUDE_SYMBOLS = \*::internal\* \*_ mln::trait::\*,EXCLUDE_SYMBOLS =,' + +$(DOXYFILE_DEVEL): $(srcdir)/$(DOXYFILE).in + rm -f $@.tmp + Id=`grep '^\$$Id' $(top_srcdir)/milena/ChangeLog \ + | sed -e 's/\\\$$//g'`; \ + $(edit) $< >$@.tmp + $(edit_devel) $@.tmp >$@ + rm -f $@.tmp + ## FIXME: Rename DEVEL_REFMAN_PDF to something else? DEVEL_REFMAN_PDF = devel-refman-pdf ## FIXME: Likewise? @@ -334,48 +376,3 @@ EXTRA_DIST += \ MAINTAINERCLEANFILES = \ Doxyfile_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' - -edit_devel = sed \ - -e 's,OUTPUT_DIRECTORY = @srcdir@/user/,OUTPUT_DIRECTORY = @srcdir@/devel/,' \ - -e 's,EXTRACT_ALL = NO,EXTRACT_ALL = YES,' \ - -e 's,EXTRACT_PRIVATE = NO,EXTRACT_PRIVATE = YES,' \ - -e 's,EXTRACT_STATIC = NO,EXTRACT_STATIC = YES,' \ - -e 's,EXTRACT_LOCAL_CLASSES = NO,EXTRACT_LOCAL_CLASSES = YES,' \ - -e 's,HIDE_UNDOC_MEMBERS = YES,HIDE_UNDOC_MEMBERS = NO,' \ - -e 's,HIDE_UNDOC_CLASSES = YES,HIDE_UNDOC_CLASSES = NO,' \ - -e 's,HIDE_FRIEND_COMPOUNDS = YES,HIDE_FRIEND_COMPOUNDS = NO,' \ - -e 's,HIDE_IN_BODY_DOCS = YES,HIDE_IN_BODY_DOCS = NO,' \ - -e 's,INTERNAL_DOCS = NO,INTERNAL_DOCS = YES,' \ - -e 's,GENERATE_TODOLIST = NO,GENERATE_TODOLIST = YES,' \ - -e 's,PROJECT_NUMBER = \"User documentation ,PROJECT_NUMBER = \",' \ - -e 's,EXCLUDE_SYMBOLS = \*::internal\* \*_ mln::trait::\*,EXCLUDE_SYMBOLS =,' - -# 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. See Bison's build system. -## -## FIXME: Move these rules higher, closer to their use sites. - -$(DOXYFILE_USER): $(srcdir)/$(DOXYFILE).in - Id=`grep '^\$$Id' $(top_srcdir)/milena/ChangeLog \ - | sed -e 's/\\\$$//g'`; \ - $(edit) $< >$@ - -$(DOXYFILE_DEVEL): $(srcdir)/$(DOXYFILE).in - rm -f $@.tmp - Id=`grep '^\$$Id' $(top_srcdir)/milena/ChangeLog \ - | sed -e 's/\\\$$//g'`; \ - $(edit) $< >$@.tmp - $(edit_devel) $@.tmp >$@ - rm -f $@.tmp -- 1.5.6.5

14 years, 2 months

last-svn-commit-22-g121d1e6 Have Doxyfile.in generate the user documentation.

by Roland Levillain

* doc/Doxyfile.in: Switch settings to generate the user documentation. * doc/Makefile.am (edit_user): Remove variable. (edit_devel): New variable. ($(DOXYFILE_USER)): Generate it directly from $(srcdir)/$(DOXYFILE).in. ($(DOXYFILE_DEVEL)): Adjust to use edit_devel. --- milena/ChangeLog | 12 ++++++++++++ milena/doc/Doxyfile.in | 26 +++++++++++++------------- milena/doc/Makefile.am | 46 ++++++++++++++++++++++------------------------ 3 files changed, 47 insertions(+), 37 deletions(-) diff --git a/milena/ChangeLog b/milena/ChangeLog index ff3af38..e906a63 100644 --- a/milena/ChangeLog +++ b/milena/ChangeLog @@ -1,5 +1,17 @@ 2010-03-08 Roland Levillain <roland(a)lrde.epita.fr> + Have Doxyfile.in generate the user documentation. + + * doc/Doxyfile.in: Switch settings to generate the user + documentation. + * doc/Makefile.am (edit_user): Remove variable. + (edit_devel): New variable. + ($(DOXYFILE_USER)): Generate it directly from + $(srcdir)/$(DOXYFILE).in. + ($(DOXYFILE_DEVEL)): Adjust to use edit_devel. + +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. diff --git a/milena/doc/Doxyfile.in b/milena/doc/Doxyfile.in index 505480a..a8c3400 100644 --- a/milena/doc/Doxyfile.in +++ b/milena/doc/Doxyfile.in @@ -21,8 +21,8 @@ # Project related configuration options #--------------------------------------------------------------------------- PROJECT_NAME = "Milena (@PACKAGE_NAME@)" -PROJECT_NUMBER = "@PACKAGE_VERSION@ @ID@" -OUTPUT_DIRECTORY = @srcdir@/devel/ +PROJECT_NUMBER = "User documentation @PACKAGE_VERSION@ @ID@" +OUTPUT_DIRECTORY = @srcdir@/user/ CREATE_SUBDIRS = YES OUTPUT_LANGUAGE = English BRIEF_MEMBER_DESC = YES @@ -50,16 +50,16 @@ SUBGROUPING = YES #--------------------------------------------------------------------------- # Build related configuration options #--------------------------------------------------------------------------- -EXTRACT_ALL = YES -EXTRACT_PRIVATE = YES -EXTRACT_STATIC = YES -EXTRACT_LOCAL_CLASSES = YES +EXTRACT_ALL = NO +EXTRACT_PRIVATE = NO +EXTRACT_STATIC = NO +EXTRACT_LOCAL_CLASSES = NO EXTRACT_LOCAL_METHODS = NO -HIDE_UNDOC_MEMBERS = NO -HIDE_UNDOC_CLASSES = NO -HIDE_FRIEND_COMPOUNDS = NO -HIDE_IN_BODY_DOCS = NO -INTERNAL_DOCS = YES +HIDE_UNDOC_MEMBERS = YES +HIDE_UNDOC_CLASSES = YES +HIDE_FRIEND_COMPOUNDS = YES +HIDE_IN_BODY_DOCS = YES +INTERNAL_DOCS = NO CASE_SENSE_NAMES = YES HIDE_SCOPE_NAMES = NO SHOW_INCLUDE_FILES = YES @@ -67,7 +67,7 @@ INLINE_INFO = YES SORT_MEMBER_DOCS = YES SORT_BRIEF_DOCS = YES SORT_BY_SCOPE_NAME = YES -GENERATE_TODOLIST = YES +GENERATE_TODOLIST = NO GENERATE_TESTLIST = YES GENERATE_BUGLIST = YES GENERATE_DEPRECATEDLIST= YES @@ -108,7 +108,7 @@ EXCLUDE = @top_srcdir@/milena/sandbox \ @top_srcdir@/milena/tests/unit_test EXCLUDE_SYMLINKS = YES EXCLUDE_PATTERNS = *spe.hh -EXCLUDE_SYMBOLS = +EXCLUDE_SYMBOLS = *::internal* *_ mln::trait::* EXAMPLE_PATH = @top_srcdir@/milena/doc/examples \ @top_srcdir@/milena/doc/outputs \ @top_srcdir@/milena/doc/examples/split \ diff --git a/milena/doc/Makefile.am b/milena/doc/Makefile.am index b37044f..1126881 100644 --- a/milena/doc/Makefile.am +++ b/milena/doc/Makefile.am @@ -343,24 +343,20 @@ edit = sed -e "s|@ID@|$$Id|" \ -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' +edit_devel = sed \ + -e 's,OUTPUT_DIRECTORY = @srcdir@/user/,OUTPUT_DIRECTORY = @srcdir@/devel/,' \ + -e 's,EXTRACT_ALL = NO,EXTRACT_ALL = YES,' \ + -e 's,EXTRACT_PRIVATE = NO,EXTRACT_PRIVATE = YES,' \ + -e 's,EXTRACT_STATIC = NO,EXTRACT_STATIC = YES,' \ + -e 's,EXTRACT_LOCAL_CLASSES = NO,EXTRACT_LOCAL_CLASSES = YES,' \ + -e 's,HIDE_UNDOC_MEMBERS = YES,HIDE_UNDOC_MEMBERS = NO,' \ + -e 's,HIDE_UNDOC_CLASSES = YES,HIDE_UNDOC_CLASSES = NO,' \ + -e 's,HIDE_FRIEND_COMPOUNDS = YES,HIDE_FRIEND_COMPOUNDS = NO,' \ + -e 's,HIDE_IN_BODY_DOCS = YES,HIDE_IN_BODY_DOCS = NO,' \ + -e 's,INTERNAL_DOCS = NO,INTERNAL_DOCS = YES,' \ + -e 's,GENERATE_TODOLIST = NO,GENERATE_TODOLIST = YES,' \ + -e 's,PROJECT_NUMBER = \"User documentation ,PROJECT_NUMBER = \",' \ + -e 's,EXCLUDE_SYMBOLS = \*::internal\* \*_ mln::trait::\*,EXCLUDE_SYMBOLS =,' # Sed is used to generate Doxyfile from Doxyfile.in instead of # configure, because the former is way faster than the latter. @@ -370,14 +366,16 @@ edit_user = sed \ ## change. See Bison's build system. ## ## FIXME: Move these rules higher, closer to their use sites. -## -## FIXME: It'd be more logical to generate $(DOXYFILE_DEVEL) from -## $(DOXYFILE_USER), not the reverse. -$(DOXYFILE_USER): $(DOXYFILE_DEVEL) - $(edit_user) $< >$@ +$(DOXYFILE_USER): $(srcdir)/$(DOXYFILE).in + Id=`grep '^\$$Id' $(top_srcdir)/milena/ChangeLog \ + | sed -e 's/\\\$$//g'`; \ + $(edit) $< >$@ $(DOXYFILE_DEVEL): $(srcdir)/$(DOXYFILE).in + rm -f $@.tmp Id=`grep '^\$$Id' $(top_srcdir)/milena/ChangeLog \ | sed -e 's/\\\$$//g'`; \ - $(edit) $< >$@ + $(edit) $< >$@.tmp + $(edit_devel) $@.tmp >$@ + rm -f $@.tmp -- 1.5.6.5

14 years, 2 months

last-svn-commit-21-g443d804 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 e3a2d70..ff3af38 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, 2 months

last-svn-commit-17-g9391217 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 77ea1a1..c4bb5d5 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, 2 months

last-svn-commit-16-g7bc6643 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 89fa68f..0657f50 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, 2 months

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 March 2010