Olena-patches March 2010

olena-patches@lrde.epita.fr

4 participants
277 discussions

last-svn-commit-10-ga32de0f Have Scribo compile again.

by Roland Levillain

* core/object_image.hh (object_image): Add prefix `mln::'. * primitive/link/internal/anchors_3.hh: Include mln/util/array.hh. Add missing `mln::' prefixes. * src/binarization/sauvola_ms.cc: s/influence_zone_geodesic/influence_zone_geodesic_saturated/. * table/internal/connect_lines.hh: Likewise. Remove a duplicated header inclusion. * src/debug/Makefile.am (bin_PROGRAMS, show_links_several_right_overlap_SOURCES): Disable show_links_several_right_overlap. * src/primitive/group/Makefile.am (bin_PROGRAMS, group_from_rag_SOURCES): Disable group_from_rag. --- scribo/ChangeLog | 17 +++++++++++++++++ scribo/core/object_image.hh | 2 +- scribo/primitive/link/internal/anchors_3.hh | 13 +++++++------ scribo/src/binarization/sauvola_ms.cc | 6 +++--- scribo/src/debug/Makefile.am | 7 ++++--- scribo/src/primitive/group/Makefile.am | 5 +++-- scribo/table/internal/connect_lines.hh | 7 +++---- 7 files changed, 38 insertions(+), 19 deletions(-) diff --git a/scribo/ChangeLog b/scribo/ChangeLog index 33307f4..160ced4 100644 --- a/scribo/ChangeLog +++ b/scribo/ChangeLog @@ -1,3 +1,20 @@ +2010-03-31 Roland Levillain <roland(a)lrde.epita.fr> + + Have Scribo compile again. + + * core/object_image.hh (object_image): Add prefix `mln::'. + * primitive/link/internal/anchors_3.hh: Include mln/util/array.hh. + Add missing `mln::' prefixes. + * src/binarization/sauvola_ms.cc: + s/influence_zone_geodesic/influence_zone_geodesic_saturated/. + * table/internal/connect_lines.hh: Likewise. + Remove a duplicated header inclusion. + * src/debug/Makefile.am + (bin_PROGRAMS, show_links_several_right_overlap_SOURCES): Disable + show_links_several_right_overlap. + * src/primitive/group/Makefile.am + (bin_PROGRAMS, group_from_rag_SOURCES): Disable group_from_rag. + 2010-03-02 Roland Levillain <roland(a)lrde.epita.fr> Regen SCRIBO's Makefile helpers. diff --git a/scribo/core/object_image.hh b/scribo/core/object_image.hh index a920680..7f672b2 100644 --- a/scribo/core/object_image.hh +++ b/scribo/core/object_image.hh @@ -33,6 +33,6 @@ # include <mln/core/image/imorph/labeled_image.hh> # define object_image(L) \ - labeled_image<L> + mln::labeled_image<L> #endif // ! SCRIBO_CORE_OBJECT_IMAGE_HH diff --git a/scribo/primitive/link/internal/anchors_3.hh b/scribo/primitive/link/internal/anchors_3.hh index 85fa80b..3be9658 100644 --- a/scribo/primitive/link/internal/anchors_3.hh +++ b/scribo/primitive/link/internal/anchors_3.hh @@ -31,6 +31,7 @@ /// Routine providing 3 anchors for neighbor seeking. # include <mln/math/min.hh> +# include <mln/util/array.hh> # include <scribo/core/object_image.hh> @@ -94,7 +95,7 @@ namespace scribo - objects.bbox(current_object).pmin().row(); mln_site(L) sp = objects.bbox(current_object).center(); - def::coord r; + mln::def::coord r; switch (anchor) { @@ -102,10 +103,10 @@ namespace scribo case 0: if (h < 30) r = objects.bbox(current_object).pmin().row() - + math::min(2u, (h + 1) / 2 - 1); + + mln::math::min(2u, (h + 1) / 2 - 1); else r = objects.bbox(current_object).pmin().row() - - math::min(10u, h /10); + - mln::math::min(10u, h /10); break; @@ -118,14 +119,14 @@ namespace scribo case 2: if (h < 30) r = objects.bbox(current_object).pmax().row() - + math::min(2u, (h + 1) / 2 - 1); + + mln::math::min(2u, (h + 1) / 2 - 1); else r = objects.bbox(current_object).pmax().row() - - math::min(10u, h /10); + - mln::math::min(10u, h /10); break; default: - trace::warning("Non handled anchor"); + mln::trace::warning("Non handled anchor"); mln_assertion(anchor > 2); } diff --git a/scribo/src/binarization/sauvola_ms.cc b/scribo/src/binarization/sauvola_ms.cc index 747bc11..196a15c 100644 --- a/scribo/src/binarization/sauvola_ms.cc +++ b/scribo/src/binarization/sauvola_ms.cc @@ -33,7 +33,7 @@ #include <mln/literal/colors.hh> #include <mln/math/sqr.hh> #include <mln/subsampling/subsampling.hh> -#include <mln/transform/influence_zone_geodesic.hh> +#include <mln/transform/influence_zone_geodesic_saturated.hh> #include <mln/util/timer.hh> #include <mln/value/int_u16.hh> #include <mln/value/int_u8.hh> @@ -359,8 +359,8 @@ int main(int argc, char *argv[]) /// Saving influence zone scale image. - image2d<int_u8> - e_ext = transform::influence_zone_geodesic(e, c8(), mln_max(unsigned)); + image2d<int_u8> e_ext = + transform::influence_zone_geodesic_saturated(e, c8(), mln_max(unsigned)); io::pgm::save(e_ext, "e_ext.pgm"); diff --git a/scribo/src/debug/Makefile.am b/scribo/src/debug/Makefile.am index 28839dc..36bbfcb 100644 --- a/scribo/src/debug/Makefile.am +++ b/scribo/src/debug/Makefile.am @@ -27,7 +27,6 @@ bin_PROGRAMS = \ show_links_center_aligned \ show_links_non_h_aligned \ show_links_several_right \ - show_links_several_right_overlap \ show_links_single_left \ show_links_single_left_dmax_ratio \ show_links_single_right \ @@ -39,7 +38,6 @@ bin_PROGRAMS = \ show_objects_thick \ show_objects_thin - show_left_right_links_validation_SOURCES = show_left_right_links_validation.cc show_links_bbox_h_ratio_SOURCES = show_links_bbox_h_ratio.cc show_links_bbox_overlap_SOURCES = show_links_bbox_overlap.cc @@ -47,7 +45,6 @@ show_links_bottom_aligned_SOURCES = show_links_bottom_aligned.cc show_links_center_aligned_SOURCES = show_links_center_aligned.cc show_links_non_h_aligned_SOURCES = show_links_non_h_aligned.cc show_links_several_right_SOURCES = show_links_several_right.cc -show_links_several_right_overlap_SOURCES = show_links_several_right_overlap.cc show_links_single_left_SOURCES = show_links_single_left.cc show_links_single_left_dmax_ratio_SOURCES = show_links_single_left_dmax_ratio.cc show_links_single_right_SOURCES = show_links_single_right.cc @@ -58,3 +55,7 @@ show_objects_large_small_SOURCES = show_objects_large_small.cc show_objects_small_SOURCES = show_objects_small.cc show_objects_thick_SOURCES = show_objects_thick.cc show_objects_thin_SOURCES = show_objects_thin.cc + +## FIXME: Does not compile. +## bin_PROGRAMS += show_links_several_right_overlap +## show_links_several_right_overlap_SOURCES = show_links_several_right_overlap.cc diff --git a/scribo/src/primitive/group/Makefile.am b/scribo/src/primitive/group/Makefile.am index 83c2306..e52e373 100644 --- a/scribo/src/primitive/group/Makefile.am +++ b/scribo/src/primitive/group/Makefile.am @@ -24,7 +24,6 @@ bin_PROGRAMS = \ group_from_double_link_filter_non_aligned \ group_from_double_several_links \ group_from_graph \ - group_from_rag \ group_from_several_graph \ group_from_several_left_links \ group_from_single_link @@ -33,8 +32,10 @@ group_from_double_link_SOURCES = group_from_double_link.cc group_from_double_link_filter_non_aligned_SOURCES = group_from_double_link_filter_non_aligned.cc group_from_double_several_links_SOURCES = group_from_double_several_links.cc group_from_graph_SOURCES = group_from_graph.cc -group_from_rag_SOURCES = group_from_rag.cc group_from_several_graph_SOURCES = group_from_several_graph.cc group_from_several_left_links_SOURCES = group_from_several_left_links.cc group_from_single_link_SOURCES = group_from_single_link.cc +## FIXME: Does not compile. +## bin_PROGRAMS += group_from_rag +## group_from_rag_SOURCES = group_from_rag.cc diff --git a/scribo/table/internal/connect_lines.hh b/scribo/table/internal/connect_lines.hh index b2f9273..dda530f 100644 --- a/scribo/table/internal/connect_lines.hh +++ b/scribo/table/internal/connect_lines.hh @@ -35,7 +35,7 @@ # include <mln/data/fill.hh> -# include <mln/transform/influence_zone_geodesic.hh> +# include <mln/transform/influence_zone_geodesic_saturated.hh> # include <mln/morpho/elementary/dilation.hh> # include <mln/util/array.hh> @@ -43,8 +43,6 @@ # include <mln/opt/at.hh> -# include <mln/transform/influence_zone_geodesic.hh> - # include <scribo/core/macros.hh> # include <scribo/core/central_sites.hh> @@ -96,7 +94,8 @@ namespace scribo for_all_elements(i, aligned_lines) opt::at(l, aligned_lines[i]) = aligned_lines[i]; - l = transform::influence_zone_geodesic(l, c2(), max_distance, -1); + l = transform::influence_zone_geodesic_saturated(l, c2(), + max_distance, -1); for_all_components(i, boxes) { -- 1.5.6.5

14 years, 1 month

last-svn-commit-120-g66a2888 bootstrap: Check for HeVeA instead of TeX4ht.

by Roland Levillain

--- ChangeLog | 4 ++++ bootstrap | 24 +----------------------- 2 files changed, 5 insertions(+), 23 deletions(-) diff --git a/ChangeLog b/ChangeLog index 0795216..3f6b6cd 100644 --- a/ChangeLog +++ b/ChangeLog @@ -1,3 +1,7 @@ +2010-03-31 Roland Levillain <roland(a)lrde.epita.fr> + + * bootstrap: Check for HeVeA instead of TeX4ht. + 2010-03-30 Roland Levillain <roland(a)lrde.epita.fr> Revert to HeVeA to generate HTML from LaTeX. diff --git a/bootstrap b/bootstrap index 8f7d0c0..1505aa5 100755 --- a/bootstrap +++ b/bootstrap @@ -155,29 +155,7 @@ require $libtoolize 1.5.22 require doxygen 1.5.6 require convert 6.3.7 -# FIXME: Also check these: -# epstopdf -# pgf (how?) - -# Check for TeX4ht. htlatex and friends do not have options like -# `--version', `-version', `-v', etc. Hence this ad hoc procedure. -tempdir=`mktemp -d /tmp/temp.XXXXXX` -# Set up automatic cleanup. -cleanup() { rm -rf "$tempdir"; exit; } -trap cleanup 0 1 2 3 6 15 -( - cd "$tempdir" - cat >test.tex <<EOF - \documentclass{article} - \begin{document} - Test - \end{document} -EOF - htlatex >/dev/null 2>&1 test.tex -) || fatal "TeX4ht is required" - -# dvipng is required by TeX4ht. -require dvipng 1.11 +require hevea 1.10 -version # Regen files stored in the repository if asked so. -- 1.5.6.5

14 years, 1 month

last-svn-commit-113-g0300292 bootstrap: Check for HeVeA instead of TeX4ht.

by Roland Levillain

--- ChangeLog | 4 ++++ bootstrap | 24 +----------------------- 2 files changed, 5 insertions(+), 23 deletions(-) diff --git a/ChangeLog b/ChangeLog index 299865a..a62d7bd 100644 --- a/ChangeLog +++ b/ChangeLog @@ -1,3 +1,7 @@ +2010-03-31 Roland Levillain <roland(a)lrde.epita.fr> + + * bootstrap: Check for HeVeA instead of TeX4ht. + 2010-03-30 Roland Levillain <roland(a)lrde.epita.fr> Revert to HeVeA to generate HTML from LaTeX. diff --git a/bootstrap b/bootstrap index 8f7d0c0..1505aa5 100755 --- a/bootstrap +++ b/bootstrap @@ -155,29 +155,7 @@ require $libtoolize 1.5.22 require doxygen 1.5.6 require convert 6.3.7 -# FIXME: Also check these: -# epstopdf -# pgf (how?) - -# Check for TeX4ht. htlatex and friends do not have options like -# `--version', `-version', `-v', etc. Hence this ad hoc procedure. -tempdir=`mktemp -d /tmp/temp.XXXXXX` -# Set up automatic cleanup. -cleanup() { rm -rf "$tempdir"; exit; } -trap cleanup 0 1 2 3 6 15 -( - cd "$tempdir" - cat >test.tex <<EOF - \documentclass{article} - \begin{document} - Test - \end{document} -EOF - htlatex >/dev/null 2>&1 test.tex -) || fatal "TeX4ht is required" - -# dvipng is required by TeX4ht. -require dvipng 1.11 +require hevea 1.10 -version # Regen files stored in the repository if asked so. -- 1.5.6.5

14 years, 1 month

branch revamp-doc-build updated: last-svn-commit-112-gf169fdf

by git＠lrde.epita.fr

This is an automated email from the git hooks/post-receive script. It was generated because a ref change was pushed to the repository containing the project "Olena, a generic and efficient image processing platform". The branch revamp-doc-build has been updated via f169fdf50e40d6e594d3f558bf5a787919389d3f (commit) via b210a23a619d8b60140303e6d77ca22055e89413 (commit) via c5030284d69e258859b9285c3c4dd3301e1e6b68 (commit) via ae36e6d9046126ee62f2db47f9eea112c756c0e0 (commit) via 69369199c9d503a2b43197667362e61b800802fa (commit) via a905428829ba2c107f10afdbaf697f4c106dc155 (commit) via d6ecf0a225db980ac0f10eab9cdbd35f78e2fb9a (commit) via 5412e23a30e60d05c639dc40e7c5c5b89dd2f5cd (commit) via 90d6a929458957381ba27375e073f6f545360e8e (commit) via 1d78b388eee0807fd010a4020e381387f232c389 (commit) via 5ec3f5f0887869c29986c48ab4bb4863cca2ba93 (commit) via 0339d12b88507580a87311d2538eebc079384094 (commit) via 56082952387e69ec8c31a8f5b3519700551803dd (commit) via 9dc3bc6c84e37bbb33d01c7b1094d8394b202a9f (commit) from 75d3ad83be574c7724c64a4a5bb368579dc93d30 (commit) Those revisions listed above that are new to this repository have not appeared on any other notification email; so we list those revisions in full, below. - Log ----------------------------------------------------------------- f169fdf Do not install low-quality HTML documentation. b210a23 Adjust the installation of the HTML documentation. c503028 Move LaTeX sources at the root of doc/; generate HTML in subdirs. ae36e6d Revert to HeVeA to generate HTML from LaTeX. 6936919 No longer generate doc/technical/technical.hh. a905428 Fix the regeneration of files in doc/. d6ecf0a Fix the Milena distribution. 5412e23 Do not distribute the developer (Doxygen) reference manual. 90d6a92 Fix the name of the developer (Doxygen) PDF reference manual. 1d78b38 Use finer installation variables. 5ec3f5f Simplify doc/Makefile.am. 0339d12 doc/Makefile.am: Update FIXMEs. 5608295 Makefile.am (LOCAL_RECURSIVE_TARGETS): Remove doc. 9dc3bc6 Remove Make aliases in the documentation. ----------------------------------------------------------------------- Summary of changes: ChangeLog | 10 + Makefile.am | 2 +- build-aux/tex.mk | 6 +- milena/ChangeLog | 226 +++++++ milena/Makefile.am | 9 +- milena/doc/.gitignore | 33 +- milena/doc/Makefile.am | 693 +++++++------------- milena/doc/{white_paper => }/figures/house.png | Bin 26653 -> 26653 bytes milena/doc/{white_paper => }/figures/house_rag.png | Bin 9454 -> 9454 bytes .../doc/{white_paper => }/figures/house_wshed.png | Bin 27668 -> 27668 bytes .../figures/house_wshed_mean_colors.png | Bin 6618 -> 6618 bytes .../figures => figures/technical}/file_layout.pdf | Bin 26680 -> 26680 bytes .../figures => figures/technical}/file_layout.png | Bin 117801 -> 117801 bytes milena/doc/graphicx.hva | 3 + .../doc/{ref_guide/ref_guide.tex => ref-guide.tex} | 0 .../designs/properties/values.txt | 0 .../designs/site_psite_piter/README | 0 milena/doc/{technical => }/technical.tex | 6 +- .../doc/{tutorial => tutorial.old}/design/Makefile | 0 .../{tutorial => tutorial.old}/design/design.tex | 0 .../design/include/imagetours.tex | 0 .../design/include/properties.tex | 0 .../{tutorial => tutorial.old}/doxyfile_tuto.local | 0 .../doc/{tutorial => tutorial.old}/image_types.txt | 0 .../{tutorial => tutorial.old}/image_values.txt | 0 .../doc/{tutorial => tutorial.old}/images_tour.txt | 0 milena/doc/{tutorial => tutorial.old}/slides.tex | 0 milena/doc/{tutorial => }/tutorial.tex | 0 .../white_paper.tex => white-paper.tex} | 0 milena/tests/transform/Makefile.am | 2 - 30 files changed, 503 insertions(+), 487 deletions(-) rename milena/doc/{white_paper => }/figures/house.png (100%) rename milena/doc/{white_paper => }/figures/house_rag.png (100%) rename milena/doc/{white_paper => }/figures/house_wshed.png (100%) rename milena/doc/{white_paper => }/figures/house_wshed_mean_colors.png (100%) rename milena/doc/{technical/figures => figures/technical}/file_layout.pdf (100%) rename milena/doc/{technical/figures => figures/technical}/file_layout.png (100%) create mode 100644 milena/doc/graphicx.hva rename milena/doc/{ref_guide/ref_guide.tex => ref-guide.tex} (100%) rename milena/doc/{technical => technical.old}/designs/properties/values.txt (100%) rename milena/doc/{technical => technical.old}/designs/site_psite_piter/README (100%) rename milena/doc/{technical => }/technical.tex (96%) rename milena/doc/{tutorial => tutorial.old}/design/Makefile (100%) rename milena/doc/{tutorial => tutorial.old}/design/design.tex (100%) rename milena/doc/{tutorial => tutorial.old}/design/include/imagetours.tex (100%) rename milena/doc/{tutorial => tutorial.old}/design/include/properties.tex (100%) rename milena/doc/{tutorial => tutorial.old}/doxyfile_tuto.local (100%) rename milena/doc/{tutorial => tutorial.old}/image_types.txt (100%) rename milena/doc/{tutorial => tutorial.old}/image_values.txt (100%) rename milena/doc/{tutorial => tutorial.old}/images_tour.txt (100%) rename milena/doc/{tutorial => tutorial.old}/slides.tex (100%) rename milena/doc/{tutorial => }/tutorial.tex (100%) delete mode 100644 milena/doc/tutorial/headers.stamp rename milena/doc/{white_paper/white_paper.tex => white-paper.tex} (100%) hooks/post-receive -- Olena, a generic and efficient image processing platform

14 years, 1 month

last-svn-commit-119-g12dd479 Do not install low-quality HTML documentation.

by Roland Levillain

* doc/Makefile.am (DATA_html_dirs_inst): New. Use it... (install-data-local, uninstall-local): Here. --- milena/ChangeLog | 8 ++++++++ milena/doc/Makefile.am | 10 ++++++++-- 2 files changed, 16 insertions(+), 2 deletions(-) diff --git a/milena/ChangeLog b/milena/ChangeLog index deee63a..0806c6b 100644 --- a/milena/ChangeLog +++ b/milena/ChangeLog @@ -1,5 +1,13 @@ 2010-03-30 Roland Levillain <roland(a)lrde.epita.fr> + Do not install low-quality HTML documentation. + + * doc/Makefile.am (DATA_html_dirs_inst): New. + Use it... + (install-data-local, uninstall-local): Here. + +2010-03-30 Roland Levillain <roland(a)lrde.epita.fr> + Adjust the installation of the HTML documentation. * doc/Makefile.am (all-local): Do not depend on diff --git a/milena/doc/Makefile.am b/milena/doc/Makefile.am index 088cf41..273b3d8 100644 --- a/milena/doc/Makefile.am +++ b/milena/doc/Makefile.am @@ -729,6 +729,12 @@ maintainer-clean-local: ## Installation. ## ## -------------- ## +## FIXME: The current HTML outputs of technical.tex, tutorial.tex and +## ref-guide.tex are awful. Only install the white paper HTML product +## for the moment. +# DATA_html_dirs_inst = $(DATA_html_dirs) +DATA_html_dirs_inst = $(WHITE_PAPER) + # We install by hand, otherwise Automake produces "install .../srcdoc # .../srcdoc", which installs our dir into the previous one, instead # of replacing it. @@ -739,7 +745,7 @@ install-data-local: rm -rf $(DESTDIR)$(htmldir)/$(USER_REFMAN) cp -r $(srcdir)/$(USER_REFMAN)/html $(DESTDIR)$(htmldir)/$(USER_REFMAN) # Other HTML directories can be processed uniformly. - for d in $(DATA_html_dirs); do \ + for d in $(DATA_html_dirs_inst); do \ rm -rf $(DESTDIR)$(htmldir)/$$d; \ cp -r $(srcdir)/$$d $(DESTDIR)$(htmldir); \ done @@ -750,7 +756,7 @@ install-data-local: -o -exec chmod a+r {} \; uninstall-local: - for d in $(DATA_html_dirs); do \ + for d in $(DATA_html_dirs_inst); do \ chmod -R 700 $(DESTDIR)$(htmldir)/$$d; \ rm -rf $(DESTDIR)$(htmldir)/$$d; \ done -- 1.5.6.5

14 years, 1 month

last-svn-commit-112-gf169fdf Do not install low-quality HTML documentation.

by Roland Levillain

* doc/Makefile.am (DATA_html_dirs_inst): New. Use it... (install-data-local, uninstall-local): Here. --- milena/ChangeLog | 8 ++++++++ milena/doc/Makefile.am | 10 ++++++++-- 2 files changed, 16 insertions(+), 2 deletions(-) diff --git a/milena/ChangeLog b/milena/ChangeLog index f0a1d7a..00ab992 100644 --- a/milena/ChangeLog +++ b/milena/ChangeLog @@ -1,5 +1,13 @@ 2010-03-30 Roland Levillain <roland(a)lrde.epita.fr> + Do not install low-quality HTML documentation. + + * doc/Makefile.am (DATA_html_dirs_inst): New. + Use it... + (install-data-local, uninstall-local): Here. + +2010-03-30 Roland Levillain <roland(a)lrde.epita.fr> + Adjust the installation of the HTML documentation. * doc/Makefile.am (all-local): Do not depend on diff --git a/milena/doc/Makefile.am b/milena/doc/Makefile.am index 088cf41..273b3d8 100644 --- a/milena/doc/Makefile.am +++ b/milena/doc/Makefile.am @@ -729,6 +729,12 @@ maintainer-clean-local: ## Installation. ## ## -------------- ## +## FIXME: The current HTML outputs of technical.tex, tutorial.tex and +## ref-guide.tex are awful. Only install the white paper HTML product +## for the moment. +# DATA_html_dirs_inst = $(DATA_html_dirs) +DATA_html_dirs_inst = $(WHITE_PAPER) + # We install by hand, otherwise Automake produces "install .../srcdoc # .../srcdoc", which installs our dir into the previous one, instead # of replacing it. @@ -739,7 +745,7 @@ install-data-local: rm -rf $(DESTDIR)$(htmldir)/$(USER_REFMAN) cp -r $(srcdir)/$(USER_REFMAN)/html $(DESTDIR)$(htmldir)/$(USER_REFMAN) # Other HTML directories can be processed uniformly. - for d in $(DATA_html_dirs); do \ + for d in $(DATA_html_dirs_inst); do \ rm -rf $(DESTDIR)$(htmldir)/$$d; \ cp -r $(srcdir)/$$d $(DESTDIR)$(htmldir); \ done @@ -750,7 +756,7 @@ install-data-local: -o -exec chmod a+r {} \; uninstall-local: - for d in $(DATA_html_dirs); do \ + for d in $(DATA_html_dirs_inst); do \ chmod -R 700 $(DESTDIR)$(htmldir)/$$d; \ rm -rf $(DESTDIR)$(htmldir)/$$d; \ done -- 1.5.6.5

14 years, 1 month

last-svn-commit-118-ge4a1fc8 Adjust the installation of the HTML documentation.

by Roland Levillain

* doc/Makefile.am (all-local): Do not depend on $(srcdir)/$(USER_REFMAN_PDF). (dist_pdf_DATA): Add $(srcdir)/$(USER_REFMAN_PDF) instead of $(USER_REFMAN_PDF). (AM_CPPFLAGS): Remove -I$(top_srcdir)/milena/doc/tutorial/tools. (regen-doc, $(srcdir)/user-refman.stamp) (regen-devel-doc, $(srcdir)/devel-refman.stamp): Remove `-' before `rm' actions. (EXTRA_DIST): Add $(USER_REFMAN). (maintainer-clean-local) (install-data-local) (uninstall-local): Handle the new HTML subdirectories. (MAINTAINERCLEANFILES): Remove $(dist_html_DATA). --- milena/ChangeLog | 19 +++++++ milena/doc/Makefile.am | 136 ++++++++++++++++++++++++++++-------------------- 2 files changed, 98 insertions(+), 57 deletions(-) diff --git a/milena/ChangeLog b/milena/ChangeLog index 067b9f0..deee63a 100644 --- a/milena/ChangeLog +++ b/milena/ChangeLog @@ -1,5 +1,24 @@ 2010-03-30 Roland Levillain <roland(a)lrde.epita.fr> + Adjust the installation of the HTML documentation. + + * doc/Makefile.am (all-local): Do not depend on + $(srcdir)/$(USER_REFMAN_PDF). + (dist_pdf_DATA): Add $(srcdir)/$(USER_REFMAN_PDF) instead of + $(USER_REFMAN_PDF). + (AM_CPPFLAGS): Remove -I$(top_srcdir)/milena/doc/tutorial/tools. + (regen-doc, $(srcdir)/user-refman.stamp) + (regen-devel-doc, $(srcdir)/devel-refman.stamp): + Remove `-' before `rm' actions. + (EXTRA_DIST): Add $(USER_REFMAN). + (maintainer-clean-local) + (install-data-local) + (uninstall-local): + Handle the new HTML subdirectories. + (MAINTAINERCLEANFILES): Remove $(dist_html_DATA). + +2010-03-30 Roland Levillain <roland(a)lrde.epita.fr> + Move LaTeX sources at the root of doc/; generate HTML in subdirs. * doc/tutorial/tutorial.tex, diff --git a/milena/doc/Makefile.am b/milena/doc/Makefile.am index dcdca5a..088cf41 100644 --- a/milena/doc/Makefile.am +++ b/milena/doc/Makefile.am @@ -15,13 +15,10 @@ # You should have received a copy of the GNU General Public License # along with Olena. If not, see <http://www.gnu.org/licenses/>. -# FIXME: To be overhauled! (See ticket #134). -# Look for Milena header in srcdir and for (generated) test headers +# Look for Milena headers in srcdir and for (generated) test headers # (like data.hh) in builddir. -AM_CPPFLAGS = \ - -I$(top_srcdir)/milena -I$(top_builddir)/milena \ - -I$(top_srcdir)/milena/doc/tutorial/tools +AM_CPPFLAGS = -I$(top_srcdir)/milena -I$(top_builddir)/milena DOXYGEN = doxygen @@ -34,7 +31,6 @@ DOXYFILE = Doxyfile include $(top_srcdir)/build-aux/tex.mk -# FIXME: Check this list. TEXI2DVI_FLAGS += \ -I $(srcdir) -I $(srcdir)/outputs -I $(srcdir)/outputs/split \ -I $(srcdir)/img -I $(srcdir)/examples/split @@ -191,15 +187,15 @@ REFMAN_deps = \ $(srcdir)/ref-guide.hh # ----------------------- # -# User reference manual. # +# User Reference Manual. # # ----------------------- # -all-local: $(srcdir)/$(USER_REFMAN) $(srcdir)/$(USER_REFMAN_PDF) +all-local: $(srcdir)/$(USER_REFMAN) # Run "make regen-doc" to forcefully rebuild the Doxygen documentation. .PHONY: regen-doc regen-doc: - -rm -f $(srcdir)/user-refman.stamp + rm -f $(srcdir)/user-refman.stamp $(MAKE) $(AM_MAKEFLAGS) $(srcdir)/user-refman.stamp DOXYFILE_USER = Doxyfile_user @@ -224,45 +220,57 @@ $(DOXYFILE_USER): $(srcdir)/$(DOXYFILE).in $(edit) $< >$@ MAINTAINERCLEANFILES += $(DOXYFILE_USER) -USER_REFMAN_PDF = user-refman.pdf USER_REFMAN = user-refman +# PDF. +USER_REFMAN_PDF = user-refman.pdf +dist_pdf_DATA = $(srcdir)/$(USER_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 $@ +# HTML. EXTRA_DIST += $(srcdir)/user-refman.stamp MAINTAINERCLEANFILES += $(srcdir)/user-refman.stamp $(srcdir)/user-refman.stamp: $(srcdir)/$(DOXYFILE).in $(REFMAN_deps) @rm -f $@.tmp @touch $@.tmp - -rm -rf $(USER_REFMAN).tmp + 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 $(USER_REFMAN).tmp/latex/refman.tex - -rm -rf $(srcdir)/$(USER_REFMAN) + rm -rf $(srcdir)/$(USER_REFMAN) ## FIXME: Moving directories between file systems is not portable. mv $(USER_REFMAN).tmp $(srcdir)/$(USER_REFMAN) @mv -f $@.tmp $@ $(srcdir)/$(USER_REFMAN): $(srcdir)/user-refman.stamp -## Recover from the removal of $@ +## Recover from the removal of $@. @if test -d $@; then :; else \ rm -f $<; \ $(MAKE) $(AM_MAKEFLAGS) $<; \ fi +# Installing a directory located in the source dir is not supported by +# Automake by default, so we cannot simply add `$(USER_REFMAN)/html' +# to `dist_doc_DATA'. The rule `install-data-local' (see below) used +# to work around this limitation is borrowed from the Vaucanson +# project. +EXTRA_DIST += $(USER_REFMAN) + + # ---------------------------- # -# Developer reference manual. # +# Developer Reference Manual. # # ---------------------------- # # 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 + rm -f $(srcdir)/devel-refman.stamp $(MAKE) $(AM_MAKEFLAGS) $(srcdir)/devel-refman.stamp DOXYFILE_DEVEL = Doxyfile_devel @@ -291,9 +299,10 @@ $(DOXYFILE_DEVEL): $(srcdir)/$(DOXYFILE).in rm -f $@.tmp MAINTAINERCLEANFILES += $(DOXYFILE_DEVEL) -DEVEL_REFMAN_PDF = devel-refman.pdf DEVEL_REFMAN = devel-refman +# PDF. +DEVEL_REFMAN_PDF = devel-refman.pdf # 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. @@ -301,35 +310,30 @@ $(srcdir)/$(DEVEL_REFMAN_PDF): $(srcdir)/$(DEVEL_REFMAN) cd $(srcdir)/$(DEVEL_REFMAN)/latex && $(MAKE) $(AM_MAKEFLAGS) pdf cp -f $(srcdir)/$(DEVEL_REFMAN)/latex/refman.pdf $@ +# HTML. MAINTAINERCLEANFILES += $(srcdir)/devel-refman.stamp $(srcdir)/devel-refman.stamp: $(srcdir)/$(DOXYFILE).in $(REFMAN_deps) @rm -f $@.tmp @touch $@.tmp - -rm -rf $(DEVEL_REFMAN).tmp + 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 $(DEVEL_REFMAN).tmp/latex/refman.tex - -rm -rf $(srcdir)/$(DEVEL_REFMAN) + rm -rf $(srcdir)/$(DEVEL_REFMAN) ## FIXME: Moving directories between file systems is not portable. mv $(DEVEL_REFMAN).tmp $(srcdir)/$(DEVEL_REFMAN) @mv -f $@.tmp $@ $(srcdir)/$(DEVEL_REFMAN): $(srcdir)/devel-refman.stamp -## Recover from the removal of $@ +## Recover from the removal of $@. @if test -d $@; then :; else \ rm -f $<; \ $(MAKE) $(AM_MAKEFLAGS) $<; \ fi -# Clean Doxygen products. -maintainer-clean-local: - -rm -rf $(USER_REFMAN).tmp $(srcdir)/$(USER_REFMAN) - -rm -rf $(DEVEL_REFMAN).tmp $(srcdir)/$(DEVEL_REFMAN) - - ## ------------------------- ## ## Technical documentation. ## ## ------------------------- ## @@ -683,40 +687,9 @@ regen-am: ## -------------- ## -## Installation. ## +## Distribution. ## ## -------------- ## -# PDF. -dist_pdf_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 -# `dist_doc_DATA'. The following two rules are are workaround from -# the Vaucanson project. -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 - $(mkdir_p) $(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) || \ - find $(DESTDIR)$(htmldir) $ -type d -a -exec chmod a+rx {} \; $ \ - -o -exec chmod a+r {} \; - -uninstall-local: - chmod -R 700 $(DESTDIR)$(htmldir)/user-refman - rm -rf $(DESTDIR)$(htmldir)/user-refman - - -MAINTAINERCLEANFILES += $(dist_html_DATA) $(dist_pdf_DATA) - - EXTRA_DIST += \ $(DATA_html_dirs) \ $(DOXYFILE).in \ @@ -736,3 +709,52 @@ EXTRA_DIST += \ tools/sample_utils.hh \ tools/split_sample.sh \ tools/todoxygen.sh + + +## ---------- ## +## Cleaning. ## +## ---------- ## + +MAINTAINERCLEANFILES += $(dist_pdf_DATA) + +maintainer-clean-local: + -rm -rf $(USER_REFMAN).tmp $(srcdir)/$(USER_REFMAN) + -rm -rf $(DEVEL_REFMAN).tmp $(srcdir)/$(DEVEL_REFMAN) + -for d in $(DATA_html_dirs); do \ + rm -rf $$d.tmp $(srcdir)/$$d; \ + done + + +## -------------- ## +## Installation. ## +## -------------- ## + +# 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: + $(mkdir_p) $(DESTDIR)$(htmldir) +# The user reference manual is located in a subdirectory, hence this +# special case. + rm -rf $(DESTDIR)$(htmldir)/$(USER_REFMAN) + cp -r $(srcdir)/$(USER_REFMAN)/html $(DESTDIR)$(htmldir)/$(USER_REFMAN) +# Other HTML directories can be processed uniformly. + for d in $(DATA_html_dirs); do \ + rm -rf $(DESTDIR)$(htmldir)/$$d; \ + cp -r $(srcdir)/$$d $(DESTDIR)$(htmldir); \ + done +## Try GNU chmod's X mode before resorting to something slower but +## more standard. + chmod -R a+rX $(DESTDIR)$(htmldir) || \ + find $(DESTDIR)$(htmldir) $ -type d -a -exec chmod a+rx {} \; $ \ + -o -exec chmod a+r {} \; + +uninstall-local: + for d in $(DATA_html_dirs); do \ + chmod -R 700 $(DESTDIR)$(htmldir)/$$d; \ + rm -rf $(DESTDIR)$(htmldir)/$$d; \ + done +# Same remark as above regarding the special case of the user +# reference manual. + chmod -R 700 $(DESTDIR)$(htmldir)/$(USER_REFMAN) + rm -rf $(DESTDIR)$(htmldir)/$(USER_REFMAN) -- 1.5.6.5

