- Olena-patches

last-svn-commit-103-g1d78b38 Use finer installation variables.
by Roland Levillain 23 Mar '10

23 Mar '10

* doc/Makefile.am (dist_doc_DATA): Remove variable. (dist_html_DATA, dist_pdf_DATA): New variables. (MAINTAINERCLEANFILES): Remove $(TECHNICAL_HTML_OUTPUTS), $(TECHNICAL_PDF), $(TUTORIAL_HTML_OUTPUTS), $(TUTORIAL_PDF), $(WHITE_PAPER_HTML_OUTPUTS), $(WHITE_PAPER_PDF), $(REF_GUIDE_HTML_OUTPUTS), $(REF_GUIDE_PDF) and $(USER_REFMAN_PDF). Add $(dist_html_DATA) and $(dist_pdf_DATA). --- milena/ChangeLog | 14 ++++++++++++++ milena/doc/Makefile.am | 35 +++++++++++++---------------------- 2 files changed, 27 insertions(+), 22 deletions(-) diff --git a/milena/ChangeLog b/milena/ChangeLog index 31bb431..94876f6 100644 --- a/milena/ChangeLog +++ b/milena/ChangeLog @@ -1,5 +1,19 @@ 2010-03-23 Roland Levillain <roland(a)lrde.epita.fr> + Use finer installation variables. + + * doc/Makefile.am (dist_doc_DATA): Remove variable. + (dist_html_DATA, dist_pdf_DATA): New variables. + (MAINTAINERCLEANFILES): + Remove $(TECHNICAL_HTML_OUTPUTS), $(TECHNICAL_PDF), + $(TUTORIAL_HTML_OUTPUTS), $(TUTORIAL_PDF), + $(WHITE_PAPER_HTML_OUTPUTS), $(WHITE_PAPER_PDF), + $(REF_GUIDE_HTML_OUTPUTS), $(REF_GUIDE_PDF) and + $(USER_REFMAN_PDF). + Add $(dist_html_DATA) and $(dist_pdf_DATA). + +2010-03-23 Roland Levillain <roland(a)lrde.epita.fr> + Simplify doc/Makefile.am. * doc/Makefile.am: diff --git a/milena/doc/Makefile.am b/milena/doc/Makefile.am index 0b285c7..b40e80c 100644 --- a/milena/doc/Makefile.am +++ b/milena/doc/Makefile.am @@ -27,10 +27,6 @@ DOXYGEN = doxygen DOXYFILE = Doxyfile -# Initialiaze variables. -EXTRA_DIST = -dist_doc_DATA = - ## --------------------- ## ## LaTeX configuration. ## @@ -52,7 +48,7 @@ DOC_PACKAGES = doxyfuns.sty milena.sty ## --------- ## # Generate a Makefile helper containing the list of generated figures. -EXTRA_DIST += gen-figures-mk +EXTRA_DIST = gen-figures-mk $(srcdir)/figures.mk: $(srcdir)/gen-figures-mk rm -f $@.tmp cd $(srcdir) && ./gen-figures-mk >figures.mk.tmp @@ -355,8 +351,7 @@ $(TECHNICAL_HTML_OUTPUTS): $(TECHNICAL_HTML).stamp $(MAKE) $(AM_MAKEFLAGS) $<; \ fi -dist_doc_DATA += $(TECHNICAL_HTML_OUTPUTS) -MAINTAINERCLEANFILES += $(TECHNICAL_HTML_OUTPUTS) +dist_html_DATA = $(TECHNICAL_HTML_OUTPUTS) ## FIXME: technical technical.hh does not seem to be used (by the ## Doyxgen documentation); remove its generation? Careful, @@ -384,8 +379,7 @@ TECHNICAL_PDF = $(technical_dir)/technical.pdf # Extra dependencies. $(TECHNICAL_PDF): $(technical_dependencies) -dist_doc_DATA += $(TECHNICAL_PDF) -MAINTAINERCLEANFILES += $(TECHNICAL_PDF) +dist_pdf_DATA = $(TECHNICAL_PDF) EXTRA_DIST += \ $(technical_dir)/technical.tex \ @@ -429,8 +423,7 @@ $(TUTORIAL_HTML_OUTPUTS): $(TUTORIAL_HTML).stamp $(MAKE) $(AM_MAKEFLAGS) $<; \ fi -dist_doc_DATA += $(TUTORIAL_HTML_OUTPUTS) -MAINTAINERCLEANFILES += $(TUTORIAL_HTML_OUTPUTS) +dist_html_DATA += $(TUTORIAL_HTML_OUTPUTS) # Intermediate product for the various doc targets of the parent # directory. @@ -454,8 +447,7 @@ TUTORIAL_PDF = $(tutorial_dir)/tutorial.pdf # Extra dependencies. $(TUTORIAL_PDF): $(tutorial_dependencies) -dist_doc_DATA += $(TUTORIAL_PDF) -MAINTAINERCLEANFILES += $(TUTORIAL_PDF) +dist_pdf_DATA += $(TUTORIAL_PDF) EXTRA_DIST += \ $(tutorial_dir)/tutorial.tex \ @@ -509,15 +501,13 @@ $(WHITE_PAPER_HTML_OUTPUTS): $(WHITE_PAPER_HTML).stamp $(MAKE) $(AM_MAKEFLAGS) $<; \ fi -dist_doc_DATA += $(WHITE_PAPER_HTML_OUTPUTS) -MAINTAINERCLEANFILES += $(WHITE_PAPER_HTML_OUTPUTS) +dist_html_DATA += $(WHITE_PAPER_HTML_OUTPUTS) WHITE_PAPER_PDF = $(white_paper_dir)/white_paper.pdf # Extra dependencies. $(WHITE_PAPER_PDF): $(PNGS) -dist_doc_DATA += $(WHITE_PAPER_PDF) -MAINTAINERCLEANFILES += $(WHITE_PAPER_PDF) +dist_pdf_DATA += $(WHITE_PAPER_PDF) EXTRA_DIST += \ $(white_paper_dir)/white_paper.tex \ @@ -566,8 +556,7 @@ $(REF_GUIDE_HTML_OUTPUTS): $(REF_GUIDE_HTML).stamp $(MAKE) $(AM_MAKEFLAGS) $<; \ fi -dist_doc_DATA += $(REF_GUIDE_HTML_OUTPUTS) -MAINTAINERCLEANFILES += $(REF_GUIDE_HTML_OUTPUTS) +dist_html_DATA += $(REF_GUIDE_HTML_OUTPUTS) # Intermediate product for the various doc targets of the parent # directory. @@ -591,8 +580,7 @@ REF_GUIDE_PDF = $(ref_guide_dir)/ref_guide.pdf # Extra dependencies. $(REF_GUIDE_PDF): $(ref_guide_dependencies) -dist_doc_DATA += $(REF_GUIDE_PDF) -MAINTAINERCLEANFILES += $(REF_GUIDE_PDF) +dist_pdf_DATA += $(REF_GUIDE_PDF) EXTRA_DIST += \ $(ref_guide_dir)/ref_guide.tex \ @@ -729,7 +717,7 @@ regen-am: ## -------------- ## # PDF. -dist_doc_DATA += $(USER_REFMAN_PDF) +dist_pdf_DATA += $(USER_REFMAN_PDF) # HTML. # Installing a directory located in the source dir is not supported by @@ -756,6 +744,9 @@ uninstall-local: rm -rf $(DESTDIR)$(htmldir)/user-refman +MAINTAINERCLEANFILES += $(dist_html_DATA) $(dist_pdf_DATA) + + EXTRA_DIST += \ $(DOXYFILE).in \ groups/accu.hh \ -- 1.5.6.5

1 0

last-svn-commit-110-g5025e33 Use finer installation variables.
by Roland Levillain 23 Mar '10

23 Mar '10

