* doc/Makefile.am (edit) ($(srcdir)/user-refman.stamp): Use `[@]' instead of `\@' for portability reasons. (ID): New (empty). ($(DOXYFILE_USER)): Do not depend on $Id$ from ChangeLog. * doc/Doxyfile.in (PROJECT_NUMBER): Reintegrate @ID@ to the project number, even if it is not yet set. Improve the generation of Doxyfiles in Olena. --- ChangeLog | 13 +++++++++++++ doc/Doxyfile.in | 4 ++-- doc/Makefile.am | 39 ++++++++++++++++++++------------------- 3 files changed, 35 insertions(+), 21 deletions(-) diff --git a/ChangeLog b/ChangeLog index dd4134d..0447440 100644 --- a/ChangeLog +++ b/ChangeLog @@ -1,3 +1,16 @@ +2013-08-26 Roland Levillain <roland@lrde.epita.fr> + + Improve the generation of Doxyfiles in Olena. + + * doc/Makefile.am (edit) + ($(srcdir)/user-refman.stamp): + Use `[@]' instead of `\@' for portability reasons. + (ID): New (empty). + ($(DOXYFILE_USER)): Do not depend on $Id$ from ChangeLog. + * doc/Doxyfile.in (PROJECT_NUMBER): Reintegrate @ID@ to the + project number, even if it is not yet set. + Improve the generation of Doxyfiles in Olena. + 2012-10-09 Roland Levillain <roland@lrde.epita.fr> Ask configure to try to find FFTW (version 3). diff --git a/doc/Doxyfile.in b/doc/Doxyfile.in index 6cb8bfb..526a24e 100644 --- a/doc/Doxyfile.in +++ b/doc/Doxyfile.in @@ -1,4 +1,4 @@ -# Copyright (C) 2011, 2012 EPITA Research and Development Laboratory +# Copyright (C) 2011, 2012, 2013 EPITA Research and Development Laboratory # (LRDE) # # This file is part of Olena. @@ -21,7 +21,7 @@ # Project related configuration options #--------------------------------------------------------------------------- PROJECT_NAME = "Olena" -PROJECT_NUMBER = "User documentation @PACKAGE_VERSION@" +PROJECT_NUMBER = "User documentation @PACKAGE_VERSION@ @ID@" PROJECT_BRIEF = "An Image Processing Platform" PROJECT_LOGO = @top_srcdir@/doc/images/logo.jpg OUTPUT_DIRECTORY = @builddir@/user-refman.tmp diff --git a/doc/Makefile.am b/doc/Makefile.am index 2ecb26d..878f7ce 100644 --- a/doc/Makefile.am +++ b/doc/Makefile.am @@ -86,25 +86,26 @@ REFMAN_deps = $(srcdir)/footer.html \ EXTRA_DIST += $(REFMAN_deps) -# Sed is used to generate Doxyfile from Doxyfile.in instead of -# configure, because the former is way faster than the latter. -# -## FIXME: This is because, as in TC, we depend on $Id$ from the -## ChangeLog. Maybe we should depend from something less prone to -## change. See Bison's build system. -edit = sed -e "s|@ID@|$$Id|" \ - -e 's,@PACKAGE_NAME\@,$(PACKAGE_NAME),g' \ - -e 's,@PACKAGE_VERSION\@,$(PACKAGE_VERSION),g' \ - -e 's,@top_srcdir\@,$(top_srcdir),g' \ - -e 's,@abs_top_srcdir\@,$(abs_top_srcdir),g' \ - -e 's,@top_builddir\@,$(top_builddir),g' \ - -e 's,@srcdir\@,$(srcdir),g' \ - -e 's,@builddir\@,$(builddir),g' +## FIXME: We used to depend on Subversion's $Id$ (extracted from +## ChangeLog) before. We should depend on something less prone to +## change from now on. The best is probably to use `git-version-gen' +## from Gnulib (as Bison does). For the moment, set ID to an empty +## string. +ID = +# Use Make to generate Doxyfile instead of `configure', as advised by +# Autoconf's manual (see section ``Installation Directory +# Variables''). +edit = sed -e "s|@ID[@]|$(ID)|" \ + -e 's,@PACKAGE_NAME[@],$(PACKAGE_NAME),g' \ + -e 's,@PACKAGE_VERSION[@],$(PACKAGE_VERSION),g' \ + -e 's,@top_srcdir[@],$(top_srcdir),g' \ + -e 's,@abs_top_srcdir[@],$(abs_top_srcdir),g' \ + -e 's,@top_builddir[@],$(top_builddir),g' \ + -e 's,@srcdir[@],$(srcdir),g' \ + -e 's,@builddir[@],$(builddir),g' $(DOXYFILE_USER): $(srcdir)/$(DOXYFILE).in - Id=`grep '^\$$Id' $(top_srcdir)/milena/ChangeLog \ - | sed -e 's/\\\$$//g'`; \ - $(edit) $< >$@ + $(edit) $< >$@ MAINTAINERCLEANFILES = $(DOXYFILE_USER) USER_REFMAN = user-refman @@ -122,8 +123,8 @@ $(srcdir)/user-refman.stamp: $(srcdir)/$(DOXYFILE).in $(REFMAN_deps) rm -rf $(srcdir)/$(USER_REFMAN) ## Fix path to the main page of the documentation. find $(USER_REFMAN).tmp/html -name '*.html' -exec \ - perl -pi -e "s,\@relcommondocpath\@,../../,g;" \ - -e "s,\@userrefman\@,$(USER_REFMAN),g" \ + perl -pi -e "s,@relcommondocpath[@],../../,g;" \ + -e "s,@userrefman[@],$(USER_REFMAN),g" \ {} \; ## FIXME: Moving directories between file systems is not portable. mv $(USER_REFMAN).tmp $(srcdir)/$(USER_REFMAN) -- 1.7.10.4