14 years, 1 month

last-svn-commit-111-gb210a23 Adjust the installation of the HTML documentation.

by Roland Levillain

* doc/Makefile.am (all-local): Do not depend on $(srcdir)/$(USER_REFMAN_PDF). (dist_pdf_DATA): Add $(srcdir)/$(USER_REFMAN_PDF) instead of $(USER_REFMAN_PDF). (AM_CPPFLAGS): Remove -I$(top_srcdir)/milena/doc/tutorial/tools. (regen-doc, $(srcdir)/user-refman.stamp) (regen-devel-doc, $(srcdir)/devel-refman.stamp): Remove `-' before `rm' actions. (EXTRA_DIST): Add $(USER_REFMAN). (maintainer-clean-local) (install-data-local) (uninstall-local): Handle the new HTML subdirectories. (MAINTAINERCLEANFILES): Remove $(dist_html_DATA). --- milena/ChangeLog | 19 +++++++ milena/doc/Makefile.am | 136 ++++++++++++++++++++++++++++-------------------- 2 files changed, 98 insertions(+), 57 deletions(-) diff --git a/milena/ChangeLog b/milena/ChangeLog index 0f53ae2..f0a1d7a 100644 --- a/milena/ChangeLog +++ b/milena/ChangeLog @@ -1,5 +1,24 @@ 2010-03-30 Roland Levillain <roland(a)lrde.epita.fr> + Adjust the installation of the HTML documentation. + + * doc/Makefile.am (all-local): Do not depend on + $(srcdir)/$(USER_REFMAN_PDF). + (dist_pdf_DATA): Add $(srcdir)/$(USER_REFMAN_PDF) instead of + $(USER_REFMAN_PDF). + (AM_CPPFLAGS): Remove -I$(top_srcdir)/milena/doc/tutorial/tools. + (regen-doc, $(srcdir)/user-refman.stamp) + (regen-devel-doc, $(srcdir)/devel-refman.stamp): + Remove `-' before `rm' actions. + (EXTRA_DIST): Add $(USER_REFMAN). + (maintainer-clean-local) + (install-data-local) + (uninstall-local): + Handle the new HTML subdirectories. + (MAINTAINERCLEANFILES): Remove $(dist_html_DATA). + +2010-03-30 Roland Levillain <roland(a)lrde.epita.fr> + Move LaTeX sources at the root of doc/; generate HTML in subdirs. * doc/tutorial/tutorial.tex, diff --git a/milena/doc/Makefile.am b/milena/doc/Makefile.am index dcdca5a..088cf41 100644 --- a/milena/doc/Makefile.am +++ b/milena/doc/Makefile.am @@ -15,13 +15,10 @@ # You should have received a copy of the GNU General Public License # along with Olena. If not, see <http://www.gnu.org/licenses/>. -# FIXME: To be overhauled! (See ticket #134). -# Look for Milena header in srcdir and for (generated) test headers +# Look for Milena headers in srcdir and for (generated) test headers # (like data.hh) in builddir. -AM_CPPFLAGS = \ - -I$(top_srcdir)/milena -I$(top_builddir)/milena \ - -I$(top_srcdir)/milena/doc/tutorial/tools +AM_CPPFLAGS = -I$(top_srcdir)/milena -I$(top_builddir)/milena DOXYGEN = doxygen @@ -34,7 +31,6 @@ DOXYFILE = Doxyfile include $(top_srcdir)/build-aux/tex.mk -# FIXME: Check this list. TEXI2DVI_FLAGS += \ -I $(srcdir) -I $(srcdir)/outputs -I $(srcdir)/outputs/split \ -I $(srcdir)/img -I $(srcdir)/examples/split @@ -191,15 +187,15 @@ REFMAN_deps = \ $(srcdir)/ref-guide.hh # ----------------------- # -# User reference manual. # +# User Reference Manual. # # ----------------------- # -all-local: $(srcdir)/$(USER_REFMAN) $(srcdir)/$(USER_REFMAN_PDF) +all-local: $(srcdir)/$(USER_REFMAN) # Run "make regen-doc" to forcefully rebuild the Doxygen documentation. .PHONY: regen-doc regen-doc: - -rm -f $(srcdir)/user-refman.stamp + rm -f $(srcdir)/user-refman.stamp $(MAKE) $(AM_MAKEFLAGS) $(srcdir)/user-refman.stamp DOXYFILE_USER = Doxyfile_user @@ -224,45 +220,57 @@ $(DOXYFILE_USER): $(srcdir)/$(DOXYFILE).in $(edit) $< >$@ MAINTAINERCLEANFILES += $(DOXYFILE_USER) -USER_REFMAN_PDF = user-refman.pdf USER_REFMAN = user-refman +# PDF. +USER_REFMAN_PDF = user-refman.pdf +dist_pdf_DATA = $(srcdir)/$(USER_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 $@ +# HTML. EXTRA_DIST += $(srcdir)/user-refman.stamp MAINTAINERCLEANFILES += $(srcdir)/user-refman.stamp $(srcdir)/user-refman.stamp: $(srcdir)/$(DOXYFILE).in $(REFMAN_deps) @rm -f $@.tmp @touch $@.tmp - -rm -rf $(USER_REFMAN).tmp + 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 $(USER_REFMAN).tmp/latex/refman.tex - -rm -rf $(srcdir)/$(USER_REFMAN) + rm -rf $(srcdir)/$(USER_REFMAN) ## FIXME: Moving directories between file systems is not portable. mv $(USER_REFMAN).tmp $(srcdir)/$(USER_REFMAN) @mv -f $@.tmp $@ $(srcdir)/$(USER_REFMAN): $(srcdir)/user-refman.stamp -## Recover from the removal of $@ +## Recover from the removal of $@. @if test -d $@; then :; else \ rm -f $<; \ $(MAKE) $(AM_MAKEFLAGS) $<; \ fi +# Installing a directory located in the source dir is not supported by +# Automake by default, so we cannot simply add `$(USER_REFMAN)/html' +# to `dist_doc_DATA'. The rule `install-data-local' (see below) used +# to work around this limitation is borrowed from the Vaucanson +# project. +EXTRA_DIST += $(USER_REFMAN) + + # ---------------------------- # -# Developer reference manual. # +# Developer Reference Manual. # # ---------------------------- # # 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 + rm -f $(srcdir)/devel-refman.stamp $(MAKE) $(AM_MAKEFLAGS) $(srcdir)/devel-refman.stamp DOXYFILE_DEVEL = Doxyfile_devel @@ -291,9 +299,10 @@ $(DOXYFILE_DEVEL): $(srcdir)/$(DOXYFILE).in rm -f $@.tmp MAINTAINERCLEANFILES += $(DOXYFILE_DEVEL) -DEVEL_REFMAN_PDF = devel-refman.pdf DEVEL_REFMAN = devel-refman +# PDF. +DEVEL_REFMAN_PDF = devel-refman.pdf # 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. @@ -301,35 +310,30 @@ $(srcdir)/$(DEVEL_REFMAN_PDF): $(srcdir)/$(DEVEL_REFMAN) cd $(srcdir)/$(DEVEL_REFMAN)/latex && $(MAKE) $(AM_MAKEFLAGS) pdf cp -f $(srcdir)/$(DEVEL_REFMAN)/latex/refman.pdf $@ +# HTML. MAINTAINERCLEANFILES += $(srcdir)/devel-refman.stamp $(srcdir)/devel-refman.stamp: $(srcdir)/$(DOXYFILE).in $(REFMAN_deps) @rm -f $@.tmp @touch $@.tmp - -rm -rf $(DEVEL_REFMAN).tmp + 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 $(DEVEL_REFMAN).tmp/latex/refman.tex - -rm -rf $(srcdir)/$(DEVEL_REFMAN) + rm -rf $(srcdir)/$(DEVEL_REFMAN) ## FIXME: Moving directories between file systems is not portable. mv $(DEVEL_REFMAN).tmp $(srcdir)/$(DEVEL_REFMAN) @mv -f $@.tmp $@ $(srcdir)/$(DEVEL_REFMAN): $(srcdir)/devel-refman.stamp -## Recover from the removal of $@ +## Recover from the removal of $@. @if test -d $@; then :; else \ rm -f $<; \ $(MAKE) $(AM_MAKEFLAGS) $<; \ fi -# Clean Doxygen products. -maintainer-clean-local: - -rm -rf $(USER_REFMAN).tmp $(srcdir)/$(USER_REFMAN) - -rm -rf $(DEVEL_REFMAN).tmp $(srcdir)/$(DEVEL_REFMAN) - - ## ------------------------- ## ## Technical documentation. ## ## ------------------------- ## @@ -683,40 +687,9 @@ regen-am: ## -------------- ## -## Installation. ## +## Distribution. ## ## -------------- ## -# PDF. -dist_pdf_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 -# `dist_doc_DATA'. The following two rules are are workaround from -# the Vaucanson project. -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 - $(mkdir_p) $(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) || \ - find $(DESTDIR)$(htmldir) $ -type d -a -exec chmod a+rx {} \; $ \ - -o -exec chmod a+r {} \; - -uninstall-local: - chmod -R 700 $(DESTDIR)$(htmldir)/user-refman - rm -rf $(DESTDIR)$(htmldir)/user-refman - - -MAINTAINERCLEANFILES += $(dist_html_DATA) $(dist_pdf_DATA) - - EXTRA_DIST += \ $(DATA_html_dirs) \ $(DOXYFILE).in \ @@ -736,3 +709,52 @@ EXTRA_DIST += \ tools/sample_utils.hh \ tools/split_sample.sh \ tools/todoxygen.sh + + +## ---------- ## +## Cleaning. ## +## ---------- ## + +MAINTAINERCLEANFILES += $(dist_pdf_DATA) + +maintainer-clean-local: + -rm -rf $(USER_REFMAN).tmp $(srcdir)/$(USER_REFMAN) + -rm -rf $(DEVEL_REFMAN).tmp $(srcdir)/$(DEVEL_REFMAN) + -for d in $(DATA_html_dirs); do \ + rm -rf $$d.tmp $(srcdir)/$$d; \ + done + + +## -------------- ## +## Installation. ## +## -------------- ## + +# 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: + $(mkdir_p) $(DESTDIR)$(htmldir) +# The user reference manual is located in a subdirectory, hence this +# special case. + rm -rf $(DESTDIR)$(htmldir)/$(USER_REFMAN) + cp -r $(srcdir)/$(USER_REFMAN)/html $(DESTDIR)$(htmldir)/$(USER_REFMAN) +# Other HTML directories can be processed uniformly. + for d in $(DATA_html_dirs); do \ + rm -rf $(DESTDIR)$(htmldir)/$$d; \ + cp -r $(srcdir)/$$d $(DESTDIR)$(htmldir); \ + done +## Try GNU chmod's X mode before resorting to something slower but +## more standard. + chmod -R a+rX $(DESTDIR)$(htmldir) || \ + find $(DESTDIR)$(htmldir) $ -type d -a -exec chmod a+rx {} \; $ \ + -o -exec chmod a+r {} \; + +uninstall-local: + for d in $(DATA_html_dirs); do \ + chmod -R 700 $(DESTDIR)$(htmldir)/$$d; \ + rm -rf $(DESTDIR)$(htmldir)/$$d; \ + done +# Same remark as above regarding the special case of the user +# reference manual. + chmod -R 700 $(DESTDIR)$(htmldir)/$(USER_REFMAN) + rm -rf $(DESTDIR)$(htmldir)/$(USER_REFMAN) -- 1.5.6.5