* doc/Makefile.am (dist_doc_DATA): Remove variable. (dist_html_DATA, dist_pdf_DATA): New variables. (MAINTAINERCLEANFILES): Remove $(TECHNICAL_HTML_OUTPUTS), $(TECHNICAL_PDF), $(TUTORIAL_HTML_OUTPUTS), $(TUTORIAL_PDF), $(WHITE_PAPER_HTML_OUTPUTS), $(WHITE_PAPER_PDF), $(REF_GUIDE_HTML_OUTPUTS), $(REF_GUIDE_PDF) and $(USER_REFMAN_PDF). Add $(dist_html_DATA) and $(dist_pdf_DATA). --- milena/ChangeLog | 14 ++++++++++++++ milena/doc/Makefile.am | 35 +++++++++++++---------------------- 2 files changed, 27 insertions(+), 22 deletions(-) diff --git a/milena/ChangeLog b/milena/ChangeLog index 7f79637..aafefe6 100644 --- a/milena/ChangeLog +++ b/milena/ChangeLog @@ -1,5 +1,19 @@ 2010-03-23 Roland Levillain <roland(a)lrde.epita.fr> + Use finer installation variables. + + * doc/Makefile.am (dist_doc_DATA): Remove variable. + (dist_html_DATA, dist_pdf_DATA): New variables. + (MAINTAINERCLEANFILES): + Remove $(TECHNICAL_HTML_OUTPUTS), $(TECHNICAL_PDF), + $(TUTORIAL_HTML_OUTPUTS), $(TUTORIAL_PDF), + $(WHITE_PAPER_HTML_OUTPUTS), $(WHITE_PAPER_PDF), + $(REF_GUIDE_HTML_OUTPUTS), $(REF_GUIDE_PDF) and + $(USER_REFMAN_PDF). + Add $(dist_html_DATA) and $(dist_pdf_DATA). + +2010-03-23 Roland Levillain <roland(a)lrde.epita.fr> + Simplify doc/Makefile.am. * doc/Makefile.am: diff --git a/milena/doc/Makefile.am b/milena/doc/Makefile.am index 0b285c7..b40e80c 100644 --- a/milena/doc/Makefile.am +++ b/milena/doc/Makefile.am @@ -27,10 +27,6 @@ DOXYGEN = doxygen DOXYFILE = Doxyfile -# Initialiaze variables. -EXTRA_DIST = -dist_doc_DATA = - ## --------------------- ## ## LaTeX configuration. ## @@ -52,7 +48,7 @@ DOC_PACKAGES = doxyfuns.sty milena.sty ## --------- ## # Generate a Makefile helper containing the list of generated figures. -EXTRA_DIST += gen-figures-mk +EXTRA_DIST = gen-figures-mk $(srcdir)/figures.mk: $(srcdir)/gen-figures-mk rm -f $@.tmp cd $(srcdir) && ./gen-figures-mk >figures.mk.tmp @@ -355,8 +351,7 @@ $(TECHNICAL_HTML_OUTPUTS): $(TECHNICAL_HTML).stamp $(MAKE) $(AM_MAKEFLAGS) $<; \ fi -dist_doc_DATA += $(TECHNICAL_HTML_OUTPUTS) -MAINTAINERCLEANFILES += $(TECHNICAL_HTML_OUTPUTS) +dist_html_DATA = $(TECHNICAL_HTML_OUTPUTS) ## FIXME: technical technical.hh does not seem to be used (by the ## Doyxgen documentation); remove its generation? Careful, @@ -384,8 +379,7 @@ TECHNICAL_PDF = $(technical_dir)/technical.pdf # Extra dependencies. $(TECHNICAL_PDF): $(technical_dependencies) -dist_doc_DATA += $(TECHNICAL_PDF) -MAINTAINERCLEANFILES += $(TECHNICAL_PDF) +dist_pdf_DATA = $(TECHNICAL_PDF) EXTRA_DIST += \ $(technical_dir)/technical.tex \ @@ -429,8 +423,7 @@ $(TUTORIAL_HTML_OUTPUTS): $(TUTORIAL_HTML).stamp $(MAKE) $(AM_MAKEFLAGS) $<; \ fi -dist_doc_DATA += $(TUTORIAL_HTML_OUTPUTS) -MAINTAINERCLEANFILES += $(TUTORIAL_HTML_OUTPUTS) +dist_html_DATA += $(TUTORIAL_HTML_OUTPUTS) # Intermediate product for the various doc targets of the parent # directory. @@ -454,8 +447,7 @@ TUTORIAL_PDF = $(tutorial_dir)/tutorial.pdf # Extra dependencies. $(TUTORIAL_PDF): $(tutorial_dependencies) -dist_doc_DATA += $(TUTORIAL_PDF) -MAINTAINERCLEANFILES += $(TUTORIAL_PDF) +dist_pdf_DATA += $(TUTORIAL_PDF) EXTRA_DIST += \ $(tutorial_dir)/tutorial.tex \ @@ -509,15 +501,13 @@ $(WHITE_PAPER_HTML_OUTPUTS): $(WHITE_PAPER_HTML).stamp $(MAKE) $(AM_MAKEFLAGS) $<; \ fi -dist_doc_DATA += $(WHITE_PAPER_HTML_OUTPUTS) -MAINTAINERCLEANFILES += $(WHITE_PAPER_HTML_OUTPUTS) +dist_html_DATA += $(WHITE_PAPER_HTML_OUTPUTS) WHITE_PAPER_PDF = $(white_paper_dir)/white_paper.pdf # Extra dependencies. $(WHITE_PAPER_PDF): $(PNGS) -dist_doc_DATA += $(WHITE_PAPER_PDF) -MAINTAINERCLEANFILES += $(WHITE_PAPER_PDF) +dist_pdf_DATA += $(WHITE_PAPER_PDF) EXTRA_DIST += \ $(white_paper_dir)/white_paper.tex \ @@ -566,8 +556,7 @@ $(REF_GUIDE_HTML_OUTPUTS): $(REF_GUIDE_HTML).stamp $(MAKE) $(AM_MAKEFLAGS) $<; \ fi -dist_doc_DATA += $(REF_GUIDE_HTML_OUTPUTS) -MAINTAINERCLEANFILES += $(REF_GUIDE_HTML_OUTPUTS) +dist_html_DATA += $(REF_GUIDE_HTML_OUTPUTS) # Intermediate product for the various doc targets of the parent # directory. @@ -591,8 +580,7 @@ REF_GUIDE_PDF = $(ref_guide_dir)/ref_guide.pdf # Extra dependencies. $(REF_GUIDE_PDF): $(ref_guide_dependencies) -dist_doc_DATA += $(REF_GUIDE_PDF) -MAINTAINERCLEANFILES += $(REF_GUIDE_PDF) +dist_pdf_DATA += $(REF_GUIDE_PDF) EXTRA_DIST += \ $(ref_guide_dir)/ref_guide.tex \ @@ -729,7 +717,7 @@ regen-am: ## -------------- ## # PDF. -dist_doc_DATA += $(USER_REFMAN_PDF) +dist_pdf_DATA += $(USER_REFMAN_PDF) # HTML. # Installing a directory located in the source dir is not supported by @@ -756,6 +744,9 @@ uninstall-local: rm -rf $(DESTDIR)$(htmldir)/user-refman +MAINTAINERCLEANFILES += $(dist_html_DATA) $(dist_pdf_DATA) + + EXTRA_DIST += \ $(DOXYFILE).in \ groups/accu.hh \ -- 1.5.6.5

1 0

last-svn-commit-102-g5ec3f5f Simplify doc/Makefile.am.
by Roland Levillain 23 Mar '10

23 Mar '10

* doc/Makefile.am: (DOC_SRCDIR, OUTPUTS_SRCDIR, SPLIT_OUTPUTS_SRCDIR, FIGURES_SRCDIR) (EXAMPLES_SRCDIR, SPLIT_EXAMPLES_SRCDIR, IMG_SRCDIR, doc_dir): Remove variables. Adjust. --- milena/ChangeLog | 10 ++++++++++ milena/doc/Makefile.am | 44 ++++++++++++-------------------------------- 2 files changed, 22 insertions(+), 32 deletions(-) diff --git a/milena/ChangeLog b/milena/ChangeLog index 8281219..31bb431 100644 --- a/milena/ChangeLog +++ b/milena/ChangeLog @@ -1,5 +1,15 @@ 2010-03-23 Roland Levillain <roland(a)lrde.epita.fr> + Simplify doc/Makefile.am. + + * doc/Makefile.am: + (DOC_SRCDIR, OUTPUTS_SRCDIR, SPLIT_OUTPUTS_SRCDIR, FIGURES_SRCDIR) + (EXAMPLES_SRCDIR, SPLIT_EXAMPLES_SRCDIR, IMG_SRCDIR, doc_dir): + Remove variables. + Adjust. + +2010-03-23 Roland Levillain <roland(a)lrde.epita.fr> + * doc/Makefile.am: Update FIXMEs. 2010-03-23 Roland Levillain <roland(a)lrde.epita.fr> diff --git a/milena/doc/Makefile.am b/milena/doc/Makefile.am index a505170..0b285c7 100644 --- a/milena/doc/Makefile.am +++ b/milena/doc/Makefile.am @@ -23,26 +23,6 @@ AM_CPPFLAGS = \ -I$(top_srcdir)/milena -I$(top_builddir)/milena \ -I$(top_srcdir)/milena/doc/tutorial/tools -## FIXME: Upercase variables should be reserved for special names: -## classical Make variables (e.g. `CXXFLAGS') Automake variables -## (e.g. `SUBDIRS'), etc. -## -## Moreover, do we really need all these variables? See how things -## evolve during the refurbishing of the build system in doc/. -DOC_SRCDIR = $(top_srcdir)/milena/doc -OUTPUTS_SRCDIR = $(DOC_SRCDIR)/outputs -SPLIT_OUTPUTS_SRCDIR = $(OUTPUTS_SRCDIR)/split -FIGURES_SRCDIR = $(DOC_SRCDIR)/figures -EXAMPLES_SRCDIR = $(DOC_SRCDIR)/examples -SPLIT_EXAMPLES_SRCDIR = $(EXAMPLES_SRCDIR)/split -IMG_SRCDIR = $(DOC_SRCDIR)/img - -# FIXME: Adjust when $(DOC_SRCDIR) is renamed or removed. -# -# FIXME: Careful, `doc_dir' is close to `docdir', which is reserved by -# Automake. Change this name? -doc_dir = $(DOC_SRCDIR) - DOXYGEN = doxygen DOXYFILE = Doxyfile @@ -60,8 +40,8 @@ include $(top_srcdir)/build-aux/tex.mk # FIXME: Check this list. TEXI2DVI_FLAGS += \ - -I $(DOC_SRCDIR) -I $(OUTPUTS_SRCDIR) -I $(SPLIT_OUTPUTS_SRCDIR) \ - -I $(IMG_SRCDIR) -I $(SPLIT_EXAMPLES_SRCDIR) + -I $(srcdir) -I $(srcdir)/outputs -I $(srcdir)/outputs/split \ + -I $(srcdir)/img -I $(srcdir)/examples/split # Additional files for LaTeX compilations. DOC_PACKAGES = doxyfuns.sty milena.sty @@ -346,7 +326,7 @@ maintainer-clean-local: ## Technical Documentation. ## ## ------------------------- ## -technical_dir = $(doc_dir)/technical +technical_dir = $(srcdir)/technical technical_dependencies = \ $(TECHNICAL_EXAMPLES) \ @@ -389,13 +369,13 @@ MAINTAINERCLEANFILES += $(TECHNICAL_HTML_OUTPUTS) # extension, since it is later parsed by Doxygen, which complains # about `.html' files. TECHNICAL_HH = $(technical_dir)/technical.hh -$(TECHNICAL_HH): $(TECHNICAL_HTML) $(doc_dir)/tools/todoxygen.sh +$(TECHNICAL_HH): $(TECHNICAL_HTML) $(srcdir)/tools/todoxygen.sh # The script `todoxygen.sh' may fail and still create a (partial and # invalid) file, thus preventing Make from trying to generate it # again. The solution is to use a temporary file as output and rename # it if the script succeeds. rm -f $@.tmp - $(doc_dir)/tools/todoxygen.sh $< $@.tmp $(doc_dir) + $(srcdir)/tools/todoxygen.sh $< $@.tmp $(srcdir) mv -f $@.tmp $@ @@ -417,7 +397,7 @@ MAINTAINERCLEANFILES += $(TECHNICAL_HH) ## Tutorial. ## ## ---------- ## -tutorial_dir = $(doc_dir)/tutorial +tutorial_dir = $(srcdir)/tutorial tutorial_dependencies = \ $(EXAMPLES) \ @@ -459,13 +439,13 @@ MAINTAINERCLEANFILES += $(TUTORIAL_HTML_OUTPUTS) # since it is later parsed by Doxygen, which complains about `.html' # files. TUTORIAL_HH = $(tutorial_dir)/tutorial.hh -$(TUTORIAL_HH): $(TUTORIAL_HTML) $(doc_dir)/tools/todoxygen.sh +$(TUTORIAL_HH): $(TUTORIAL_HTML) $(srcdir)/tools/todoxygen.sh # The script `todoxygen.sh' may fail and still create a (partial and # invalid) file, thus preventing Make from trying to generate it # again. The solution is to use a temporary file as output and rename # it if the script succeeds. rm -f $@.tmp - $(doc_dir)/tools/todoxygen.sh $< $@.tmp $(doc_dir) + $(srcdir)/tools/todoxygen.sh $< $@.tmp $(srcdir) mv -f $@.tmp $@ @@ -488,7 +468,7 @@ MAINTAINERCLEANFILES += $(TUTORIAL_HH) ## White Paper. ## ## ------------- ## -white_paper_dir = $(doc_dir)/white_paper +white_paper_dir = $(srcdir)/white_paper PNGS = \ $(white_paper_dir)/figures/house.png \ @@ -551,7 +531,7 @@ MAINTAINERCLEANFILES += $(EPSS) ## Reference Guide. ## ## ----------------- ## -ref_guide_dir = $(doc_dir)/ref_guide +ref_guide_dir = $(srcdir)/ref_guide ref_guide_dependencies = \ $(EXAMPLES) \ @@ -596,13 +576,13 @@ MAINTAINERCLEANFILES += $(REF_GUIDE_HTML_OUTPUTS) # since it is later parsed by Doxygen, which complains about `.html' # files. REF_GUIDE_HH = $(ref_guide_dir)/ref_guide.hh -$(REF_GUIDE_HH): $(REF_GUIDE_HTML) $(doc_dir)/tools/todoxygen.sh +$(REF_GUIDE_HH): $(REF_GUIDE_HTML) $(srcdir)/tools/todoxygen.sh # The script `todoxygen.sh' may fail and still create a (partial and # invalid) file, thus preventing Make from trying to generate it # again. The solution is to use a temporary file as output and rename # it if the script succeeds. rm -f $@.tmp - $(doc_dir)/tools/todoxygen.sh $< $@.tmp $(doc_dir) + $(srcdir)/tools/todoxygen.sh $< $@.tmp $(srcdir) mv -f $@.tmp $@ -- 1.5.6.5

1 0

last-svn-commit-109-gb6b3517 Simplify doc/Makefile.am.
by Roland Levillain 23 Mar '10

23 Mar '10