14 years, 1 month

last-svn-commit-117-g5bb9350 Move LaTeX sources at the root of doc/; generate HTML in subdirs.

by Roland Levillain

* doc/tutorial/tutorial.tex, * doc/technical/technical.tex, * doc/ref_guide/ref_guide.tex, * doc/white_paper/white_paper.tex: Move... * doc/tutorial.tex, * doc/technical.tex, * doc/ref-guide.tex, * doc/white-paper.tex: ...here. * doc/graphicx.hva: New. * doc/technical/figures/file_layout.pdf, * doc/technical/figures/file_layout.png, * doc/white_paper/figures/house.png, * doc/white_paper/figures/house_rag.png, * doc/white_paper/figures/house_wshed.png, * doc/white_paper/figures/house_wshed_mean_colors.png: Move... * doc/figures/technical/file_layout.pdf, * doc/figures/technical/file_layout.png, * doc/figures/house.png, * doc/figures/house_rag.png, * doc/figures/house_wshed.png, * doc/figures/house_wshed_mean_colors.png: ...here. * doc/technical.tex: Adjust paths. * doc/technical/designs/, * doc/tutorial/designs/, * doc/tutorial/doxyfile_tuto.local, * doc/tutorial/image_types.txt, * doc/tutorial/image_values.txt, * doc/tutorial/images_tour.txt, * doc/tutorial/slides.tex: Rename as... * doc/technical.old/designs/, * doc/tutorial.old/design/, * doc/tutorial.old/doxyfile_tuto.local, * doc/tutorial.old/image_types.txt, * doc/tutorial.old/image_values.txt, * doc/tutorial.old/images_tour.txt, * doc/tutorial.old/slides.tex: ...this. * tutorial/headers.stamp: Remove. * doc/Makefile.am (REFMAN_deps): Rename as... (refman_dependencies): ...this. Adjust paths. ($(srcdir)/user-refman.stamp, $(srcdir)/devel-refman.stamp): Adjust. (PNGS, EPSS): Remove. (.png.eps): Remove rule. (TECHNICAL_FIGURES, WHITE_PAPER_FIGURES): New. (MORE_FIGURES): Add $(TECHNICAL_FIGURES) and $(WHITE_PAPER_FIGURES). (technical_dir, tutorial_dir, white_paper_dir, ref_guide_dir): Remove. (TECHNICAL, TUTORIAL, WHITE_PAPER, REF_GUIDE): New. (TECHNICAL_PDF, TUTORIAL_PDF, WHITE_PAPER_PDF, REF_GUIDE_PDF) (TUTORIAL_HH, REF_GUIDE_HH) (EXTRA_DIST, MAINTAINERCLEANFILES): Adjust. Remove (EPSS). (EXTRA_DIST): Remove $(PNGS). Add graphicx.hva. (technical_dependencies) (tutorial_dependencies) (ref_guide_dependencies): Rename as... (TECHNICAL_deps) (TUTORIAL_deps) (REF_GUIDE_deps): ...this. (TECHNICAL_deps): Add $(TECHNICAL_FIGURES). (WHITE_PAPER_deps): New. ($(TECHNICAL_PDF)) ($(TUTORIAL_PDF)) ($(WHITE_PAPER_PDF)) ($(REF_GUIDE_PDF)): Adjust. (TECHNICAL_HTML, TECHNICAL_HTML_OUTPUTS) (TUTORIAL_HTML, TUTORIAL_HTML_OUTPUTS) (WHITE_PAPER_HTML, WHITE_PAPER_HTML_OUTPUTS) (REF_GUIDE_HTML, REF_GUIDE_HTML_OUTPUTS): Remove. (all-local): Depend on $(srcdir)/$(TECHNICAL).stamp, $(srcdir)/$(TUTORIAL).stamp, $(srcdir)/$(WHITE_PAPER).stamp and $(srcdir)/$(REF_GUIDE).stamp. ($(TECHNICAL_HTML).stamp) ($(TUTORIAL_HTML).stamp) ($(WHITE_PAPER_HTML).stamp) ($(REF_GUIDE_HTML).stamp): Turn targets into... ($(srcdir)/$(TECHNICAL).stamp) ($(srcdir)/$(TUTORIAL).stamp) ($(srcdir)/$(WHITE_PAPER).stamp) ($(srcdir)/$(REF_GUIDE).stamp): ...this. Adjust rules to generate outputs in a subdirectory. ($(TECHNICAL_HTML_OUTPUTS)) ($(TUTORIAL_HTML_OUTPUTS)) ($(WHITE_PAPER_HTML_OUTPUTS)) ($(REF_GUIDE_HTML_OUTPUTS)): Turn targets into... ($(srcdir)/$(TECHNICAL)) ($(srcdir)/$(TUTORIAL)) ($(srcdir)/$(WHITE_PAPER)) ($(srcdir)/$(REF_GUIDE)): ...this. Adjust. ($(TUTORIAL_HH)): Depend on $(srcdir)/$(TUTORIAL).stamp. Adjust rule. ($(REF_GUIDE_HH)): Depend on (srcdir)/$(REF_GUIDE).stamp. Adjust rule. (dist_html_DATA): Remove. (DATA_html_dirs): New. (EXTRA_DIST): Add $(DATA_html_dirs). --- milena/ChangeLog | 121 ++++++++ milena/doc/.gitignore | 33 +-- milena/doc/Makefile.am | 309 ++++++++++---------- milena/doc/{white_paper => }/figures/house.png | Bin 26653 -> 26653 bytes milena/doc/{white_paper => }/figures/house_rag.png | Bin 9454 -> 9454 bytes .../doc/{white_paper => }/figures/house_wshed.png | Bin 27668 -> 27668 bytes .../figures/house_wshed_mean_colors.png | Bin 6618 -> 6618 bytes .../figures => figures/technical}/file_layout.pdf | Bin 26680 -> 26680 bytes .../figures => figures/technical}/file_layout.png | Bin 117801 -> 117801 bytes milena/doc/graphicx.hva | 3 + .../doc/{ref_guide/ref_guide.tex => ref-guide.tex} | 0 .../designs/properties/values.txt | 0 .../designs/site_psite_piter/README | 0 milena/doc/{technical => }/technical.tex | 6 +- .../doc/{tutorial => tutorial.old}/design/Makefile | 0 .../{tutorial => tutorial.old}/design/design.tex | 0 .../design/include/imagetours.tex | 0 .../design/include/properties.tex | 0 .../{tutorial => tutorial.old}/doxyfile_tuto.local | 0 .../doc/{tutorial => tutorial.old}/image_types.txt | 0 .../{tutorial => tutorial.old}/image_values.txt | 0 .../doc/{tutorial => tutorial.old}/images_tour.txt | 0 milena/doc/{tutorial => tutorial.old}/slides.tex | 0 milena/doc/{tutorial => }/tutorial.tex | 0 .../white_paper.tex => white-paper.tex} | 0 25 files changed, 291 insertions(+), 181 deletions(-) rename milena/doc/{white_paper => }/figures/house.png (100%) rename milena/doc/{white_paper => }/figures/house_rag.png (100%) rename milena/doc/{white_paper => }/figures/house_wshed.png (100%) rename milena/doc/{white_paper => }/figures/house_wshed_mean_colors.png (100%) rename milena/doc/{technical/figures => figures/technical}/file_layout.pdf (100%) rename milena/doc/{technical/figures => figures/technical}/file_layout.png (100%) create mode 100644 milena/doc/graphicx.hva rename milena/doc/{ref_guide/ref_guide.tex => ref-guide.tex} (100%) rename milena/doc/{technical => technical.old}/designs/properties/values.txt (100%) rename milena/doc/{technical => technical.old}/designs/site_psite_piter/README (100%) rename milena/doc/{technical => }/technical.tex (96%) rename milena/doc/{tutorial => tutorial.old}/design/Makefile (100%) rename milena/doc/{tutorial => tutorial.old}/design/design.tex (100%) rename milena/doc/{tutorial => tutorial.old}/design/include/imagetours.tex (100%) rename milena/doc/{tutorial => tutorial.old}/design/include/properties.tex (100%) rename milena/doc/{tutorial => tutorial.old}/doxyfile_tuto.local (100%) rename milena/doc/{tutorial => tutorial.old}/image_types.txt (100%) rename milena/doc/{tutorial => tutorial.old}/image_values.txt (100%) rename milena/doc/{tutorial => tutorial.old}/images_tour.txt (100%) rename milena/doc/{tutorial => tutorial.old}/slides.tex (100%) rename milena/doc/{tutorial => }/tutorial.tex (100%) delete mode 100644 milena/doc/tutorial/headers.stamp rename milena/doc/{white_paper/white_paper.tex => white-paper.tex} (100%) diff --git a/milena/ChangeLog b/milena/ChangeLog index 6f8eec9..067b9f0 100644 --- a/milena/ChangeLog +++ b/milena/ChangeLog @@ -1,3 +1,124 @@ +2010-03-30 Roland Levillain <roland(a)lrde.epita.fr> + + Move LaTeX sources at the root of doc/; generate HTML in subdirs. + + * doc/tutorial/tutorial.tex, + * doc/technical/technical.tex, + * doc/ref_guide/ref_guide.tex, + * doc/white_paper/white_paper.tex: + Move... + * doc/tutorial.tex, + * doc/technical.tex, + * doc/ref-guide.tex, + * doc/white-paper.tex: + ...here. + * doc/graphicx.hva: New. + * doc/technical/figures/file_layout.pdf, + * doc/technical/figures/file_layout.png, + * doc/white_paper/figures/house.png, + * doc/white_paper/figures/house_rag.png, + * doc/white_paper/figures/house_wshed.png, + * doc/white_paper/figures/house_wshed_mean_colors.png: + Move... + * doc/figures/technical/file_layout.pdf, + * doc/figures/technical/file_layout.png, + * doc/figures/house.png, + * doc/figures/house_rag.png, + * doc/figures/house_wshed.png, + * doc/figures/house_wshed_mean_colors.png: + ...here. + * doc/technical.tex: Adjust paths. + * doc/technical/designs/, + * doc/tutorial/designs/, + * doc/tutorial/doxyfile_tuto.local, + * doc/tutorial/image_types.txt, + * doc/tutorial/image_values.txt, + * doc/tutorial/images_tour.txt, + * doc/tutorial/slides.tex: + Rename as... + * doc/technical.old/designs/, + * doc/tutorial.old/design/, + * doc/tutorial.old/doxyfile_tuto.local, + * doc/tutorial.old/image_types.txt, + * doc/tutorial.old/image_values.txt, + * doc/tutorial.old/images_tour.txt, + * doc/tutorial.old/slides.tex: + ...this. + * tutorial/headers.stamp: Remove. + * doc/Makefile.am (REFMAN_deps): Rename as... + (refman_dependencies): ...this. + Adjust paths. + ($(srcdir)/user-refman.stamp, $(srcdir)/devel-refman.stamp): + Adjust. + (PNGS, EPSS): Remove. + (.png.eps): Remove rule. + (TECHNICAL_FIGURES, WHITE_PAPER_FIGURES): New. + (MORE_FIGURES): Add $(TECHNICAL_FIGURES) and + $(WHITE_PAPER_FIGURES). + (technical_dir, tutorial_dir, white_paper_dir, ref_guide_dir): + Remove. + (TECHNICAL, TUTORIAL, WHITE_PAPER, REF_GUIDE): New. + (TECHNICAL_PDF, TUTORIAL_PDF, WHITE_PAPER_PDF, REF_GUIDE_PDF) + (TUTORIAL_HH, REF_GUIDE_HH) + (EXTRA_DIST, MAINTAINERCLEANFILES): Adjust. + Remove (EPSS). + (EXTRA_DIST): Remove $(PNGS). + Add graphicx.hva. + (technical_dependencies) + (tutorial_dependencies) + (ref_guide_dependencies): + Rename as... + (TECHNICAL_deps) + (TUTORIAL_deps) + (REF_GUIDE_deps): + ...this. + (TECHNICAL_deps): Add $(TECHNICAL_FIGURES). + (WHITE_PAPER_deps): New. + ($(TECHNICAL_PDF)) + ($(TUTORIAL_PDF)) + ($(WHITE_PAPER_PDF)) + ($(REF_GUIDE_PDF)): + Adjust. + (TECHNICAL_HTML, TECHNICAL_HTML_OUTPUTS) + (TUTORIAL_HTML, TUTORIAL_HTML_OUTPUTS) + (WHITE_PAPER_HTML, WHITE_PAPER_HTML_OUTPUTS) + (REF_GUIDE_HTML, REF_GUIDE_HTML_OUTPUTS): + Remove. + (all-local): Depend on + $(srcdir)/$(TECHNICAL).stamp, + $(srcdir)/$(TUTORIAL).stamp, + $(srcdir)/$(WHITE_PAPER).stamp and + $(srcdir)/$(REF_GUIDE).stamp. + ($(TECHNICAL_HTML).stamp) + ($(TUTORIAL_HTML).stamp) + ($(WHITE_PAPER_HTML).stamp) + ($(REF_GUIDE_HTML).stamp): + Turn targets into... + ($(srcdir)/$(TECHNICAL).stamp) + ($(srcdir)/$(TUTORIAL).stamp) + ($(srcdir)/$(WHITE_PAPER).stamp) + ($(srcdir)/$(REF_GUIDE).stamp): + ...this. + Adjust rules to generate outputs in a subdirectory. + ($(TECHNICAL_HTML_OUTPUTS)) + ($(TUTORIAL_HTML_OUTPUTS)) + ($(WHITE_PAPER_HTML_OUTPUTS)) + ($(REF_GUIDE_HTML_OUTPUTS)): + Turn targets into... + ($(srcdir)/$(TECHNICAL)) + ($(srcdir)/$(TUTORIAL)) + ($(srcdir)/$(WHITE_PAPER)) + ($(srcdir)/$(REF_GUIDE)): + ...this. + Adjust. + ($(TUTORIAL_HH)): Depend on $(srcdir)/$(TUTORIAL).stamp. + Adjust rule. + ($(REF_GUIDE_HH)): Depend on (srcdir)/$(REF_GUIDE).stamp. + Adjust rule. + (dist_html_DATA): Remove. + (DATA_html_dirs): New. + (EXTRA_DIST): Add $(DATA_html_dirs). + 2010-03-26 Roland Levillain <roland(a)lrde.epita.fr> No longer generate doc/technical/technical.hh. diff --git a/milena/doc/.gitignore b/milena/doc/.gitignore index 506bfa4..3c88ad7 100644 --- a/milena/doc/.gitignore +++ b/milena/doc/.gitignore @@ -8,29 +8,16 @@ /figures/*.png -/ref_guide/ref_guide.css -/ref_guide/ref_guide.hh -/ref_guide/ref_guide.html -/ref_guide/ref_guide.pdf -/ref_guide/ref_guide0x.png +/ref-guide.hh +/ref-guide.pdf +/ref-guide/ -/technical/technical.css -/technical/technical.html -/technical/technical.pdf +/technical.pdf +/technical/ -/tutorial/tutorial.css -/tutorial/tutorial.hh -/tutorial/tutorial.html -/tutorial/tutorial.pdf +/tutorial.hh +/tutorial.pdf +/tutorial/ -/white_paper/figures/house.eps -/white_paper/figures/house_rag.eps -/white_paper/figures/house_wshed.eps -/white_paper/figures/house_wshed_mean_colors.eps -/white_paper/white_paper.css -/white_paper/white_paper.html -/white_paper/white_paper.pdf -/white_paper/white_paper0x.png -/white_paper/white_paper1x.png -/white_paper/white_paper2x.png -/white_paper/white_paper3x.png +/white-paper.pdf +/white-paper/ diff --git a/milena/doc/Makefile.am b/milena/doc/Makefile.am index 25116c1..dcdca5a 100644 --- a/milena/doc/Makefile.am +++ b/milena/doc/Makefile.am @@ -95,8 +95,21 @@ MAINTAINERCLEANFILES += $(PNG_FIGURES) # Other figures. # # --------------- # +TECHNICAL_FIGURES = \ + figures/technical/file_layout.pdf \ + figures/technical/file_layout.png +MORE_FIGURES = $(TECHNICAL_FIGURES) + +WHITE_PAPER_FIGURES = \ + $(srcdir)/figures/house.png \ + $(srcdir)/figures/house_rag.png \ + $(srcdir)/figures/house_wshed.png \ + $(srcdir)/figures/house_wshed_mean_colors.png +MORE_FIGURES += $(WHITE_PAPER_FIGURES) + # This image seems to be used nowhere. -MORE_FIGURES = figures/accu_image_morpher_big_picture.pdf +MORE_FIGURES += figures/accu_image_morpher_big_picture.pdf + EXTRA_DIST += $(MORE_FIGURES) @@ -172,10 +185,10 @@ regen-split-examples-mk: ## Doxygen documentation. ## ## ----------------------- ## -refman_dependencies = \ +REFMAN_deps = \ $(PNG_FIGURES) \ - $(srcdir)/tutorial/tutorial.hh \ - $(srcdir)/ref_guide/ref_guide.hh + $(srcdir)/tutorial.hh \ + $(srcdir)/ref-guide.hh # ----------------------- # # User reference manual. # @@ -220,7 +233,7 @@ $(srcdir)/$(USER_REFMAN_PDF): $(srcdir)/$(USER_REFMAN) EXTRA_DIST += $(srcdir)/user-refman.stamp MAINTAINERCLEANFILES += $(srcdir)/user-refman.stamp -$(srcdir)/user-refman.stamp: $(srcdir)/$(DOXYFILE).in $(refman_dependencies) +$(srcdir)/user-refman.stamp: $(srcdir)/$(DOXYFILE).in $(REFMAN_deps) @rm -f $@.tmp @touch $@.tmp -rm -rf $(USER_REFMAN).tmp @@ -289,7 +302,7 @@ $(srcdir)/$(DEVEL_REFMAN_PDF): $(srcdir)/$(DEVEL_REFMAN) cp -f $(srcdir)/$(DEVEL_REFMAN)/latex/refman.pdf $@ MAINTAINERCLEANFILES += $(srcdir)/devel-refman.stamp -$(srcdir)/devel-refman.stamp: $(srcdir)/$(DOXYFILE).in $(refman_dependencies) +$(srcdir)/devel-refman.stamp: $(srcdir)/$(DOXYFILE).in $(REFMAN_deps) @rm -f $@.tmp @touch $@.tmp -rm -rf $(DEVEL_REFMAN).tmp @@ -318,57 +331,59 @@ maintainer-clean-local: ## ------------------------- ## -## Technical Documentation. ## +## Technical documentation. ## ## ------------------------- ## -technical_dir = $(srcdir)/technical +EXTRA_DIST += technical.tex -technical_dependencies = \ +TECHNICAL_deps = \ + $(TECHNICAL_FIGURES) \ $(TECHNICAL_EXAMPLES) \ $(PNG_FIGURES) \ $(DOC_PACKAGES) -# Final product. -TECHNICAL_HTML = $(technical_dir)/technical.html -TECHNICAL_HTML_OUTPUTS = $(TECHNICAL_HTML) $(technical_dir)/technical.css +# PDF. +TECHNICAL_PDF = $(srcdir)/technical.pdf +dist_pdf_DATA += $(TECHNICAL_PDF) +$(TECHNICAL_PDF): $(TECHNICAL_deps) -EXTRA_DIST += $(TECHNICAL_HTML).stamp -MAINTAINERCLEANFILES += $(TECHNICAL_HTML).stamp -# HTML outputs contains several files (the HTML file itself, its CSS -# style sheet, possibly some images). Therefore, we cannot rely on a -# simple suffix rule to produce them. -$(TECHNICAL_HTML).stamp: $(technical_dir)/technical.tex $(technical_dependencies) +# HTML. +TECHNICAL = technical +all-local: $(srcdir)/$(TECHNICAL).stamp +# The HTML output contains several files (the HTML file itself, its +# CSS style sheet, possibly some images). Therefore, we cannot rely +# on a simple suffix rule to produce them. Instead, put the products +# in a directory and use a time stamp. +$(srcdir)/$(TECHNICAL).stamp: $(srcdir)/technical.tex $(TECHNICAL_deps) @rm -f $@.tmp @touch $@.tmp - $(TEXI2HTML) $(TEXI2HTML_FLAGS) -o $(TECHNICAL_HTML) $< + rm -rf $(TECHNICAL).tmp + mkdir $(TECHNICAL).tmp + $(TEXI2HTML) $(TEXI2HTML_FLAGS) \ + -o $(TECHNICAL).tmp/$(TECHNICAL).html $< + rm -rf $(srcdir)/$(TECHNICAL) +## FIXME: moving directories between file systems is not portable. + mv $(TECHNICAL).tmp $(srcdir)/$(TECHNICAL) @mv -f $@.tmp $@ +EXTRA_DIST += $(srcdir)/$(TECHNICAL).stamp +MAINTAINERCLEANFILES += $(srcdir)/$(TECHNICAL).stamp -$(TECHNICAL_HTML_OUTPUTS): $(TECHNICAL_HTML).stamp -## Recover from the removal of $@ - @if test -f $@; then :; else \ +$(srcdir)/$(TECHNICAL): $(srcdir)/$(TECHNICAL).stamp +## Recover from the removal of $@. + @if test -d $@; then :; else \ rm -f $<; \ $(MAKE) $(AM_MAKEFLAGS) $<; \ fi - -dist_html_DATA = $(TECHNICAL_HTML_OUTPUTS) - -# Final product. -TECHNICAL_PDF = $(technical_dir)/technical.pdf -# Extra dependencies. -$(TECHNICAL_PDF): $(technical_dependencies) - -dist_pdf_DATA = $(TECHNICAL_PDF) - -EXTRA_DIST += $(technical_dir)/technical.tex +DATA_html_dirs = $(TECHNICAL) ## ---------- ## ## Tutorial. ## ## ---------- ## -tutorial_dir = $(srcdir)/tutorial +EXTRA_DIST += tutorial.tex -tutorial_dependencies = \ +TUTORIAL_deps = \ $(EXAMPLES) \ $(SPLIT_EXAMPLES) \ $(OUTPUTS) \ @@ -376,58 +391,57 @@ tutorial_dependencies = \ $(PNG_FIGURES) \ $(DOC_PACKAGES) -# Final product. -TUTORIAL_HTML = $(tutorial_dir)/tutorial.html -TUTORIAL_HTML_OUTPUTS = $(TUTORIAL_HTML) $(tutorial_dir)/tutorial.css +# PDF. +TUTORIAL_PDF = $(srcdir)/tutorial.pdf +dist_pdf_DATA += $(TUTORIAL_PDF) +$(TUTORIAL_PDF): $(TUTORIAL_deps) -EXTRA_DIST += $(TUTORIAL_HTML).stamp -MAINTAINERCLEANFILES += $(TUTORIAL_HTML).stamp -# HTML outputs contains several files (the HTML file itself, its CSS -# style sheet, possibly some images). Therefore, we cannot rely on a -# simple suffix rule to produce them. -$(TUTORIAL_HTML).stamp: $(tutorial_dir)/tutorial.tex $(tutorial_dependencies) +# HTML. +TUTORIAL = tutorial +all-local: $(srcdir)/$(TUTORIAL).stamp + +# The HTML output contains several files (the HTML file itself, its +# CSS style sheet, possibly some images). Therefore, we cannot rely +# on a simple suffix rule to produce them. Instead, put the products +# in a directory and use a time stamp. +$(srcdir)/$(TUTORIAL).stamp: $(srcdir)/tutorial.tex $(TUTORIAL_deps) @rm -f $@.tmp @touch $@.tmp - $(TEXI2HTML) $(TEXI2HTML_FLAGS) -o $(TUTORIAL_HTML) $< + rm -rf $(TUTORIAL).tmp + mkdir $(TUTORIAL).tmp + $(TEXI2HTML) $(TEXI2HTML_FLAGS) \ + -o $(TUTORIAL).tmp/$(TUTORIAL).html $< + rm -rf $(srcdir)/$(TUTORIAL) +## FIXME: moving directories between file systems is not portable. + mv $(TUTORIAL).tmp $(srcdir)/$(TUTORIAL) @mv -f $@.tmp $@ +EXTRA_DIST += $(srcdir)/$(TUTORIAL).stamp +MAINTAINERCLEANFILES += $(srcdir)/$(TUTORIAL).stamp -$(TUTORIAL_HTML_OUTPUTS): $(TUTORIAL_HTML).stamp -## Recover from the removal of $@ - @if test -f $@; then :; else \ +$(srcdir)/$(TUTORIAL): $(srcdir)/$(TUTORIAL).stamp +## Recover from the removal of $@. + @if test -d $@; then :; else \ rm -f $<; \ $(MAKE) $(AM_MAKEFLAGS) $<; \ fi +DATA_html_dirs += $(TUTORIAL) -dist_html_DATA += $(TUTORIAL_HTML_OUTPUTS) - -# Intermediate product for the various doc targets of the parent -# directory. +# Intermediate product for the (Doxygen) User Reference Manual. # # This is not a bug: TUTORIAL_HH is meant to have a `.hh' extension, # since it is later parsed by Doxygen, which complains about `.html' # files. -TUTORIAL_HH = $(tutorial_dir)/tutorial.hh -$(TUTORIAL_HH): $(TUTORIAL_HTML) $(srcdir)/tools/todoxygen.sh +TUTORIAL_HH = $(srcdir)/tutorial.hh +$(TUTORIAL_HH): $(srcdir)/$(TUTORIAL).stamp $(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 - $(srcdir)/tools/todoxygen.sh $< $@.tmp $(srcdir) + $(srcdir)/tools/todoxygen.sh \ + $(srcdir)/$(TUTORIAL)/$(TUTORIAL).html $@.tmp $(srcdir) mv -f $@.tmp $@ - - -# Final product. -TUTORIAL_PDF = $(tutorial_dir)/tutorial.pdf -# Extra dependencies. -$(TUTORIAL_PDF): $(tutorial_dependencies) - -dist_pdf_DATA += $(TUTORIAL_PDF) - -EXTRA_DIST += \ - $(tutorial_dir)/tutorial.tex \ - $(TUTORIAL_HH) - +EXTRA_DIST += $(TUTORIAL_HH) MAINTAINERCLEANFILES += $(TUTORIAL_HH) @@ -435,70 +449,58 @@ MAINTAINERCLEANFILES += $(TUTORIAL_HH) ## White Paper. ## ## ------------- ## -white_paper_dir = $(srcdir)/white_paper - -PNGS = \ - $(white_paper_dir)/figures/house.png \ - $(white_paper_dir)/figures/house_rag.png \ - $(white_paper_dir)/figures/house_wshed.png \ - $(white_paper_dir)/figures/house_wshed_mean_colors.png - -EPSS = $(PNGS:png=eps) - -.png.eps: - convert $< $@ - -# Final product. -WHITE_PAPER_HTML = $(white_paper_dir)/white_paper.html -WHITE_PAPER_HTML_OUTPUTS = \ - $(WHITE_PAPER_HTML) \ - $(white_paper_dir)/white_paper.css \ - $(white_paper_dir)/white_paper0x.png \ - $(white_paper_dir)/white_paper1x.png \ - $(white_paper_dir)/white_paper2x.png \ - $(white_paper_dir)/white_paper3x.png - -EXTRA_DIST += $(WHITE_PAPER_HTML).stamp -MAINTAINERCLEANFILES += $(WHITE_PAPER_HTML).stamp -# HTML outputs contains several files (the HTML file itself, its CSS -# style sheet, possibly some images). Therefore, we cannot rely on a -# simple suffix rule to produce them. -$(WHITE_PAPER_HTML).stamp: $(white_paper_dir)/white_paper.tex $(EPSS) +EXTRA_DIST += white-paper.tex graphicx.hva + +WHITE_PAPER_deps = \ + $(WHITE_PAPER_FIGURES) \ + graphicx.hva + +# PDF. +WHITE_PAPER_PDF = $(srcdir)/white-paper.pdf +dist_pdf_DATA += $(WHITE_PAPER_PDF) +$(WHITE_PAPER_PDF): $(WHITE_PAPER_deps) + +# HTML. +WHITE_PAPER = white-paper +all-local: $(srcdir)/$(WHITE_PAPER).stamp + +# The HTML output contains several files (the HTML file itself, its +# CSS style sheet, possibly some images). Therefore, we cannot rely +# on a simple suffix rule to produce them. Instead, put the products +# in a directory and use a time stamp. +$(srcdir)/$(WHITE_PAPER).stamp: $(srcdir)/white-paper.tex $(WHITE_PAPER_deps) @rm -f $@.tmp @touch $@.tmp - $(TEXI2HTML) $(TEXI2HTML_FLAGS) -o $(WHITE_PAPER_HTML) $< + rm -rf $(WHITE_PAPER).tmp + mkdir $(WHITE_PAPER).tmp +## Copy images. + mkdir $(WHITE_PAPER).tmp/figures + cp $(WHITE_PAPER_FIGURES) $(WHITE_PAPER).tmp/figures + $(TEXI2HTML) $(TEXI2HTML_FLAGS) \ + -o $(WHITE_PAPER).tmp/$(WHITE_PAPER).html $< + rm -rf $(srcdir)/$(WHITE_PAPER) +## FIXME: moving directories between file systems is not portable. + mv $(WHITE_PAPER).tmp $(srcdir)/$(WHITE_PAPER) @mv -f $@.tmp $@ +EXTRA_DIST += $(srcdir)/$(WHITE_PAPER).stamp +MAINTAINERCLEANFILES += $(srcdir)/$(WHITE_PAPER).stamp -$(WHITE_PAPER_HTML_OUTPUTS): $(WHITE_PAPER_HTML).stamp -## Recover from the removal of $@ - @if test -f $@; then :; else \ +$(srcdir)/$(WHITE_PAPER): $(srcdir)/$(WHITE_PAPER).stamp +## Recover from the removal of $@. + @if test -d $@; then :; else \ rm -f $<; \ $(MAKE) $(AM_MAKEFLAGS) $<; \ fi - -dist_html_DATA += $(WHITE_PAPER_HTML_OUTPUTS) - -WHITE_PAPER_PDF = $(white_paper_dir)/white_paper.pdf -# Extra dependencies. -$(WHITE_PAPER_PDF): $(PNGS) - -dist_pdf_DATA += $(WHITE_PAPER_PDF) - -EXTRA_DIST += \ - $(white_paper_dir)/white_paper.tex \ - $(PNGS) \ - $(EPSS) - -MAINTAINERCLEANFILES += $(EPSS) +DATA_html_dirs += $(WHITE_PAPER) ## ----------------- ## ## Reference Guide. ## ## ----------------- ## -ref_guide_dir = $(srcdir)/ref_guide +EXTRA_DIST += ref-guide.tex -ref_guide_dependencies = \ +REF_GUIDE_deps = \ $(EXAMPLES) \ $(SPLIT_EXAMPLES) \ $(OUTPUTS) \ @@ -506,61 +508,57 @@ ref_guide_dependencies = \ $(PNG_FIGURES) \ $(DOC_PACKAGES) -# Final product. -REF_GUIDE_HTML = $(ref_guide_dir)/ref_guide.html -REF_GUIDE_HTML_OUTPUTS = \ - $(REF_GUIDE_HTML) \ - $(ref_guide_dir)/ref_guide.css \ - $(ref_guide_dir)/ref_guide0x.png - -EXTRA_DIST += $(REF_GUIDE_HTML).stamp -MAINTAINERCLEANFILES += $(REF_GUIDE_HTML).stamp -# HTML outputs contains several files (the HTML file itself, its CSS -# style sheet, possibly some images). Therefore, we cannot rely on a -# simple suffix rule to produce them. -$(REF_GUIDE_HTML).stamp: $(ref_guide_dir)/ref_guide.tex $(ref_guide_dependencies) +# PDF. +REF_GUIDE_PDF = $(srcdir)/ref-guide.pdf +dist_pdf_DATA += $(REF_GUIDE_PDF) +$(REF_GUIDE_PDF): $(REF_GUIDE_deps) + +# HTML. +REF_GUIDE = ref-guide +all-local: $(srcdir)/$(REF_GUIDE).stamp + +# The HTML output contains several files (the HTML file itself, its +# CSS style sheet, possibly some images). Therefore, we cannot rely +# on a simple suffix rule to produce them. Instead, put the products +# in a directory and use a time stamp. +$(srcdir)/$(REF_GUIDE).stamp: $(srcdir)/ref-guide.tex $(REF_GUIDE_deps) @rm -f $@.tmp @touch $@.tmp - $(TEXI2HTML) $(TEXI2HTML_FLAGS) -o $(REF_GUIDE_HTML) $< + rm -rf $(REF_GUIDE).tmp + mkdir $(REF_GUIDE).tmp + $(TEXI2HTML) $(TEXI2HTML_FLAGS) \ + -o $(REF_GUIDE).tmp/$(REF_GUIDE).html $< + rm -rf $(srcdir)/$(REF_GUIDE) +## FIXME: moving directories between file systems is not portable. + mv $(REF_GUIDE).tmp $(srcdir)/$(REF_GUIDE) @mv -f $@.tmp $@ +EXTRA_DIST += $(srcdir)/$(REF_GUIDE).stamp +MAINTAINERCLEANFILES += $(srcdir)/$(REF_GUIDE).stamp -$(REF_GUIDE_HTML_OUTPUTS): $(REF_GUIDE_HTML).stamp -## Recover from the removal of $@ - @if test -f $@; then :; else \ +$(srcdir)/$(REF_GUIDE): $(srcdir)/$(REF_GUIDE).stamp +## Recover from the removal of $@. + @if test -d $@; then :; else \ rm -f $<; \ $(MAKE) $(AM_MAKEFLAGS) $<; \ fi +DATA_html_dirs += $(REF_GUIDE) -dist_html_DATA += $(REF_GUIDE_HTML_OUTPUTS) - -# Intermediate product for the various doc targets of the parent -# directory. +# Intermediate product for the (Doxygen) User Reference Manual. # # This is not a bug: REF_GUIDE_HH is meant to have a `.hh' extension, # 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) $(srcdir)/tools/todoxygen.sh +REF_GUIDE_HH = $(srcdir)/ref-guide.hh +$(REF_GUIDE_HH): $(srcdir)/$(REF_GUIDE).stamp $(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 - $(srcdir)/tools/todoxygen.sh $< $@.tmp $(srcdir) + $(srcdir)/tools/todoxygen.sh \ + $(srcdir)/$(REF_GUIDE)/$(REF_GUIDE).html $@.tmp $(srcdir) mv -f $@.tmp $@ - - -# Final product. -REF_GUIDE_PDF = $(ref_guide_dir)/ref_guide.pdf -# Extra dependencies. -$(REF_GUIDE_PDF): $(ref_guide_dependencies) - -dist_pdf_DATA += $(REF_GUIDE_PDF) - -EXTRA_DIST += \ - $(ref_guide_dir)/ref_guide.tex \ - $(REF_GUIDE_HH) - +EXTRA_DIST += $(REF_GUIDE_HH) MAINTAINERCLEANFILES += $(REF_GUIDE_HH) @@ -720,6 +718,7 @@ MAINTAINERCLEANFILES += $(dist_html_DATA) $(dist_pdf_DATA) EXTRA_DIST += \ + $(DATA_html_dirs) \ $(DOXYFILE).in \ groups/accu.hh \ groups/graph.hh \ diff --git a/milena/doc/white_paper/figures/house.png b/milena/doc/figures/house.png similarity index 100% rename from milena/doc/white_paper/figures/house.png rename to milena/doc/figures/house.png diff --git a/milena/doc/white_paper/figures/house_rag.png b/milena/doc/figures/house_rag.png similarity index 100% rename from milena/doc/white_paper/figures/house_rag.png rename to milena/doc/figures/house_rag.png diff --git a/milena/doc/white_paper/figures/house_wshed.png b/milena/doc/figures/house_wshed.png similarity index 100% rename from milena/doc/white_paper/figures/house_wshed.png rename to milena/doc/figures/house_wshed.png diff --git a/milena/doc/white_paper/figures/house_wshed_mean_colors.png b/milena/doc/figures/house_wshed_mean_colors.png similarity index 100% rename from milena/doc/white_paper/figures/house_wshed_mean_colors.png rename to milena/doc/figures/house_wshed_mean_colors.png diff --git a/milena/doc/technical/figures/file_layout.pdf b/milena/doc/figures/technical/file_layout.pdf similarity index 100% rename from milena/doc/technical/figures/file_layout.pdf rename to milena/doc/figures/technical/file_layout.pdf diff --git a/milena/doc/technical/figures/file_layout.png b/milena/doc/figures/technical/file_layout.png similarity index 100% rename from milena/doc/technical/figures/file_layout.png rename to milena/doc/figures/technical/file_layout.png diff --git a/milena/doc/graphicx.hva b/milena/doc/graphicx.hva new file mode 100644 index 0000000..ff95ca7 --- /dev/null +++ b/milena/doc/graphicx.hva @@ -0,0 +1,3 @@ + % -*- LaTeX -*- + +\newcommand{\includegraphics}[2][]{\imgsrc{#2.png}} diff --git a/milena/doc/ref_guide/ref_guide.tex b/milena/doc/ref-guide.tex similarity index 100% rename from milena/doc/ref_guide/ref_guide.tex rename to milena/doc/ref-guide.tex diff --git a/milena/doc/technical/designs/properties/values.txt b/milena/doc/technical.old/designs/properties/values.txt similarity index 100% rename from milena/doc/technical/designs/properties/values.txt rename to milena/doc/technical.old/designs/properties/values.txt diff --git a/milena/doc/technical/designs/site_psite_piter/README b/milena/doc/technical.old/designs/site_psite_piter/README similarity index 100% rename from milena/doc/technical/designs/site_psite_piter/README rename to milena/doc/technical.old/designs/site_psite_piter/README diff --git a/milena/doc/technical/technical.tex b/milena/doc/technical.tex similarity index 96% rename from milena/doc/technical/technical.tex rename to milena/doc/technical.tex index 198bcd6..4afc908 100644 --- a/milena/doc/technical/technical.tex +++ b/milena/doc/technical.tex @@ -131,15 +131,15 @@ reference documents available here: Writing a new routine in Milena requires a specific layout in the -code. This layout is described in figure \ref{figures/file_layout}. +code. This layout is described in figure \ref{figures/technical/file_layout}. \begin{center} - \doxyimg{figures/file_layout}{8cm} + \doxyimg{figures/technical/file_layout}{8cm} \end{center} For a better understanding, we are going to comment this figure -(fig. \ref{figures/file_layout}) from the bottom to the top. +(fig. \ref{figures/technical/file_layout}) from the bottom to the top. \begin{itemize} \item \textbf{Facade}. The facade is the public routine that will be diff --git a/milena/doc/tutorial/design/Makefile b/milena/doc/tutorial.old/design/Makefile similarity index 100% rename from milena/doc/tutorial/design/Makefile rename to milena/doc/tutorial.old/design/Makefile diff --git a/milena/doc/tutorial/design/design.tex b/milena/doc/tutorial.old/design/design.tex similarity index 100% rename from milena/doc/tutorial/design/design.tex rename to milena/doc/tutorial.old/design/design.tex diff --git a/milena/doc/tutorial/design/include/imagetours.tex b/milena/doc/tutorial.old/design/include/imagetours.tex similarity index 100% rename from milena/doc/tutorial/design/include/imagetours.tex rename to milena/doc/tutorial.old/design/include/imagetours.tex diff --git a/milena/doc/tutorial/design/include/properties.tex b/milena/doc/tutorial.old/design/include/properties.tex similarity index 100% rename from milena/doc/tutorial/design/include/properties.tex rename to milena/doc/tutorial.old/design/include/properties.tex diff --git a/milena/doc/tutorial/doxyfile_tuto.local b/milena/doc/tutorial.old/doxyfile_tuto.local similarity index 100% rename from milena/doc/tutorial/doxyfile_tuto.local rename to milena/doc/tutorial.old/doxyfile_tuto.local diff --git a/milena/doc/tutorial/image_types.txt b/milena/doc/tutorial.old/image_types.txt similarity index 100% rename from milena/doc/tutorial/image_types.txt rename to milena/doc/tutorial.old/image_types.txt diff --git a/milena/doc/tutorial/image_values.txt b/milena/doc/tutorial.old/image_values.txt similarity index 100% rename from milena/doc/tutorial/image_values.txt rename to milena/doc/tutorial.old/image_values.txt diff --git a/milena/doc/tutorial/images_tour.txt b/milena/doc/tutorial.old/images_tour.txt similarity index 100% rename from milena/doc/tutorial/images_tour.txt rename to milena/doc/tutorial.old/images_tour.txt diff --git a/milena/doc/tutorial/slides.tex b/milena/doc/tutorial.old/slides.tex similarity index 100% rename from milena/doc/tutorial/slides.tex rename to milena/doc/tutorial.old/slides.tex diff --git a/milena/doc/tutorial/tutorial.tex b/milena/doc/tutorial.tex similarity index 100% rename from milena/doc/tutorial/tutorial.tex rename to milena/doc/tutorial.tex diff --git a/milena/doc/tutorial/headers.stamp b/milena/doc/tutorial/headers.stamp deleted file mode 100644 index e69de29..0000000 diff --git a/milena/doc/white_paper/white_paper.tex b/milena/doc/white-paper.tex similarity index 100% rename from milena/doc/white_paper/white_paper.tex rename to milena/doc/white-paper.tex -- 1.5.6.5

14 years, 1 month

last-svn-commit-110-gc503028 Move LaTeX sources at the root of doc/; generate HTML in subdirs.

by Roland Levillain

* doc/tutorial/tutorial.tex, * doc/technical/technical.tex, * doc/ref_guide/ref_guide.tex, * doc/white_paper/white_paper.tex: Move... * doc/tutorial.tex, * doc/technical.tex, * doc/ref-guide.tex, * doc/white-paper.tex: ...here. * doc/graphicx.hva: New. * doc/technical/figures/file_layout.pdf, * doc/technical/figures/file_layout.png, * doc/white_paper/figures/house.png, * doc/white_paper/figures/house_rag.png, * doc/white_paper/figures/house_wshed.png, * doc/white_paper/figures/house_wshed_mean_colors.png: Move... * doc/figures/technical/file_layout.pdf, * doc/figures/technical/file_layout.png, * doc/figures/house.png, * doc/figures/house_rag.png, * doc/figures/house_wshed.png, * doc/figures/house_wshed_mean_colors.png: ...here. * doc/technical.tex: Adjust paths. * doc/technical/designs/, * doc/tutorial/designs/, * doc/tutorial/doxyfile_tuto.local, * doc/tutorial/image_types.txt, * doc/tutorial/image_values.txt, * doc/tutorial/images_tour.txt, * doc/tutorial/slides.tex: Rename as... * doc/technical.old/designs/, * doc/tutorial.old/design/, * doc/tutorial.old/doxyfile_tuto.local, * doc/tutorial.old/image_types.txt, * doc/tutorial.old/image_values.txt, * doc/tutorial.old/images_tour.txt, * doc/tutorial.old/slides.tex: ...this. * tutorial/headers.stamp: Remove. * doc/Makefile.am (REFMAN_deps): Rename as... (refman_dependencies): ...this. Adjust paths. ($(srcdir)/user-refman.stamp, $(srcdir)/devel-refman.stamp): Adjust. (PNGS, EPSS): Remove. (.png.eps): Remove rule. (TECHNICAL_FIGURES, WHITE_PAPER_FIGURES): New. (MORE_FIGURES): Add $(TECHNICAL_FIGURES) and $(WHITE_PAPER_FIGURES). (technical_dir, tutorial_dir, white_paper_dir, ref_guide_dir): Remove. (TECHNICAL, TUTORIAL, WHITE_PAPER, REF_GUIDE): New. (TECHNICAL_PDF, TUTORIAL_PDF, WHITE_PAPER_PDF, REF_GUIDE_PDF) (TUTORIAL_HH, REF_GUIDE_HH) (EXTRA_DIST, MAINTAINERCLEANFILES): Adjust. Remove (EPSS). (EXTRA_DIST): Remove $(PNGS). Add graphicx.hva. (technical_dependencies) (tutorial_dependencies) (ref_guide_dependencies): Rename as... (TECHNICAL_deps) (TUTORIAL_deps) (REF_GUIDE_deps): ...this. (TECHNICAL_deps): Add $(TECHNICAL_FIGURES). (WHITE_PAPER_deps): New. ($(TECHNICAL_PDF)) ($(TUTORIAL_PDF)) ($(WHITE_PAPER_PDF)) ($(REF_GUIDE_PDF)): Adjust. (TECHNICAL_HTML, TECHNICAL_HTML_OUTPUTS) (TUTORIAL_HTML, TUTORIAL_HTML_OUTPUTS) (WHITE_PAPER_HTML, WHITE_PAPER_HTML_OUTPUTS) (REF_GUIDE_HTML, REF_GUIDE_HTML_OUTPUTS): Remove. (all-local): Depend on $(srcdir)/$(TECHNICAL).stamp, $(srcdir)/$(TUTORIAL).stamp, $(srcdir)/$(WHITE_PAPER).stamp and $(srcdir)/$(REF_GUIDE).stamp. ($(TECHNICAL_HTML).stamp) ($(TUTORIAL_HTML).stamp) ($(WHITE_PAPER_HTML).stamp) ($(REF_GUIDE_HTML).stamp): Turn targets into... ($(srcdir)/$(TECHNICAL).stamp) ($(srcdir)/$(TUTORIAL).stamp) ($(srcdir)/$(WHITE_PAPER).stamp) ($(srcdir)/$(REF_GUIDE).stamp): ...this. Adjust rules to generate outputs in a subdirectory. ($(TECHNICAL_HTML_OUTPUTS)) ($(TUTORIAL_HTML_OUTPUTS)) ($(WHITE_PAPER_HTML_OUTPUTS)) ($(REF_GUIDE_HTML_OUTPUTS)): Turn targets into... ($(srcdir)/$(TECHNICAL)) ($(srcdir)/$(TUTORIAL)) ($(srcdir)/$(WHITE_PAPER)) ($(srcdir)/$(REF_GUIDE)): ...this. Adjust. ($(TUTORIAL_HH)): Depend on $(srcdir)/$(TUTORIAL).stamp. Adjust rule. ($(REF_GUIDE_HH)): Depend on (srcdir)/$(REF_GUIDE).stamp. Adjust rule. (dist_html_DATA): Remove. (DATA_html_dirs): New. (EXTRA_DIST): Add $(DATA_html_dirs). --- milena/ChangeLog | 121 ++++++++ milena/doc/.gitignore | 33 +-- milena/doc/Makefile.am | 309 ++++++++++---------- milena/doc/{white_paper => }/figures/house.png | Bin 26653 -> 26653 bytes milena/doc/{white_paper => }/figures/house_rag.png | Bin 9454 -> 9454 bytes .../doc/{white_paper => }/figures/house_wshed.png | Bin 27668 -> 27668 bytes .../figures/house_wshed_mean_colors.png | Bin 6618 -> 6618 bytes .../figures => figures/technical}/file_layout.pdf | Bin 26680 -> 26680 bytes .../figures => figures/technical}/file_layout.png | Bin 117801 -> 117801 bytes milena/doc/graphicx.hva | 3 + .../doc/{ref_guide/ref_guide.tex => ref-guide.tex} | 0 .../designs/properties/values.txt | 0 .../designs/site_psite_piter/README | 0 milena/doc/{technical => }/technical.tex | 6 +- .../doc/{tutorial => tutorial.old}/design/Makefile | 0 .../{tutorial => tutorial.old}/design/design.tex | 0 .../design/include/imagetours.tex | 0 .../design/include/properties.tex | 0 .../{tutorial => tutorial.old}/doxyfile_tuto.local | 0 .../doc/{tutorial => tutorial.old}/image_types.txt | 0 .../{tutorial => tutorial.old}/image_values.txt | 0 .../doc/{tutorial => tutorial.old}/images_tour.txt | 0 milena/doc/{tutorial => tutorial.old}/slides.tex | 0 milena/doc/{tutorial => }/tutorial.tex | 0 .../white_paper.tex => white-paper.tex} | 0 25 files changed, 291 insertions(+), 181 deletions(-) rename milena/doc/{white_paper => }/figures/house.png (100%) rename milena/doc/{white_paper => }/figures/house_rag.png (100%) rename milena/doc/{white_paper => }/figures/house_wshed.png (100%) rename milena/doc/{white_paper => }/figures/house_wshed_mean_colors.png (100%) rename milena/doc/{technical/figures => figures/technical}/file_layout.pdf (100%) rename milena/doc/{technical/figures => figures/technical}/file_layout.png (100%) create mode 100644 milena/doc/graphicx.hva rename milena/doc/{ref_guide/ref_guide.tex => ref-guide.tex} (100%) rename milena/doc/{technical => technical.old}/designs/properties/values.txt (100%) rename milena/doc/{technical => technical.old}/designs/site_psite_piter/README (100%) rename milena/doc/{technical => }/technical.tex (96%) rename milena/doc/{tutorial => tutorial.old}/design/Makefile (100%) rename milena/doc/{tutorial => tutorial.old}/design/design.tex (100%) rename milena/doc/{tutorial => tutorial.old}/design/include/imagetours.tex (100%) rename milena/doc/{tutorial => tutorial.old}/design/include/properties.tex (100%) rename milena/doc/{tutorial => tutorial.old}/doxyfile_tuto.local (100%) rename milena/doc/{tutorial => tutorial.old}/image_types.txt (100%) rename milena/doc/{tutorial => tutorial.old}/image_values.txt (100%) rename milena/doc/{tutorial => tutorial.old}/images_tour.txt (100%) rename milena/doc/{tutorial => tutorial.old}/slides.tex (100%) rename milena/doc/{tutorial => }/tutorial.tex (100%) delete mode 100644 milena/doc/tutorial/headers.stamp rename milena/doc/{white_paper/white_paper.tex => white-paper.tex} (100%) diff --git a/milena/ChangeLog b/milena/ChangeLog index 3d0cd69..0f53ae2 100644 --- a/milena/ChangeLog +++ b/milena/ChangeLog @@ -1,3 +1,124 @@ +2010-03-30 Roland Levillain <roland(a)lrde.epita.fr> + + Move LaTeX sources at the root of doc/; generate HTML in subdirs. + + * doc/tutorial/tutorial.tex, + * doc/technical/technical.tex, + * doc/ref_guide/ref_guide.tex, + * doc/white_paper/white_paper.tex: + Move... + * doc/tutorial.tex, + * doc/technical.tex, + * doc/ref-guide.tex, + * doc/white-paper.tex: + ...here. + * doc/graphicx.hva: New. + * doc/technical/figures/file_layout.pdf, + * doc/technical/figures/file_layout.png, + * doc/white_paper/figures/house.png, + * doc/white_paper/figures/house_rag.png, + * doc/white_paper/figures/house_wshed.png, + * doc/white_paper/figures/house_wshed_mean_colors.png: + Move... + * doc/figures/technical/file_layout.pdf, + * doc/figures/technical/file_layout.png, + * doc/figures/house.png, + * doc/figures/house_rag.png, + * doc/figures/house_wshed.png, + * doc/figures/house_wshed_mean_colors.png: + ...here. + * doc/technical.tex: Adjust paths. + * doc/technical/designs/, + * doc/tutorial/designs/, + * doc/tutorial/doxyfile_tuto.local, + * doc/tutorial/image_types.txt, + * doc/tutorial/image_values.txt, + * doc/tutorial/images_tour.txt, + * doc/tutorial/slides.tex: + Rename as... + * doc/technical.old/designs/, + * doc/tutorial.old/design/, + * doc/tutorial.old/doxyfile_tuto.local, + * doc/tutorial.old/image_types.txt, + * doc/tutorial.old/image_values.txt, + * doc/tutorial.old/images_tour.txt, + * doc/tutorial.old/slides.tex: + ...this. + * tutorial/headers.stamp: Remove. + * doc/Makefile.am (REFMAN_deps): Rename as... + (refman_dependencies): ...this. + Adjust paths. + ($(srcdir)/user-refman.stamp, $(srcdir)/devel-refman.stamp): + Adjust. + (PNGS, EPSS): Remove. + (.png.eps): Remove rule. + (TECHNICAL_FIGURES, WHITE_PAPER_FIGURES): New. + (MORE_FIGURES): Add $(TECHNICAL_FIGURES) and + $(WHITE_PAPER_FIGURES). + (technical_dir, tutorial_dir, white_paper_dir, ref_guide_dir): + Remove. + (TECHNICAL, TUTORIAL, WHITE_PAPER, REF_GUIDE): New. + (TECHNICAL_PDF, TUTORIAL_PDF, WHITE_PAPER_PDF, REF_GUIDE_PDF) + (TUTORIAL_HH, REF_GUIDE_HH) + (EXTRA_DIST, MAINTAINERCLEANFILES): Adjust. + Remove (EPSS). + (EXTRA_DIST): Remove $(PNGS). + Add graphicx.hva. + (technical_dependencies) + (tutorial_dependencies) + (ref_guide_dependencies): + Rename as... + (TECHNICAL_deps) + (TUTORIAL_deps) + (REF_GUIDE_deps): + ...this. + (TECHNICAL_deps): Add $(TECHNICAL_FIGURES). + (WHITE_PAPER_deps): New. + ($(TECHNICAL_PDF)) + ($(TUTORIAL_PDF)) + ($(WHITE_PAPER_PDF)) + ($(REF_GUIDE_PDF)): + Adjust. + (TECHNICAL_HTML, TECHNICAL_HTML_OUTPUTS) + (TUTORIAL_HTML, TUTORIAL_HTML_OUTPUTS) + (WHITE_PAPER_HTML, WHITE_PAPER_HTML_OUTPUTS) + (REF_GUIDE_HTML, REF_GUIDE_HTML_OUTPUTS): + Remove. + (all-local): Depend on + $(srcdir)/$(TECHNICAL).stamp, + $(srcdir)/$(TUTORIAL).stamp, + $(srcdir)/$(WHITE_PAPER).stamp and + $(srcdir)/$(REF_GUIDE).stamp. + ($(TECHNICAL_HTML).stamp) + ($(TUTORIAL_HTML).stamp) + ($(WHITE_PAPER_HTML).stamp) + ($(REF_GUIDE_HTML).stamp): + Turn targets into... + ($(srcdir)/$(TECHNICAL).stamp) + ($(srcdir)/$(TUTORIAL).stamp) + ($(srcdir)/$(WHITE_PAPER).stamp) + ($(srcdir)/$(REF_GUIDE).stamp): + ...this. + Adjust rules to generate outputs in a subdirectory. + ($(TECHNICAL_HTML_OUTPUTS)) + ($(TUTORIAL_HTML_OUTPUTS)) + ($(WHITE_PAPER_HTML_OUTPUTS)) + ($(REF_GUIDE_HTML_OUTPUTS)): + Turn targets into... + ($(srcdir)/$(TECHNICAL)) + ($(srcdir)/$(TUTORIAL)) + ($(srcdir)/$(WHITE_PAPER)) + ($(srcdir)/$(REF_GUIDE)): + ...this. + Adjust. + ($(TUTORIAL_HH)): Depend on $(srcdir)/$(TUTORIAL).stamp. + Adjust rule. + ($(REF_GUIDE_HH)): Depend on (srcdir)/$(REF_GUIDE).stamp. + Adjust rule. + (dist_html_DATA): Remove. + (DATA_html_dirs): New. + (EXTRA_DIST): Add $(DATA_html_dirs). + 2010-03-26 Roland Levillain <roland(a)lrde.epita.fr> No longer generate doc/technical/technical.hh. diff --git a/milena/doc/.gitignore b/milena/doc/.gitignore index 506bfa4..3c88ad7 100644 --- a/milena/doc/.gitignore +++ b/milena/doc/.gitignore @@ -8,29 +8,16 @@ /figures/*.png -/ref_guide/ref_guide.css -/ref_guide/ref_guide.hh -/ref_guide/ref_guide.html -/ref_guide/ref_guide.pdf -/ref_guide/ref_guide0x.png +/ref-guide.hh +/ref-guide.pdf +/ref-guide/ -/technical/technical.css -/technical/technical.html -/technical/technical.pdf +/technical.pdf +/technical/ -/tutorial/tutorial.css -/tutorial/tutorial.hh -/tutorial/tutorial.html -/tutorial/tutorial.pdf +/tutorial.hh +/tutorial.pdf +/tutorial/ -/white_paper/figures/house.eps -/white_paper/figures/house_rag.eps -/white_paper/figures/house_wshed.eps -/white_paper/figures/house_wshed_mean_colors.eps -/white_paper/white_paper.css -/white_paper/white_paper.html -/white_paper/white_paper.pdf -/white_paper/white_paper0x.png -/white_paper/white_paper1x.png -/white_paper/white_paper2x.png -/white_paper/white_paper3x.png +/white-paper.pdf +/white-paper/ diff --git a/milena/doc/Makefile.am b/milena/doc/Makefile.am index 25116c1..dcdca5a 100644 --- a/milena/doc/Makefile.am +++ b/milena/doc/Makefile.am @@ -95,8 +95,21 @@ MAINTAINERCLEANFILES += $(PNG_FIGURES) # Other figures. # # --------------- # +TECHNICAL_FIGURES = \ + figures/technical/file_layout.pdf \ + figures/technical/file_layout.png +MORE_FIGURES = $(TECHNICAL_FIGURES) + +WHITE_PAPER_FIGURES = \ + $(srcdir)/figures/house.png \ + $(srcdir)/figures/house_rag.png \ + $(srcdir)/figures/house_wshed.png \ + $(srcdir)/figures/house_wshed_mean_colors.png +MORE_FIGURES += $(WHITE_PAPER_FIGURES) + # This image seems to be used nowhere. -MORE_FIGURES = figures/accu_image_morpher_big_picture.pdf +MORE_FIGURES += figures/accu_image_morpher_big_picture.pdf + EXTRA_DIST += $(MORE_FIGURES) @@ -172,10 +185,10 @@ regen-split-examples-mk: ## Doxygen documentation. ## ## ----------------------- ## -refman_dependencies = \ +REFMAN_deps = \ $(PNG_FIGURES) \ - $(srcdir)/tutorial/tutorial.hh \ - $(srcdir)/ref_guide/ref_guide.hh + $(srcdir)/tutorial.hh \ + $(srcdir)/ref-guide.hh # ----------------------- # # User reference manual. # @@ -220,7 +233,7 @@ $(srcdir)/$(USER_REFMAN_PDF): $(srcdir)/$(USER_REFMAN) EXTRA_DIST += $(srcdir)/user-refman.stamp MAINTAINERCLEANFILES += $(srcdir)/user-refman.stamp -$(srcdir)/user-refman.stamp: $(srcdir)/$(DOXYFILE).in $(refman_dependencies) +$(srcdir)/user-refman.stamp: $(srcdir)/$(DOXYFILE).in $(REFMAN_deps) @rm -f $@.tmp @touch $@.tmp -rm -rf $(USER_REFMAN).tmp @@ -289,7 +302,7 @@ $(srcdir)/$(DEVEL_REFMAN_PDF): $(srcdir)/$(DEVEL_REFMAN) cp -f $(srcdir)/$(DEVEL_REFMAN)/latex/refman.pdf $@ MAINTAINERCLEANFILES += $(srcdir)/devel-refman.stamp -$(srcdir)/devel-refman.stamp: $(srcdir)/$(DOXYFILE).in $(refman_dependencies) +$(srcdir)/devel-refman.stamp: $(srcdir)/$(DOXYFILE).in $(REFMAN_deps) @rm -f $@.tmp @touch $@.tmp -rm -rf $(DEVEL_REFMAN).tmp @@ -318,57 +331,59 @@ maintainer-clean-local: ## ------------------------- ## -## Technical Documentation. ## +## Technical documentation. ## ## ------------------------- ## -technical_dir = $(srcdir)/technical +EXTRA_DIST += technical.tex -technical_dependencies = \ +TECHNICAL_deps = \ + $(TECHNICAL_FIGURES) \ $(TECHNICAL_EXAMPLES) \ $(PNG_FIGURES) \ $(DOC_PACKAGES) -# Final product. -TECHNICAL_HTML = $(technical_dir)/technical.html -TECHNICAL_HTML_OUTPUTS = $(TECHNICAL_HTML) $(technical_dir)/technical.css +# PDF. +TECHNICAL_PDF = $(srcdir)/technical.pdf +dist_pdf_DATA += $(TECHNICAL_PDF) +$(TECHNICAL_PDF): $(TECHNICAL_deps) -EXTRA_DIST += $(TECHNICAL_HTML).stamp -MAINTAINERCLEANFILES += $(TECHNICAL_HTML).stamp -# HTML outputs contains several files (the HTML file itself, its CSS -# style sheet, possibly some images). Therefore, we cannot rely on a -# simple suffix rule to produce them. -$(TECHNICAL_HTML).stamp: $(technical_dir)/technical.tex $(technical_dependencies) +# HTML. +TECHNICAL = technical +all-local: $(srcdir)/$(TECHNICAL).stamp +# The HTML output contains several files (the HTML file itself, its +# CSS style sheet, possibly some images). Therefore, we cannot rely +# on a simple suffix rule to produce them. Instead, put the products +# in a directory and use a time stamp. +$(srcdir)/$(TECHNICAL).stamp: $(srcdir)/technical.tex $(TECHNICAL_deps) @rm -f $@.tmp @touch $@.tmp - $(TEXI2HTML) $(TEXI2HTML_FLAGS) -o $(TECHNICAL_HTML) $< + rm -rf $(TECHNICAL).tmp + mkdir $(TECHNICAL).tmp + $(TEXI2HTML) $(TEXI2HTML_FLAGS) \ + -o $(TECHNICAL).tmp/$(TECHNICAL).html $< + rm -rf $(srcdir)/$(TECHNICAL) +## FIXME: moving directories between file systems is not portable. + mv $(TECHNICAL).tmp $(srcdir)/$(TECHNICAL) @mv -f $@.tmp $@ +EXTRA_DIST += $(srcdir)/$(TECHNICAL).stamp +MAINTAINERCLEANFILES += $(srcdir)/$(TECHNICAL).stamp -$(TECHNICAL_HTML_OUTPUTS): $(TECHNICAL_HTML).stamp -## Recover from the removal of $@ - @if test -f $@; then :; else \ +$(srcdir)/$(TECHNICAL): $(srcdir)/$(TECHNICAL).stamp +## Recover from the removal of $@. + @if test -d $@; then :; else \ rm -f $<; \ $(MAKE) $(AM_MAKEFLAGS) $<; \ fi - -dist_html_DATA = $(TECHNICAL_HTML_OUTPUTS) - -# Final product. -TECHNICAL_PDF = $(technical_dir)/technical.pdf -# Extra dependencies. -$(TECHNICAL_PDF): $(technical_dependencies) - -dist_pdf_DATA = $(TECHNICAL_PDF) - -EXTRA_DIST += $(technical_dir)/technical.tex +DATA_html_dirs = $(TECHNICAL) ## ---------- ## ## Tutorial. ## ## ---------- ## -tutorial_dir = $(srcdir)/tutorial +EXTRA_DIST += tutorial.tex -tutorial_dependencies = \ +TUTORIAL_deps = \ $(EXAMPLES) \ $(SPLIT_EXAMPLES) \ $(OUTPUTS) \ @@ -376,58 +391,57 @@ tutorial_dependencies = \ $(PNG_FIGURES) \ $(DOC_PACKAGES) -# Final product. -TUTORIAL_HTML = $(tutorial_dir)/tutorial.html -TUTORIAL_HTML_OUTPUTS = $(TUTORIAL_HTML) $(tutorial_dir)/tutorial.css +# PDF. +TUTORIAL_PDF = $(srcdir)/tutorial.pdf +dist_pdf_DATA += $(TUTORIAL_PDF) +$(TUTORIAL_PDF): $(TUTORIAL_deps) -EXTRA_DIST += $(TUTORIAL_HTML).stamp -MAINTAINERCLEANFILES += $(TUTORIAL_HTML).stamp -# HTML outputs contains several files (the HTML file itself, its CSS -# style sheet, possibly some images). Therefore, we cannot rely on a -# simple suffix rule to produce them. -$(TUTORIAL_HTML).stamp: $(tutorial_dir)/tutorial.tex $(tutorial_dependencies) +# HTML. +TUTORIAL = tutorial +all-local: $(srcdir)/$(TUTORIAL).stamp + +# The HTML output contains several files (the HTML file itself, its +# CSS style sheet, possibly some images). Therefore, we cannot rely +# on a simple suffix rule to produce them. Instead, put the products +# in a directory and use a time stamp. +$(srcdir)/$(TUTORIAL).stamp: $(srcdir)/tutorial.tex $(TUTORIAL_deps) @rm -f $@.tmp @touch $@.tmp - $(TEXI2HTML) $(TEXI2HTML_FLAGS) -o $(TUTORIAL_HTML) $< + rm -rf $(TUTORIAL).tmp + mkdir $(TUTORIAL).tmp + $(TEXI2HTML) $(TEXI2HTML_FLAGS) \ + -o $(TUTORIAL).tmp/$(TUTORIAL).html $< + rm -rf $(srcdir)/$(TUTORIAL) +## FIXME: moving directories between file systems is not portable. + mv $(TUTORIAL).tmp $(srcdir)/$(TUTORIAL) @mv -f $@.tmp $@ +EXTRA_DIST += $(srcdir)/$(TUTORIAL).stamp +MAINTAINERCLEANFILES += $(srcdir)/$(TUTORIAL).stamp -$(TUTORIAL_HTML_OUTPUTS): $(TUTORIAL_HTML).stamp -## Recover from the removal of $@ - @if test -f $@; then :; else \ +$(srcdir)/$(TUTORIAL): $(srcdir)/$(TUTORIAL).stamp +## Recover from the removal of $@. + @if test -d $@; then :; else \ rm -f $<; \ $(MAKE) $(AM_MAKEFLAGS) $<; \ fi +DATA_html_dirs += $(TUTORIAL) -dist_html_DATA += $(TUTORIAL_HTML_OUTPUTS) - -# Intermediate product for the various doc targets of the parent -# directory. +# Intermediate product for the (Doxygen) User Reference Manual. # # This is not a bug: TUTORIAL_HH is meant to have a `.hh' extension, # since it is later parsed by Doxygen, which complains about `.html' # files. -TUTORIAL_HH = $(tutorial_dir)/tutorial.hh -$(TUTORIAL_HH): $(TUTORIAL_HTML) $(srcdir)/tools/todoxygen.sh +TUTORIAL_HH = $(srcdir)/tutorial.hh +$(TUTORIAL_HH): $(srcdir)/$(TUTORIAL).stamp $(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 - $(srcdir)/tools/todoxygen.sh $< $@.tmp $(srcdir) + $(srcdir)/tools/todoxygen.sh \ + $(srcdir)/$(TUTORIAL)/$(TUTORIAL).html $@.tmp $(srcdir) mv -f $@.tmp $@ - - -# Final product. -TUTORIAL_PDF = $(tutorial_dir)/tutorial.pdf -# Extra dependencies. -$(TUTORIAL_PDF): $(tutorial_dependencies) - -dist_pdf_DATA += $(TUTORIAL_PDF) - -EXTRA_DIST += \ - $(tutorial_dir)/tutorial.tex \ - $(TUTORIAL_HH) - +EXTRA_DIST += $(TUTORIAL_HH) MAINTAINERCLEANFILES += $(TUTORIAL_HH) @@ -435,70 +449,58 @@ MAINTAINERCLEANFILES += $(TUTORIAL_HH) ## White Paper. ## ## ------------- ## -white_paper_dir = $(srcdir)/white_paper - -PNGS = \ - $(white_paper_dir)/figures/house.png \ - $(white_paper_dir)/figures/house_rag.png \ - $(white_paper_dir)/figures/house_wshed.png \ - $(white_paper_dir)/figures/house_wshed_mean_colors.png - -EPSS = $(PNGS:png=eps) - -.png.eps: - convert $< $@ - -# Final product. -WHITE_PAPER_HTML = $(white_paper_dir)/white_paper.html -WHITE_PAPER_HTML_OUTPUTS = \ - $(WHITE_PAPER_HTML) \ - $(white_paper_dir)/white_paper.css \ - $(white_paper_dir)/white_paper0x.png \ - $(white_paper_dir)/white_paper1x.png \ - $(white_paper_dir)/white_paper2x.png \ - $(white_paper_dir)/white_paper3x.png - -EXTRA_DIST += $(WHITE_PAPER_HTML).stamp -MAINTAINERCLEANFILES += $(WHITE_PAPER_HTML).stamp -# HTML outputs contains several files (the HTML file itself, its CSS -# style sheet, possibly some images). Therefore, we cannot rely on a -# simple suffix rule to produce them. -$(WHITE_PAPER_HTML).stamp: $(white_paper_dir)/white_paper.tex $(EPSS) +EXTRA_DIST += white-paper.tex graphicx.hva + +WHITE_PAPER_deps = \ + $(WHITE_PAPER_FIGURES) \ + graphicx.hva + +# PDF. +WHITE_PAPER_PDF = $(srcdir)/white-paper.pdf +dist_pdf_DATA += $(WHITE_PAPER_PDF) +$(WHITE_PAPER_PDF): $(WHITE_PAPER_deps) + +# HTML. +WHITE_PAPER = white-paper +all-local: $(srcdir)/$(WHITE_PAPER).stamp + +# The HTML output contains several files (the HTML file itself, its +# CSS style sheet, possibly some images). Therefore, we cannot rely +# on a simple suffix rule to produce them. Instead, put the products +# in a directory and use a time stamp. +$(srcdir)/$(WHITE_PAPER).stamp: $(srcdir)/white-paper.tex $(WHITE_PAPER_deps) @rm -f $@.tmp @touch $@.tmp - $(TEXI2HTML) $(TEXI2HTML_FLAGS) -o $(WHITE_PAPER_HTML) $< + rm -rf $(WHITE_PAPER).tmp + mkdir $(WHITE_PAPER).tmp +## Copy images. + mkdir $(WHITE_PAPER).tmp/figures + cp $(WHITE_PAPER_FIGURES) $(WHITE_PAPER).tmp/figures + $(TEXI2HTML) $(TEXI2HTML_FLAGS) \ + -o $(WHITE_PAPER).tmp/$(WHITE_PAPER).html $< + rm -rf $(srcdir)/$(WHITE_PAPER) +## FIXME: moving directories between file systems is not portable. + mv $(WHITE_PAPER).tmp $(srcdir)/$(WHITE_PAPER) @mv -f $@.tmp $@ +EXTRA_DIST += $(srcdir)/$(WHITE_PAPER).stamp +MAINTAINERCLEANFILES += $(srcdir)/$(WHITE_PAPER).stamp -$(WHITE_PAPER_HTML_OUTPUTS): $(WHITE_PAPER_HTML).stamp -## Recover from the removal of $@ - @if test -f $@; then :; else \ +$(srcdir)/$(WHITE_PAPER): $(srcdir)/$(WHITE_PAPER).stamp +## Recover from the removal of $@. + @if test -d $@; then :; else \ rm -f $<; \ $(MAKE) $(AM_MAKEFLAGS) $<; \ fi - -dist_html_DATA += $(WHITE_PAPER_HTML_OUTPUTS) - -WHITE_PAPER_PDF = $(white_paper_dir)/white_paper.pdf -# Extra dependencies. -$(WHITE_PAPER_PDF): $(PNGS) - -dist_pdf_DATA += $(WHITE_PAPER_PDF) - -EXTRA_DIST += \ - $(white_paper_dir)/white_paper.tex \ - $(PNGS) \ - $(EPSS) - -MAINTAINERCLEANFILES += $(EPSS) +DATA_html_dirs += $(WHITE_PAPER) ## ----------------- ## ## Reference Guide. ## ## ----------------- ## -ref_guide_dir = $(srcdir)/ref_guide +EXTRA_DIST += ref-guide.tex -ref_guide_dependencies = \ +REF_GUIDE_deps = \ $(EXAMPLES) \ $(SPLIT_EXAMPLES) \ $(OUTPUTS) \ @@ -506,61 +508,57 @@ ref_guide_dependencies = \ $(PNG_FIGURES) \ $(DOC_PACKAGES) -# Final product. -REF_GUIDE_HTML = $(ref_guide_dir)/ref_guide.html -REF_GUIDE_HTML_OUTPUTS = \ - $(REF_GUIDE_HTML) \ - $(ref_guide_dir)/ref_guide.css \ - $(ref_guide_dir)/ref_guide0x.png - -EXTRA_DIST += $(REF_GUIDE_HTML).stamp -MAINTAINERCLEANFILES += $(REF_GUIDE_HTML).stamp -# HTML outputs contains several files (the HTML file itself, its CSS -# style sheet, possibly some images). Therefore, we cannot rely on a -# simple suffix rule to produce them. -$(REF_GUIDE_HTML).stamp: $(ref_guide_dir)/ref_guide.tex $(ref_guide_dependencies) +# PDF. +REF_GUIDE_PDF = $(srcdir)/ref-guide.pdf +dist_pdf_DATA += $(REF_GUIDE_PDF) +$(REF_GUIDE_PDF): $(REF_GUIDE_deps) + +# HTML. +REF_GUIDE = ref-guide +all-local: $(srcdir)/$(REF_GUIDE).stamp + +# The HTML output contains several files (the HTML file itself, its +# CSS style sheet, possibly some images). Therefore, we cannot rely +# on a simple suffix rule to produce them. Instead, put the products +# in a directory and use a time stamp. +$(srcdir)/$(REF_GUIDE).stamp: $(srcdir)/ref-guide.tex $(REF_GUIDE_deps) @rm -f $@.tmp @touch $@.tmp - $(TEXI2HTML) $(TEXI2HTML_FLAGS) -o $(REF_GUIDE_HTML) $< + rm -rf $(REF_GUIDE).tmp + mkdir $(REF_GUIDE).tmp + $(TEXI2HTML) $(TEXI2HTML_FLAGS) \ + -o $(REF_GUIDE).tmp/$(REF_GUIDE).html $< + rm -rf $(srcdir)/$(REF_GUIDE) +## FIXME: moving directories between file systems is not portable. + mv $(REF_GUIDE).tmp $(srcdir)/$(REF_GUIDE) @mv -f $@.tmp $@ +EXTRA_DIST += $(srcdir)/$(REF_GUIDE).stamp +MAINTAINERCLEANFILES += $(srcdir)/$(REF_GUIDE).stamp -$(REF_GUIDE_HTML_OUTPUTS): $(REF_GUIDE_HTML).stamp -## Recover from the removal of $@ - @if test -f $@; then :; else \ +$(srcdir)/$(REF_GUIDE): $(srcdir)/$(REF_GUIDE).stamp +## Recover from the removal of $@. + @if test -d $@; then :; else \ rm -f $<; \ $(MAKE) $(AM_MAKEFLAGS) $<; \ fi +DATA_html_dirs += $(REF_GUIDE) -dist_html_DATA += $(REF_GUIDE_HTML_OUTPUTS) - -# Intermediate product for the various doc targets of the parent -# directory. +# Intermediate product for the (Doxygen) User Reference Manual. # # This is not a bug: REF_GUIDE_HH is meant to have a `.hh' extension, # 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) $(srcdir)/tools/todoxygen.sh +REF_GUIDE_HH = $(srcdir)/ref-guide.hh +$(REF_GUIDE_HH): $(srcdir)/$(REF_GUIDE).stamp $(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 - $(srcdir)/tools/todoxygen.sh $< $@.tmp $(srcdir) + $(srcdir)/tools/todoxygen.sh \ + $(srcdir)/$(REF_GUIDE)/$(REF_GUIDE).html $@.tmp $(srcdir) mv -f $@.tmp $@ - - -# Final product. -REF_GUIDE_PDF = $(ref_guide_dir)/ref_guide.pdf -# Extra dependencies. -$(REF_GUIDE_PDF): $(ref_guide_dependencies) - -dist_pdf_DATA += $(REF_GUIDE_PDF) - -EXTRA_DIST += \ - $(ref_guide_dir)/ref_guide.tex \ - $(REF_GUIDE_HH) - +EXTRA_DIST += $(REF_GUIDE_HH) MAINTAINERCLEANFILES += $(REF_GUIDE_HH) @@ -720,6 +718,7 @@ MAINTAINERCLEANFILES += $(dist_html_DATA) $(dist_pdf_DATA) EXTRA_DIST += \ + $(DATA_html_dirs) \ $(DOXYFILE).in \ groups/accu.hh \ groups/graph.hh \ diff --git a/milena/doc/white_paper/figures/house.png b/milena/doc/figures/house.png similarity index 100% rename from milena/doc/white_paper/figures/house.png rename to milena/doc/figures/house.png diff --git a/milena/doc/white_paper/figures/house_rag.png b/milena/doc/figures/house_rag.png similarity index 100% rename from milena/doc/white_paper/figures/house_rag.png rename to milena/doc/figures/house_rag.png diff --git a/milena/doc/white_paper/figures/house_wshed.png b/milena/doc/figures/house_wshed.png similarity index 100% rename from milena/doc/white_paper/figures/house_wshed.png rename to milena/doc/figures/house_wshed.png diff --git a/milena/doc/white_paper/figures/house_wshed_mean_colors.png b/milena/doc/figures/house_wshed_mean_colors.png similarity index 100% rename from milena/doc/white_paper/figures/house_wshed_mean_colors.png rename to milena/doc/figures/house_wshed_mean_colors.png diff --git a/milena/doc/technical/figures/file_layout.pdf b/milena/doc/figures/technical/file_layout.pdf similarity index 100% rename from milena/doc/technical/figures/file_layout.pdf rename to milena/doc/figures/technical/file_layout.pdf diff --git a/milena/doc/technical/figures/file_layout.png b/milena/doc/figures/technical/file_layout.png similarity index 100% rename from milena/doc/technical/figures/file_layout.png rename to milena/doc/figures/technical/file_layout.png diff --git a/milena/doc/graphicx.hva b/milena/doc/graphicx.hva new file mode 100644 index 0000000..ff95ca7 --- /dev/null +++ b/milena/doc/graphicx.hva @@ -0,0 +1,3 @@ + % -*- LaTeX -*- + +\newcommand{\includegraphics}[2][]{\imgsrc{#2.png}} diff --git a/milena/doc/ref_guide/ref_guide.tex b/milena/doc/ref-guide.tex similarity index 100% rename from milena/doc/ref_guide/ref_guide.tex rename to milena/doc/ref-guide.tex diff --git a/milena/doc/technical/designs/properties/values.txt b/milena/doc/technical.old/designs/properties/values.txt similarity index 100% rename from milena/doc/technical/designs/properties/values.txt rename to milena/doc/technical.old/designs/properties/values.txt diff --git a/milena/doc/technical/designs/site_psite_piter/README b/milena/doc/technical.old/designs/site_psite_piter/README similarity index 100% rename from milena/doc/technical/designs/site_psite_piter/README rename to milena/doc/technical.old/designs/site_psite_piter/README diff --git a/milena/doc/technical/technical.tex b/milena/doc/technical.tex similarity index 96% rename from milena/doc/technical/technical.tex rename to milena/doc/technical.tex index 198bcd6..4afc908 100644 --- a/milena/doc/technical/technical.tex +++ b/milena/doc/technical.tex @@ -131,15 +131,15 @@ reference documents available here: Writing a new routine in Milena requires a specific layout in the -code. This layout is described in figure \ref{figures/file_layout}. +code. This layout is described in figure \ref{figures/technical/file_layout}. \begin{center} - \doxyimg{figures/file_layout}{8cm} + \doxyimg{figures/technical/file_layout}{8cm} \end{center} For a better understanding, we are going to comment this figure -(fig. \ref{figures/file_layout}) from the bottom to the top. +(fig. \ref{figures/technical/file_layout}) from the bottom to the top. \begin{itemize} \item \textbf{Facade}. The facade is the public routine that will be diff --git a/milena/doc/tutorial/design/Makefile b/milena/doc/tutorial.old/design/Makefile similarity index 100% rename from milena/doc/tutorial/design/Makefile rename to milena/doc/tutorial.old/design/Makefile diff --git a/milena/doc/tutorial/design/design.tex b/milena/doc/tutorial.old/design/design.tex similarity index 100% rename from milena/doc/tutorial/design/design.tex rename to milena/doc/tutorial.old/design/design.tex diff --git a/milena/doc/tutorial/design/include/imagetours.tex b/milena/doc/tutorial.old/design/include/imagetours.tex similarity index 100% rename from milena/doc/tutorial/design/include/imagetours.tex rename to milena/doc/tutorial.old/design/include/imagetours.tex diff --git a/milena/doc/tutorial/design/include/properties.tex b/milena/doc/tutorial.old/design/include/properties.tex similarity index 100% rename from milena/doc/tutorial/design/include/properties.tex rename to milena/doc/tutorial.old/design/include/properties.tex diff --git a/milena/doc/tutorial/doxyfile_tuto.local b/milena/doc/tutorial.old/doxyfile_tuto.local similarity index 100% rename from milena/doc/tutorial/doxyfile_tuto.local rename to milena/doc/tutorial.old/doxyfile_tuto.local diff --git a/milena/doc/tutorial/image_types.txt b/milena/doc/tutorial.old/image_types.txt similarity index 100% rename from milena/doc/tutorial/image_types.txt rename to milena/doc/tutorial.old/image_types.txt diff --git a/milena/doc/tutorial/image_values.txt b/milena/doc/tutorial.old/image_values.txt similarity index 100% rename from milena/doc/tutorial/image_values.txt rename to milena/doc/tutorial.old/image_values.txt diff --git a/milena/doc/tutorial/images_tour.txt b/milena/doc/tutorial.old/images_tour.txt similarity index 100% rename from milena/doc/tutorial/images_tour.txt rename to milena/doc/tutorial.old/images_tour.txt diff --git a/milena/doc/tutorial/slides.tex b/milena/doc/tutorial.old/slides.tex similarity index 100% rename from milena/doc/tutorial/slides.tex rename to milena/doc/tutorial.old/slides.tex diff --git a/milena/doc/tutorial/tutorial.tex b/milena/doc/tutorial.tex similarity index 100% rename from milena/doc/tutorial/tutorial.tex rename to milena/doc/tutorial.tex diff --git a/milena/doc/tutorial/headers.stamp b/milena/doc/tutorial/headers.stamp deleted file mode 100644 index e69de29..0000000 diff --git a/milena/doc/white_paper/white_paper.tex b/milena/doc/white-paper.tex similarity index 100% rename from milena/doc/white_paper/white_paper.tex rename to milena/doc/white-paper.tex -- 1.5.6.5

14 years, 1 month

← Newer
1
2
3
4
5
6
7
8
...
28
Older →

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