* doc/Makefile.am: (DOC_SRCDIR, OUTPUTS_SRCDIR, SPLIT_OUTPUTS_SRCDIR, FIGURES_SRCDIR) (EXAMPLES_SRCDIR, SPLIT_EXAMPLES_SRCDIR, IMG_SRCDIR, doc_dir): Remove variables. Adjust. --- milena/ChangeLog | 10 ++++++++++ milena/doc/Makefile.am | 44 ++++++++++++-------------------------------- 2 files changed, 22 insertions(+), 32 deletions(-) diff --git a/milena/ChangeLog b/milena/ChangeLog index 56e23ba..7f79637 100644 --- a/milena/ChangeLog +++ b/milena/ChangeLog @@ -1,5 +1,15 @@ 2010-03-23 Roland Levillain <roland(a)lrde.epita.fr> + Simplify doc/Makefile.am. + + * doc/Makefile.am: + (DOC_SRCDIR, OUTPUTS_SRCDIR, SPLIT_OUTPUTS_SRCDIR, FIGURES_SRCDIR) + (EXAMPLES_SRCDIR, SPLIT_EXAMPLES_SRCDIR, IMG_SRCDIR, doc_dir): + Remove variables. + Adjust. + +2010-03-23 Roland Levillain <roland(a)lrde.epita.fr> + * doc/Makefile.am: Update FIXMEs. 2010-03-23 Roland Levillain <roland(a)lrde.epita.fr> diff --git a/milena/doc/Makefile.am b/milena/doc/Makefile.am index a505170..0b285c7 100644 --- a/milena/doc/Makefile.am +++ b/milena/doc/Makefile.am @@ -23,26 +23,6 @@ AM_CPPFLAGS = \ -I$(top_srcdir)/milena -I$(top_builddir)/milena \ -I$(top_srcdir)/milena/doc/tutorial/tools -## FIXME: Upercase variables should be reserved for special names: -## classical Make variables (e.g. `CXXFLAGS') Automake variables -## (e.g. `SUBDIRS'), etc. -## -## Moreover, do we really need all these variables? See how things -## evolve during the refurbishing of the build system in doc/. -DOC_SRCDIR = $(top_srcdir)/milena/doc -OUTPUTS_SRCDIR = $(DOC_SRCDIR)/outputs -SPLIT_OUTPUTS_SRCDIR = $(OUTPUTS_SRCDIR)/split -FIGURES_SRCDIR = $(DOC_SRCDIR)/figures -EXAMPLES_SRCDIR = $(DOC_SRCDIR)/examples -SPLIT_EXAMPLES_SRCDIR = $(EXAMPLES_SRCDIR)/split -IMG_SRCDIR = $(DOC_SRCDIR)/img - -# FIXME: Adjust when $(DOC_SRCDIR) is renamed or removed. -# -# FIXME: Careful, `doc_dir' is close to `docdir', which is reserved by -# Automake. Change this name? -doc_dir = $(DOC_SRCDIR) - DOXYGEN = doxygen DOXYFILE = Doxyfile @@ -60,8 +40,8 @@ include $(top_srcdir)/build-aux/tex.mk # FIXME: Check this list. TEXI2DVI_FLAGS += \ - -I $(DOC_SRCDIR) -I $(OUTPUTS_SRCDIR) -I $(SPLIT_OUTPUTS_SRCDIR) \ - -I $(IMG_SRCDIR) -I $(SPLIT_EXAMPLES_SRCDIR) + -I $(srcdir) -I $(srcdir)/outputs -I $(srcdir)/outputs/split \ + -I $(srcdir)/img -I $(srcdir)/examples/split # Additional files for LaTeX compilations. DOC_PACKAGES = doxyfuns.sty milena.sty @@ -346,7 +326,7 @@ maintainer-clean-local: ## Technical Documentation. ## ## ------------------------- ## -technical_dir = $(doc_dir)/technical +technical_dir = $(srcdir)/technical technical_dependencies = \ $(TECHNICAL_EXAMPLES) \ @@ -389,13 +369,13 @@ MAINTAINERCLEANFILES += $(TECHNICAL_HTML_OUTPUTS) # extension, since it is later parsed by Doxygen, which complains # about `.html' files. TECHNICAL_HH = $(technical_dir)/technical.hh -$(TECHNICAL_HH): $(TECHNICAL_HTML) $(doc_dir)/tools/todoxygen.sh +$(TECHNICAL_HH): $(TECHNICAL_HTML) $(srcdir)/tools/todoxygen.sh # The script `todoxygen.sh' may fail and still create a (partial and # invalid) file, thus preventing Make from trying to generate it # again. The solution is to use a temporary file as output and rename # it if the script succeeds. rm -f $@.tmp - $(doc_dir)/tools/todoxygen.sh $< $@.tmp $(doc_dir) + $(srcdir)/tools/todoxygen.sh $< $@.tmp $(srcdir) mv -f $@.tmp $@ @@ -417,7 +397,7 @@ MAINTAINERCLEANFILES += $(TECHNICAL_HH) ## Tutorial. ## ## ---------- ## -tutorial_dir = $(doc_dir)/tutorial +tutorial_dir = $(srcdir)/tutorial tutorial_dependencies = \ $(EXAMPLES) \ @@ -459,13 +439,13 @@ MAINTAINERCLEANFILES += $(TUTORIAL_HTML_OUTPUTS) # since it is later parsed by Doxygen, which complains about `.html' # files. TUTORIAL_HH = $(tutorial_dir)/tutorial.hh -$(TUTORIAL_HH): $(TUTORIAL_HTML) $(doc_dir)/tools/todoxygen.sh +$(TUTORIAL_HH): $(TUTORIAL_HTML) $(srcdir)/tools/todoxygen.sh # The script `todoxygen.sh' may fail and still create a (partial and # invalid) file, thus preventing Make from trying to generate it # again. The solution is to use a temporary file as output and rename # it if the script succeeds. rm -f $@.tmp - $(doc_dir)/tools/todoxygen.sh $< $@.tmp $(doc_dir) + $(srcdir)/tools/todoxygen.sh $< $@.tmp $(srcdir) mv -f $@.tmp $@ @@ -488,7 +468,7 @@ MAINTAINERCLEANFILES += $(TUTORIAL_HH) ## White Paper. ## ## ------------- ## -white_paper_dir = $(doc_dir)/white_paper +white_paper_dir = $(srcdir)/white_paper PNGS = \ $(white_paper_dir)/figures/house.png \ @@ -551,7 +531,7 @@ MAINTAINERCLEANFILES += $(EPSS) ## Reference Guide. ## ## ----------------- ## -ref_guide_dir = $(doc_dir)/ref_guide +ref_guide_dir = $(srcdir)/ref_guide ref_guide_dependencies = \ $(EXAMPLES) \ @@ -596,13 +576,13 @@ MAINTAINERCLEANFILES += $(REF_GUIDE_HTML_OUTPUTS) # since it is later parsed by Doxygen, which complains about `.html' # files. REF_GUIDE_HH = $(ref_guide_dir)/ref_guide.hh -$(REF_GUIDE_HH): $(REF_GUIDE_HTML) $(doc_dir)/tools/todoxygen.sh +$(REF_GUIDE_HH): $(REF_GUIDE_HTML) $(srcdir)/tools/todoxygen.sh # The script `todoxygen.sh' may fail and still create a (partial and # invalid) file, thus preventing Make from trying to generate it # again. The solution is to use a temporary file as output and rename # it if the script succeeds. rm -f $@.tmp - $(doc_dir)/tools/todoxygen.sh $< $@.tmp $(doc_dir) + $(srcdir)/tools/todoxygen.sh $< $@.tmp $(srcdir) mv -f $@.tmp $@ -- 1.5.6.5

1 0

last-svn-commit-101-g0339d12 doc/Makefile.am: Update FIXMEs.
by Roland Levillain 23 Mar '10

23 Mar '10

--- milena/ChangeLog | 4 ++ milena/doc/Makefile.am | 132 +++--------------------------------------------- 2 files changed, 12 insertions(+), 124 deletions(-) diff --git a/milena/ChangeLog b/milena/ChangeLog index 6ce4af7..8281219 100644 --- a/milena/ChangeLog +++ b/milena/ChangeLog @@ -1,5 +1,9 @@ 2010-03-23 Roland Levillain <roland(a)lrde.epita.fr> + * doc/Makefile.am: Update FIXMEs. + +2010-03-23 Roland Levillain <roland(a)lrde.epita.fr> + Remove Make aliases in the documentation. * doc/Makefile.am (doc, doc-user, doc-devel) diff --git a/milena/doc/Makefile.am b/milena/doc/Makefile.am index 08d6ff9..a505170 100644 --- a/milena/doc/Makefile.am +++ b/milena/doc/Makefile.am @@ -235,24 +235,15 @@ $(DOXYFILE_USER): $(srcdir)/$(DOXYFILE).in $(edit) $< >$@ MAINTAINERCLEANFILES += $(DOXYFILE_USER) -## FIXME: Rename USER_REFMAN_PDF to something else? USER_REFMAN_PDF = user-refman.pdf -## FIXME: Likewise? USER_REFMAN = 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) cd $(srcdir)/$(USER_REFMAN)/latex && $(MAKE) $(AM_MAKEFLAGS) pdf cp -f $(srcdir)/$(USER_REFMAN)/latex/refman.pdf $@ EXTRA_DIST += $(srcdir)/user-refman.stamp MAINTAINERCLEANFILES += $(srcdir)/user-refman.stamp -## FIXME: Are dependencies (`$(refman_dependencies)') 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.stamp: $(srcdir)/$(DOXYFILE).in $(refman_dependencies) @rm -f $@.tmp @touch $@.tmp @@ -311,28 +302,18 @@ $(DOXYFILE_DEVEL): $(srcdir)/$(DOXYFILE).in rm -f $@.tmp MAINTAINERCLEANFILES += $(DOXYFILE_DEVEL) -## FIXME: Rename DEVEL_REFMAN_PDF to something else? DEVEL_REFMAN_PDF = devel-refman-pdf -## FIXME: Likewise? DEVEL_REFMAN = 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) cd $(srcdir)/$(DEVEL_REFMAN)/latex && $(MAKE) $(AM_MAKEFLAGS) pdf cp -f $(srcdir)/$(DEVEL_REFMAN)/latex/refman.pdf $@ EXTRA_DIST += $(srcdir)/devel-refman.stamp MAINTAINERCLEANFILES += $(srcdir)/devel-refman.stamp -## FIXME: Are dependencies (`$(refman_dependencies)') 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.stamp: $(srcdir)/$(DOXYFILE).in $(refman_dependencies) @rm -f $@.tmp @touch $@.tmp @@ -372,34 +353,6 @@ technical_dependencies = \ $(PNG_FIGURES) \ $(DOC_PACKAGES) -# FIXME: As in milena/doc/Makefile.am, we should probably strip -# $(srcdir) prefixes from target variables, e.g. instead of: -# -# FOO = $(srcdir)/foo.pdf -# $(FOO): foo.tex bar.tex -# dist_doc_DATA = $(FOO) -# -# we should use: -# -# FOO = foo.pdf -# $(srcdir)/$(FOO): foo.tex bar.tex -# dist_doc_DATA = $(FOO) -# -# since it minimizes installation issues (see milena/doc/Makefile.am -# and Vaucanson's doc/Makefile.am). - -# FIXME: Distributed products should be generated in the source dir. -# That's actually the case, *but* the current solution is not clean -# and might break sometimes. The clean approach is to create a -# temporary directory, try to generate the documentation there, and -# move its contents to the source dir in case of success. If the -# product is a directory, also refresh a timestamp (in the source -# dir). - -## FIXME: technical technical.hh does not seem to be used (by the -## Doyxgen documentation); remove its generation? Careful, -## technical/technical.html *is* probably required, though. - # Final product. TECHNICAL_HTML = $(technical_dir)/technical.html TECHNICAL_HTML_OUTPUTS = $(TECHNICAL_HTML) $(technical_dir)/technical.css @@ -425,6 +378,10 @@ $(TECHNICAL_HTML_OUTPUTS): $(TECHNICAL_HTML).stamp dist_doc_DATA += $(TECHNICAL_HTML_OUTPUTS) MAINTAINERCLEANFILES += $(TECHNICAL_HTML_OUTPUTS) +## FIXME: technical technical.hh does not seem to be used (by the +## Doyxgen documentation); remove its generation? Careful, +## technical/technical.html *is* probably required, though. + # Intermediate product for the various doc targets of the parent # directory. # @@ -470,30 +427,6 @@ tutorial_dependencies = \ $(PNG_FIGURES) \ $(DOC_PACKAGES) -# FIXME: As in milena/doc/Makefile.am, we should probably strip -# $(srcdir) prefixes from target variables, e.g. instead of: -# -# FOO = $(srcdir)/foo.pdf -# $(FOO): foo.tex bar.tex -# dist_doc_DATA = $(FOO) -# -# we should use: -# -# FOO = foo.pdf -# $(srcdir)/$(FOO): foo.tex bar.tex -# dist_doc_DATA = $(FOO) -# -# since it minimizes installation issues (see milena/doc/Makefile.am -# and Vaucanson's doc/Makefile.am). - -# FIXME: Distributed products should be generated in the source dir. -# That's actually the case, *but* the current solution is not clean -# and might break sometimes. The clean approach is to create a -# temporary directory, try to generate the documentation there, and -# move its contents to the source dir in case of success. If the -# product is a directory, also refresh a timestamp (in the source -# dir). - # Final product. TUTORIAL_HTML = $(tutorial_dir)/tutorial.html TUTORIAL_HTML_OUTPUTS = $(TUTORIAL_HTML) $(tutorial_dir)/tutorial.css @@ -568,30 +501,6 @@ EPSS = $(PNGS:png=eps) .png.eps: convert $< $@ -# FIXME: As in milena/doc/Makefile.am, we should probably strip -# $(srcdir) prefixes from target variables, e.g. instead of: -# -# FOO = $(srcdir)/foo.pdf -# $(FOO): foo.tex bar.tex -# dist_doc_DATA = $(FOO) -# -# we should use: -# -# FOO = foo.pdf -# $(srcdir)/$(FOO): foo.tex bar.tex -# dist_doc_DATA = $(FOO) -# -# since it minimizes installation issues (see milena/doc/Makefile.am -# and Vaucanson's doc/Makefile.am). - -# FIXME: Distributed products should be generated in the source dir. -# That's actually the case, *but* the current solution is not clean -# and might break sometimes. The clean approach is to create a -# temporary directory, try to generate the documentation there, and -# move its contents to the source dir in case of success. If the -# product is a directory, also refresh a timestamp (in the source -# dir). - # Final product. WHITE_PAPER_HTML = $(white_paper_dir)/white_paper.html WHITE_PAPER_HTML_OUTPUTS = \ @@ -652,30 +561,6 @@ ref_guide_dependencies = \ $(PNG_FIGURES) \ $(DOC_PACKAGES) -# FIXME: As in milena/doc/Makefile.am, we should probably strip -# $(srcdir) prefixes from target variables, e.g. instead of: -# -# FOO = $(srcdir)/foo.pdf -# $(FOO): foo.tex bar.tex -# dist_doc_DATA = $(FOO) -# -# we should use: -# -# FOO = foo.pdf -# $(srcdir)/$(FOO): foo.tex bar.tex -# dist_doc_DATA = $(FOO) -# -# since it minimizes installation issues (see milena/doc/Makefile.am -# and Vaucanson's doc/Makefile.am). - -# FIXME: Distributed products should be generated in the source dir. -# That's actually the case, *but* the current solution is not clean -# and might break sometimes. The clean approach is to create a -# temporary directory, try to generate the documentation there, and -# move its contents to the source dir in case of success. If the -# product is a directory, also refresh a timestamp (in the source -# dir). - # Final product. REF_GUIDE_HTML = $(ref_guide_dir)/ref_guide.html REF_GUIDE_HTML_OUTPUTS = \ @@ -778,10 +663,9 @@ regen-outputs-mk: mv -f $(srcdir)/outputs.mk.tmp $(srcdir)/outputs.mk chmod -w $(srcdir)/outputs.mk -## FIXME: These outputs are also required by the (LaTeX) -## documentation. However, they have no corresponding program in -## examples/, hence they cannot be regenerated. Are they hand-made -## outputs? Or maybe outputs of which program has been removed since? +## These outputs are also required by the (LaTeX) documentation. +## However, they have no corresponding program in examples/, hence +## they cannot be regenerated. MORE_OUTPUTS = \ $(srcdir)/outputs/graph-output-1.txt \ $(srcdir)/outputs/ima2d-display-1.txt \ @@ -792,7 +676,7 @@ MORE_OUTPUTS = \ $(srcdir)/outputs/win-create-1-display.txt EXTRA_DIST += $(MORE_OUTPUTS) -# FIXME: Can't we implement this using `gen-make-variable'? +# Generate a Makefile helper containing outputs rules and timestamps. EXTRA_DIST += gen-examples-outputs-mk $(srcdir)/examples-outputs.mk: $(srcdir)/gen-examples-outputs-mk -- 1.5.6.5

1 0

last-svn-commit-108-g942c6a8 doc/Makefile.am: Update FIXMEs.
by Roland Levillain 23 Mar '10

23 Mar '10

--- milena/ChangeLog | 4 ++ milena/doc/Makefile.am | 132 +++--------------------------------------------- 2 files changed, 12 insertions(+), 124 deletions(-) diff --git a/milena/ChangeLog b/milena/ChangeLog index 9f7ff99..56e23ba 100644 --- a/milena/ChangeLog +++ b/milena/ChangeLog @@ -1,5 +1,9 @@ 2010-03-23 Roland Levillain <roland(a)lrde.epita.fr> + * doc/Makefile.am: Update FIXMEs. + +2010-03-23 Roland Levillain <roland(a)lrde.epita.fr> + Remove Make aliases in the documentation. * doc/Makefile.am (doc, doc-user, doc-devel) diff --git a/milena/doc/Makefile.am b/milena/doc/Makefile.am index 08d6ff9..a505170 100644 --- a/milena/doc/Makefile.am +++ b/milena/doc/Makefile.am @@ -235,24 +235,15 @@ $(DOXYFILE_USER): $(srcdir)/$(DOXYFILE).in $(edit) $< >$@ MAINTAINERCLEANFILES += $(DOXYFILE_USER) -## FIXME: Rename USER_REFMAN_PDF to something else? USER_REFMAN_PDF = user-refman.pdf -## FIXME: Likewise? USER_REFMAN = 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) cd $(srcdir)/$(USER_REFMAN)/latex && $(MAKE) $(AM_MAKEFLAGS) pdf cp -f $(srcdir)/$(USER_REFMAN)/latex/refman.pdf $@ EXTRA_DIST += $(srcdir)/user-refman.stamp MAINTAINERCLEANFILES += $(srcdir)/user-refman.stamp -## FIXME: Are dependencies (`$(refman_dependencies)') 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.stamp: $(srcdir)/$(DOXYFILE).in $(refman_dependencies) @rm -f $@.tmp @touch $@.tmp @@ -311,28 +302,18 @@ $(DOXYFILE_DEVEL): $(srcdir)/$(DOXYFILE).in rm -f $@.tmp MAINTAINERCLEANFILES += $(DOXYFILE_DEVEL) -## FIXME: Rename DEVEL_REFMAN_PDF to something else? DEVEL_REFMAN_PDF = devel-refman-pdf -## FIXME: Likewise? DEVEL_REFMAN = 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) cd $(srcdir)/$(DEVEL_REFMAN)/latex && $(MAKE) $(AM_MAKEFLAGS) pdf cp -f $(srcdir)/$(DEVEL_REFMAN)/latex/refman.pdf $@ EXTRA_DIST += $(srcdir)/devel-refman.stamp MAINTAINERCLEANFILES += $(srcdir)/devel-refman.stamp -## FIXME: Are dependencies (`$(refman_dependencies)') 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.stamp: $(srcdir)/$(DOXYFILE).in $(refman_dependencies) @rm -f $@.tmp @touch $@.tmp @@ -372,34 +353,6 @@ technical_dependencies = \ $(PNG_FIGURES) \ $(DOC_PACKAGES) -# FIXME: As in milena/doc/Makefile.am, we should probably strip -# $(srcdir) prefixes from target variables, e.g. instead of: -# -# FOO = $(srcdir)/foo.pdf -# $(FOO): foo.tex bar.tex -# dist_doc_DATA = $(FOO) -# -# we should use: -# -# FOO = foo.pdf -# $(srcdir)/$(FOO): foo.tex bar.tex -# dist_doc_DATA = $(FOO) -# -# since it minimizes installation issues (see milena/doc/Makefile.am -# and Vaucanson's doc/Makefile.am). - -# FIXME: Distributed products should be generated in the source dir. -# That's actually the case, *but* the current solution is not clean -# and might break sometimes. The clean approach is to create a -# temporary directory, try to generate the documentation there, and -# move its contents to the source dir in case of success. If the -# product is a directory, also refresh a timestamp (in the source -# dir). - -## FIXME: technical technical.hh does not seem to be used (by the -## Doyxgen documentation); remove its generation? Careful, -## technical/technical.html *is* probably required, though. - # Final product. TECHNICAL_HTML = $(technical_dir)/technical.html TECHNICAL_HTML_OUTPUTS = $(TECHNICAL_HTML) $(technical_dir)/technical.css @@ -425,6 +378,10 @@ $(TECHNICAL_HTML_OUTPUTS): $(TECHNICAL_HTML).stamp dist_doc_DATA += $(TECHNICAL_HTML_OUTPUTS) MAINTAINERCLEANFILES += $(TECHNICAL_HTML_OUTPUTS) +## FIXME: technical technical.hh does not seem to be used (by the +## Doyxgen documentation); remove its generation? Careful, +## technical/technical.html *is* probably required, though. + # Intermediate product for the various doc targets of the parent # directory. # @@ -470,30 +427,6 @@ tutorial_dependencies = \ $(PNG_FIGURES) \ $(DOC_PACKAGES) -# FIXME: As in milena/doc/Makefile.am, we should probably strip -# $(srcdir) prefixes from target variables, e.g. instead of: -# -# FOO = $(srcdir)/foo.pdf -# $(FOO): foo.tex bar.tex -# dist_doc_DATA = $(FOO) -# -# we should use: -# -# FOO = foo.pdf -# $(srcdir)/$(FOO): foo.tex bar.tex -# dist_doc_DATA = $(FOO) -# -# since it minimizes installation issues (see milena/doc/Makefile.am -# and Vaucanson's doc/Makefile.am). - -# FIXME: Distributed products should be generated in the source dir. -# That's actually the case, *but* the current solution is not clean -# and might break sometimes. The clean approach is to create a -# temporary directory, try to generate the documentation there, and -# move its contents to the source dir in case of success. If the -# product is a directory, also refresh a timestamp (in the source -# dir). - # Final product. TUTORIAL_HTML = $(tutorial_dir)/tutorial.html TUTORIAL_HTML_OUTPUTS = $(TUTORIAL_HTML) $(tutorial_dir)/tutorial.css @@ -568,30 +501,6 @@ EPSS = $(PNGS:png=eps) .png.eps: convert $< $@ -# FIXME: As in milena/doc/Makefile.am, we should probably strip -# $(srcdir) prefixes from target variables, e.g. instead of: -# -# FOO = $(srcdir)/foo.pdf -# $(FOO): foo.tex bar.tex -# dist_doc_DATA = $(FOO) -# -# we should use: -# -# FOO = foo.pdf -# $(srcdir)/$(FOO): foo.tex bar.tex -# dist_doc_DATA = $(FOO) -# -# since it minimizes installation issues (see milena/doc/Makefile.am -# and Vaucanson's doc/Makefile.am). - -# FIXME: Distributed products should be generated in the source dir. -# That's actually the case, *but* the current solution is not clean -# and might break sometimes. The clean approach is to create a -# temporary directory, try to generate the documentation there, and -# move its contents to the source dir in case of success. If the -# product is a directory, also refresh a timestamp (in the source -# dir). - # Final product. WHITE_PAPER_HTML = $(white_paper_dir)/white_paper.html WHITE_PAPER_HTML_OUTPUTS = \ @@ -652,30 +561,6 @@ ref_guide_dependencies = \ $(PNG_FIGURES) \ $(DOC_PACKAGES) -# FIXME: As in milena/doc/Makefile.am, we should probably strip -# $(srcdir) prefixes from target variables, e.g. instead of: -# -# FOO = $(srcdir)/foo.pdf -# $(FOO): foo.tex bar.tex -# dist_doc_DATA = $(FOO) -# -# we should use: -# -# FOO = foo.pdf -# $(srcdir)/$(FOO): foo.tex bar.tex -# dist_doc_DATA = $(FOO) -# -# since it minimizes installation issues (see milena/doc/Makefile.am -# and Vaucanson's doc/Makefile.am). - -# FIXME: Distributed products should be generated in the source dir. -# That's actually the case, *but* the current solution is not clean -# and might break sometimes. The clean approach is to create a -# temporary directory, try to generate the documentation there, and -# move its contents to the source dir in case of success. If the -# product is a directory, also refresh a timestamp (in the source -# dir). - # Final product. REF_GUIDE_HTML = $(ref_guide_dir)/ref_guide.html REF_GUIDE_HTML_OUTPUTS = \ @@ -778,10 +663,9 @@ regen-outputs-mk: mv -f $(srcdir)/outputs.mk.tmp $(srcdir)/outputs.mk chmod -w $(srcdir)/outputs.mk -## FIXME: These outputs are also required by the (LaTeX) -## documentation. However, they have no corresponding program in -## examples/, hence they cannot be regenerated. Are they hand-made -## outputs? Or maybe outputs of which program has been removed since? +## These outputs are also required by the (LaTeX) documentation. +## However, they have no corresponding program in examples/, hence +## they cannot be regenerated. MORE_OUTPUTS = \ $(srcdir)/outputs/graph-output-1.txt \ $(srcdir)/outputs/ima2d-display-1.txt \ @@ -792,7 +676,7 @@ MORE_OUTPUTS = \ $(srcdir)/outputs/win-create-1-display.txt EXTRA_DIST += $(MORE_OUTPUTS) -# FIXME: Can't we implement this using `gen-make-variable'? +# Generate a Makefile helper containing outputs rules and timestamps. EXTRA_DIST += gen-examples-outputs-mk $(srcdir)/examples-outputs.mk: $(srcdir)/gen-examples-outputs-mk -- 1.5.6.5

1 0

last-svn-commit-100-g5608295 Makefile.am (LOCAL_RECURSIVE_TARGETS): Remove doc.
by Roland Levillain 23 Mar '10

23 Mar '10

--- ChangeLog | 4 ++++ Makefile.am | 2 +- 2 files changed, 5 insertions(+), 1 deletions(-) diff --git a/ChangeLog b/ChangeLog index 6401ec2..d028cf1 100644 --- a/ChangeLog +++ b/ChangeLog @@ -1,3 +1,7 @@ +2010-03-23 Roland Levillain <roland(a)lrde.epita.fr> + + * Makefile.am (LOCAL_RECURSIVE_TARGETS): Remove doc. + 2010-03-22 Roland Levillain <roland(a)lrde.epita.fr> Regen INSTALL using autoreconf. diff --git a/Makefile.am b/Makefile.am index 3f44260..c591b00 100644 --- a/Makefile.am +++ b/Makefile.am @@ -32,7 +32,7 @@ endif ENABLE_SCRIBO #>> # Target shortcuts delegating the actual action to milena/Makefile. -LOCAL_RECURSIVE_TARGETS = doc pretty-check tests +LOCAL_RECURSIVE_TARGETS = pretty-check tests $(LOCAL_RECURSIVE_TARGETS): cd milena && $(MAKE) $(AM_MAKEFLAGS) $@ .PHONY: $(LOCAL_RECURSIVE_TARGETS) -- 1.5.6.5

1 0

last-svn-commit-107-g422b78e Makefile.am (LOCAL_RECURSIVE_TARGETS): Remove doc.
by Roland Levillain 23 Mar '10

23 Mar '10

--- ChangeLog | 4 ++++ Makefile.am | 2 +- 2 files changed, 5 insertions(+), 1 deletions(-) diff --git a/ChangeLog b/ChangeLog index 2fe133a..4819920 100644 --- a/ChangeLog +++ b/ChangeLog @@ -1,3 +1,7 @@ +2010-03-23 Roland Levillain <roland(a)lrde.epita.fr> + + * Makefile.am (LOCAL_RECURSIVE_TARGETS): Remove doc. + 2010-03-22 Roland Levillain <roland(a)lrde.epita.fr> Regen INSTALL using autoreconf. diff --git a/Makefile.am b/Makefile.am index 3f44260..c591b00 100644 --- a/Makefile.am +++ b/Makefile.am @@ -32,7 +32,7 @@ endif ENABLE_SCRIBO #>> # Target shortcuts delegating the actual action to milena/Makefile. -LOCAL_RECURSIVE_TARGETS = doc pretty-check tests +LOCAL_RECURSIVE_TARGETS = pretty-check tests $(LOCAL_RECURSIVE_TARGETS): cd milena && $(MAKE) $(AM_MAKEFLAGS) $@ .PHONY: $(LOCAL_RECURSIVE_TARGETS) -- 1.5.6.5

1 0

last-svn-commit-99-g9dc3bc6 Remove Make aliases in the documentation.
by Roland Levillain 23 Mar '10

23 Mar '10

* doc/Makefile.am (doc, doc-user, doc-devel) (doc-pdf, doc-html, doc-devel-pdf, doc-devel-html) (ref-doc, ref-doc-pdf, ref-doc-devel, ref-doc-devel-pdf) (tutorial-pdf, white-paper-pdf, ref-guide-pdf) (tutorial-html, white-paper-html, ref-guide-html): Remove (phony) targets. * Makefile.am (doc, tutorial): Likewise. --- milena/ChangeLog | 12 +++++++++ milena/Makefile.am | 9 +------ milena/doc/Makefile.am | 59 ------------------------------------------------ 3 files changed, 13 insertions(+), 67 deletions(-) diff --git a/milena/ChangeLog b/milena/ChangeLog index 240c853..6ce4af7 100644 --- a/milena/ChangeLog +++ b/milena/ChangeLog @@ -1,3 +1,15 @@ +2010-03-23 Roland Levillain <roland(a)lrde.epita.fr> + + Remove Make aliases in the documentation. + + * doc/Makefile.am (doc, doc-user, doc-devel) + (doc-pdf, doc-html, doc-devel-pdf, doc-devel-html) + (ref-doc, ref-doc-pdf, ref-doc-devel, ref-doc-devel-pdf) + (tutorial-pdf, white-paper-pdf, ref-guide-pdf) + (tutorial-html, white-paper-html, ref-guide-html): + Remove (phony) targets. + * Makefile.am (doc, tutorial): Likewise. + 2010-03-22 Roland Levillain <roland(a)lrde.epita.fr> Regen documentation products. diff --git a/milena/Makefile.am b/milena/Makefile.am index 21ab235..9bec15c 100644 --- a/milena/Makefile.am +++ b/milena/Makefile.am @@ -31,14 +31,7 @@ if ENABLE_TOOLS SUBDIRS += tools endif ENABLE_TOOLS -.PHONY: doc tutorial pretty-check tests - -doc: - cd doc && $(MAKE) $(AM_MAKEFLAGS) $@ - -# FIXME: This target has no trigger in the top-level. -tutorial: - cd doc && $(MAKE) $(AM_MAKEFLAGS) $@ +.PHONY: pretty-check tests pretty-check: cd tests && $(MAKE) $(AM_MAKEFLAGS) $@ diff --git a/milena/doc/Makefile.am b/milena/doc/Makefile.am index 54342e8..08d6ff9 100644 --- a/milena/doc/Makefile.am +++ b/milena/doc/Makefile.am @@ -51,29 +51,6 @@ DOXYFILE = Doxyfile EXTRA_DIST = dist_doc_DATA = -# 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 \ - doc-pdf doc-html doc-devel-pdf doc-devel-html \ - ref-doc ref-doc-pdf \ - ref-doc-devel ref-doc-devel-pdf - -doc: doc-user doc-devel - -doc-user: doc-pdf doc-html -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 - -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 - ## --------------------- ## ## LaTeX configuration. ## @@ -263,9 +240,6 @@ USER_REFMAN_PDF = user-refman.pdf ## FIXME: Likewise? 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/). @@ -342,9 +316,6 @@ DEVEL_REFMAN_PDF = devel-refman-pdf ## FIXME: Likewise? 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. @@ -394,10 +365,6 @@ maintainer-clean-local: ## Technical Documentation. ## ## ------------------------- ## -.PHONY: technical technical-html technical-pdf - -technical: technical-html technical-pdf - technical_dir = $(doc_dir)/technical technical_dependencies = \ @@ -465,9 +432,6 @@ MAINTAINERCLEANFILES += $(TECHNICAL_HTML_OUTPUTS) # extension, since it is later parsed by Doxygen, which complains # about `.html' files. TECHNICAL_HH = $(technical_dir)/technical.hh -# FIXME: Careful, technical-html depends on $(TECHNICAL_HH), not -# $(TECHNICAL_HTML). Anyway, this shortcut should vanish soon. -technical-html: $(TECHNICAL_HH) $(TECHNICAL_HH): $(TECHNICAL_HTML) $(doc_dir)/tools/todoxygen.sh # The script `todoxygen.sh' may fail and still create a (partial and # invalid) file, thus preventing Make from trying to generate it @@ -480,7 +444,6 @@ $(TECHNICAL_HH): $(TECHNICAL_HTML) $(doc_dir)/tools/todoxygen.sh # Final product. TECHNICAL_PDF = $(technical_dir)/technical.pdf -technical-pdf: $(TECHNICAL_PDF) # Extra dependencies. $(TECHNICAL_PDF): $(technical_dependencies) @@ -497,10 +460,6 @@ MAINTAINERCLEANFILES += $(TECHNICAL_HH) ## Tutorial. ## ## ---------- ## -.PHONY: tutorial tutorial-html tutorial-pdf - -tutorial: tutorial-html tutorial-pdf - tutorial_dir = $(doc_dir)/tutorial tutorial_dependencies = \ @@ -567,9 +526,6 @@ MAINTAINERCLEANFILES += $(TUTORIAL_HTML_OUTPUTS) # since it is later parsed by Doxygen, which complains about `.html' # files. TUTORIAL_HH = $(tutorial_dir)/tutorial.hh -# FIXME: Careful, tutorial-html depends on $(TUTORIAL_HH), not -# $(TUTORIAL_HTML). Anyway, this shortcut should vanish soon. -tutorial-html: $(TUTORIAL_HH) $(TUTORIAL_HH): $(TUTORIAL_HTML) $(doc_dir)/tools/todoxygen.sh # The script `todoxygen.sh' may fail and still create a (partial and # invalid) file, thus preventing Make from trying to generate it @@ -582,7 +538,6 @@ $(TUTORIAL_HH): $(TUTORIAL_HTML) $(doc_dir)/tools/todoxygen.sh # Final product. TUTORIAL_PDF = $(tutorial_dir)/tutorial.pdf -tutorial-pdf: $(TUTORIAL_PDF) # Extra dependencies. $(TUTORIAL_PDF): $(tutorial_dependencies) @@ -600,8 +555,6 @@ MAINTAINERCLEANFILES += $(TUTORIAL_HH) ## White Paper. ## ## ------------- ## -.PHONY: white-paper white-paper-html white-paper-pdf - white_paper_dir = $(doc_dir)/white_paper PNGS = \ @@ -615,8 +568,6 @@ EPSS = $(PNGS:png=eps) .png.eps: convert $< $@ -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: # @@ -643,7 +594,6 @@ white-paper: white-paper-pdf white-paper-html # Final product. WHITE_PAPER_HTML = $(white_paper_dir)/white_paper.html -white-paper-html: $(WHITE_PAPER_HTML) WHITE_PAPER_HTML_OUTPUTS = \ $(WHITE_PAPER_HTML) \ $(white_paper_dir)/white_paper.css \ @@ -674,7 +624,6 @@ dist_doc_DATA += $(WHITE_PAPER_HTML_OUTPUTS) MAINTAINERCLEANFILES += $(WHITE_PAPER_HTML_OUTPUTS) WHITE_PAPER_PDF = $(white_paper_dir)/white_paper.pdf -white-paper-pdf: $(WHITE_PAPER_PDF) # Extra dependencies. $(WHITE_PAPER_PDF): $(PNGS) @@ -693,10 +642,6 @@ MAINTAINERCLEANFILES += $(EPSS) ## Reference Guide. ## ## ----------------- ## -.PHONY: ref-guide ref-guide-html ref-guide-pdf - -ref-guide: ref-guide-html ref-guide-pdf - ref_guide_dir = $(doc_dir)/ref_guide ref_guide_dependencies = \ @@ -766,9 +711,6 @@ MAINTAINERCLEANFILES += $(REF_GUIDE_HTML_OUTPUTS) # since it is later parsed by Doxygen, which complains about `.html' # files. REF_GUIDE_HH = $(ref_guide_dir)/ref_guide.hh -# FIXME: Careful, ref-guide-html depends on $(REF_GUIDE_HH), not -# $(REF_GUIDE_HTML). Anyway, this shortcut should vanish soon. -ref-guide-html: $(REF_GUIDE_HH) $(REF_GUIDE_HH): $(REF_GUIDE_HTML) $(doc_dir)/tools/todoxygen.sh # The script `todoxygen.sh' may fail and still create a (partial and # invalid) file, thus preventing Make from trying to generate it @@ -781,7 +723,6 @@ $(REF_GUIDE_HH): $(REF_GUIDE_HTML) $(doc_dir)/tools/todoxygen.sh # Final product. REF_GUIDE_PDF = $(ref_guide_dir)/ref_guide.pdf -ref-guide-pdf: $(REF_GUIDE_PDF) # Extra dependencies. $(REF_GUIDE_PDF): $(ref_guide_dependencies) -- 1.5.6.5

1 0

last-svn-commit-106-ge8f81c8 Remove Make aliases in the documentation.
by Roland Levillain 23 Mar '10

23 Mar '10

* doc/Makefile.am (doc, doc-user, doc-devel) (doc-pdf, doc-html, doc-devel-pdf, doc-devel-html) (ref-doc, ref-doc-pdf, ref-doc-devel, ref-doc-devel-pdf) (tutorial-pdf, white-paper-pdf, ref-guide-pdf) (tutorial-html, white-paper-html, ref-guide-html): Remove (phony) targets. * Makefile.am (doc, tutorial): Likewise. --- milena/ChangeLog | 12 +++++++++ milena/Makefile.am | 9 +------ milena/doc/Makefile.am | 59 ------------------------------------------------ 3 files changed, 13 insertions(+), 67 deletions(-) diff --git a/milena/ChangeLog b/milena/ChangeLog index 568d67f..9f7ff99 100644 --- a/milena/ChangeLog +++ b/milena/ChangeLog @@ -1,3 +1,15 @@ +2010-03-23 Roland Levillain <roland(a)lrde.epita.fr> + + Remove Make aliases in the documentation. + + * doc/Makefile.am (doc, doc-user, doc-devel) + (doc-pdf, doc-html, doc-devel-pdf, doc-devel-html) + (ref-doc, ref-doc-pdf, ref-doc-devel, ref-doc-devel-pdf) + (tutorial-pdf, white-paper-pdf, ref-guide-pdf) + (tutorial-html, white-paper-html, ref-guide-html): + Remove (phony) targets. + * Makefile.am (doc, tutorial): Likewise. + 2010-03-22 Roland Levillain <roland(a)lrde.epita.fr> Regen documentation products. diff --git a/milena/Makefile.am b/milena/Makefile.am index 21ab235..9bec15c 100644 --- a/milena/Makefile.am +++ b/milena/Makefile.am @@ -31,14 +31,7 @@ if ENABLE_TOOLS SUBDIRS += tools endif ENABLE_TOOLS -.PHONY: doc tutorial pretty-check tests - -doc: - cd doc && $(MAKE) $(AM_MAKEFLAGS) $@ - -# FIXME: This target has no trigger in the top-level. -tutorial: - cd doc && $(MAKE) $(AM_MAKEFLAGS) $@ +.PHONY: pretty-check tests pretty-check: cd tests && $(MAKE) $(AM_MAKEFLAGS) $@ diff --git a/milena/doc/Makefile.am b/milena/doc/Makefile.am index 54342e8..08d6ff9 100644 --- a/milena/doc/Makefile.am +++ b/milena/doc/Makefile.am @@ -51,29 +51,6 @@ DOXYFILE = Doxyfile EXTRA_DIST = dist_doc_DATA = -# 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 \ - doc-pdf doc-html doc-devel-pdf doc-devel-html \ - ref-doc ref-doc-pdf \ - ref-doc-devel ref-doc-devel-pdf - -doc: doc-user doc-devel - -doc-user: doc-pdf doc-html -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 - -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 - ## --------------------- ## ## LaTeX configuration. ## @@ -263,9 +240,6 @@ USER_REFMAN_PDF = user-refman.pdf ## FIXME: Likewise? 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/). @@ -342,9 +316,6 @@ DEVEL_REFMAN_PDF = devel-refman-pdf ## FIXME: Likewise? 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. @@ -394,10 +365,6 @@ maintainer-clean-local: ## Technical Documentation. ## ## ------------------------- ## -.PHONY: technical technical-html technical-pdf - -technical: technical-html technical-pdf - technical_dir = $(doc_dir)/technical technical_dependencies = \ @@ -465,9 +432,6 @@ MAINTAINERCLEANFILES += $(TECHNICAL_HTML_OUTPUTS) # extension, since it is later parsed by Doxygen, which complains # about `.html' files. TECHNICAL_HH = $(technical_dir)/technical.hh -# FIXME: Careful, technical-html depends on $(TECHNICAL_HH), not -# $(TECHNICAL_HTML). Anyway, this shortcut should vanish soon. -technical-html: $(TECHNICAL_HH) $(TECHNICAL_HH): $(TECHNICAL_HTML) $(doc_dir)/tools/todoxygen.sh # The script `todoxygen.sh' may fail and still create a (partial and # invalid) file, thus preventing Make from trying to generate it @@ -480,7 +444,6 @@ $(TECHNICAL_HH): $(TECHNICAL_HTML) $(doc_dir)/tools/todoxygen.sh # Final product. TECHNICAL_PDF = $(technical_dir)/technical.pdf -technical-pdf: $(TECHNICAL_PDF) # Extra dependencies. $(TECHNICAL_PDF): $(technical_dependencies) @@ -497,10 +460,6 @@ MAINTAINERCLEANFILES += $(TECHNICAL_HH) ## Tutorial. ## ## ---------- ## -.PHONY: tutorial tutorial-html tutorial-pdf - -tutorial: tutorial-html tutorial-pdf - tutorial_dir = $(doc_dir)/tutorial tutorial_dependencies = \ @@ -567,9 +526,6 @@ MAINTAINERCLEANFILES += $(TUTORIAL_HTML_OUTPUTS) # since it is later parsed by Doxygen, which complains about `.html' # files. TUTORIAL_HH = $(tutorial_dir)/tutorial.hh -# FIXME: Careful, tutorial-html depends on $(TUTORIAL_HH), not -# $(TUTORIAL_HTML). Anyway, this shortcut should vanish soon. -tutorial-html: $(TUTORIAL_HH) $(TUTORIAL_HH): $(TUTORIAL_HTML) $(doc_dir)/tools/todoxygen.sh # The script `todoxygen.sh' may fail and still create a (partial and # invalid) file, thus preventing Make from trying to generate it @@ -582,7 +538,6 @@ $(TUTORIAL_HH): $(TUTORIAL_HTML) $(doc_dir)/tools/todoxygen.sh # Final product. TUTORIAL_PDF = $(tutorial_dir)/tutorial.pdf -tutorial-pdf: $(TUTORIAL_PDF) # Extra dependencies. $(TUTORIAL_PDF): $(tutorial_dependencies) @@ -600,8 +555,6 @@ MAINTAINERCLEANFILES += $(TUTORIAL_HH) ## White Paper. ## ## ------------- ## -.PHONY: white-paper white-paper-html white-paper-pdf - white_paper_dir = $(doc_dir)/white_paper PNGS = \ @@ -615,8 +568,6 @@ EPSS = $(PNGS:png=eps) .png.eps: convert $< $@ -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: # @@ -643,7 +594,6 @@ white-paper: white-paper-pdf white-paper-html # Final product. WHITE_PAPER_HTML = $(white_paper_dir)/white_paper.html -white-paper-html: $(WHITE_PAPER_HTML) WHITE_PAPER_HTML_OUTPUTS = \ $(WHITE_PAPER_HTML) \ $(white_paper_dir)/white_paper.css \ @@ -674,7 +624,6 @@ dist_doc_DATA += $(WHITE_PAPER_HTML_OUTPUTS) MAINTAINERCLEANFILES += $(WHITE_PAPER_HTML_OUTPUTS) WHITE_PAPER_PDF = $(white_paper_dir)/white_paper.pdf -white-paper-pdf: $(WHITE_PAPER_PDF) # Extra dependencies. $(WHITE_PAPER_PDF): $(PNGS) @@ -693,10 +642,6 @@ MAINTAINERCLEANFILES += $(EPSS) ## Reference Guide. ## ## ----------------- ## -.PHONY: ref-guide ref-guide-html ref-guide-pdf - -ref-guide: ref-guide-html ref-guide-pdf - ref_guide_dir = $(doc_dir)/ref_guide ref_guide_dependencies = \ @@ -766,9 +711,6 @@ MAINTAINERCLEANFILES += $(REF_GUIDE_HTML_OUTPUTS) # since it is later parsed by Doxygen, which complains about `.html' # files. REF_GUIDE_HH = $(ref_guide_dir)/ref_guide.hh -# FIXME: Careful, ref-guide-html depends on $(REF_GUIDE_HH), not -# $(REF_GUIDE_HTML). Anyway, this shortcut should vanish soon. -ref-guide-html: $(REF_GUIDE_HH) $(REF_GUIDE_HH): $(REF_GUIDE_HTML) $(doc_dir)/tools/todoxygen.sh # The script `todoxygen.sh' may fail and still create a (partial and # invalid) file, thus preventing Make from trying to generate it @@ -781,7 +723,6 @@ $(REF_GUIDE_HH): $(REF_GUIDE_HTML) $(doc_dir)/tools/todoxygen.sh # Final product. REF_GUIDE_PDF = $(ref_guide_dir)/ref_guide.pdf -ref-guide-pdf: $(REF_GUIDE_PDF) # Extra dependencies. $(REF_GUIDE_PDF): $(ref_guide_dependencies) -- 1.5.6.5

1 0