From b9a109e02c8f7b8492c201cb2577ce167ac3f64c Mon Sep 17 00:00:00 2001 From: Sebastian Pipping Date: Fri, 6 Mar 2009 06:21:16 +0100 Subject: [PATCH] Fix doc generation system --- ChangeLog | 5 +++- Makefile.am | 6 +++++ bindings/c/doc/Doxyfile.in | 2 +- bindings/c/doc/Makefile.am | 49 +++++++++++++++++++++++++++--------------- bindings/c/doc/configure.ac | 1 + doc/Doxyfile.in | 2 +- doc/Makefile.am | 47 +++++++++++++++++++++++++--------------- doc/configure.ac | 1 + scripts/release.sh | 4 +- 9 files changed, 76 insertions(+), 41 deletions(-) create mode 100644 bindings/c/doc/m4/pkg.m4 create mode 100644 doc/m4/pkg.m4 diff --git a/ChangeLog b/ChangeLog index fde7c16..26bac5b 100644 --- a/ChangeLog +++ b/ChangeLog @@ -5,9 +5,12 @@ - libcpptest 1.1.0 or later - uriparser 0.7.5 or later - pkg-config - The libcpptest dependency can be disable through + The libcpptest dependency can be disabled through configuring with --disable-test, which excludes the test suite from compilation. + * Fixed: Doc generation bugs + * Fixed: Qt Compressed Help files were not installed + * Fixed: Shadow/VPATH build doc generation 2009-02-21 -- 1.1.0 diff --git a/Makefile.am b/Makefile.am index 6323278..0d7257f 100644 --- a/Makefile.am +++ b/Makefile.am @@ -178,6 +178,8 @@ endif EXTRA_DIST = \ + bindings/c/doc/m4/pkg.m4 \ + \ bindings/c/doc/aclocal.m4 \ bindings/c/doc/configure \ bindings/c/doc/configure.ac \ @@ -186,6 +188,8 @@ EXTRA_DIST = \ bindings/c/doc/Makefile.in \ bindings/c/doc/release.sh.in \ \ + doc/m4/pkg.m4 \ + \ doc/aclocal.m4 \ doc/configure \ doc/configure.ac \ @@ -197,6 +201,8 @@ EXTRA_DIST = \ \ examples/read/playlist.xspf \ \ + m4/pkg.m4 \ + \ test/for_version_0/fail/playlist-extension-forbidden.xspf \ test/for_version_0/fail/track-extension-forbidden.xspf \ test/for_version_0/fail/tracklist-no-tracks.xspf \ diff --git a/bindings/c/doc/Doxyfile.in b/bindings/c/doc/Doxyfile.in index f79dcb4..1e923bb 100644 --- a/bindings/c/doc/Doxyfile.in +++ b/bindings/c/doc/Doxyfile.in @@ -284,7 +284,7 @@ WARN_IF_DOC_ERROR = YES ############################################################### -INPUT = .. +INPUT = @srcdir@/.. # The INPUT tag is used to specify the files and/or directories that contain documented source files. You may enter file names like myfile.cpp or directories like /usr/src/myproject. Separate the files or directories with spaces. # # Note: If this tag is empty the current directory is searched. diff --git a/bindings/c/doc/Makefile.am b/bindings/c/doc/Makefile.am index 8763599..4638ef3 100644 --- a/bindings/c/doc/Makefile.am +++ b/bindings/c/doc/Makefile.am @@ -1,25 +1,38 @@ ## Process this file with automake to produce Makefile.in AUTOMAKE_OPTIONS = 1.10 foreign dist-zip no-dist-gzip -noinst_SCRIPTS = phony_html_doc - -phony_html_doc : - rm -f html/*.css - rm -f html/*.gif - rm -f html/*.html - rm -f html/*.png - rm -f html/*.map - rm -f html/*.md5 - rm -f html/graph_legend.dot - rm -f html/index.* +## Build doc files +all-local: html/index.html + +html/index.html: $(srcdir)/../*.h \ + $(srcdir)/../*.cpp \ + $(srcdir)/../../../include/xspf/*.h \ + $(srcdir)/../../../src/*.cpp \ + $(srcdir)/../../../src/*.h + -rm -Rf "$(builddir)/html" doxygen Doxyfile + touch html/index.html + + +## Clean doc files +clean-local: + -rm -Rf "$(builddir)/html" + -rm -f *.qch + + +## Clean configure files +distclean-local: + -rm -f config.{log,status} release.sh Doxyfile + -DOC_FILES = \ - html/*.css \ - html/*.gif \ - html/*.html \ - html/*.png +## Install doc files +install-data-local: + $(MKDIR_P) "$(DESTDIR)$(docdir)/html" ## Didn't work with installdirs-local + $(INSTALL_DATA) html/*.{css,gif,html,png} "$(DESTDIR)$(docdir)/html/" + $(INSTALL_DATA) *.qch "$(DESTDIR)$(docdir)/" -## Make doc files get installed -nobase_nodist_doc_DATA = $(DOC_FILES) +## Uninstall doc files +uninstall-local: + -rm -Rf "$(DESTDIR)$(docdir)/html" + -rm -f "$(DESTDIR)$(docdir)"/*.qch diff --git a/bindings/c/doc/configure.ac b/bindings/c/doc/configure.ac index 6f951c5..eeae7c4 100644 --- a/bindings/c/doc/configure.ac +++ b/bindings/c/doc/configure.ac @@ -30,6 +30,7 @@ else fi AC_SUBST(GENERATE_HTMLHELP) AC_SUBST(QHG_LOCATION) +AC_SUBST(srcdir, [${ac_abs_confdir}]) AC_CONFIG_FILES([ diff --git a/bindings/c/doc/m4/pkg.m4 b/bindings/c/doc/m4/pkg.m4 new file mode 100644 index 0000000..e69de29 diff --git a/doc/Doxyfile.in b/doc/Doxyfile.in index 4bc33f0..71d8c29 100644 --- a/doc/Doxyfile.in +++ b/doc/Doxyfile.in @@ -285,7 +285,7 @@ WARN_IF_DOC_ERROR = YES ############################################################### -INPUT = ../include Mainpage +INPUT = @srcdir@/../include/xspf @srcdir@/Mainpage # The INPUT tag is used to specify the files and/or directories that contain documented source files. You may enter file names like myfile.cpp or directories like /usr/src/myproject. Separate the files or directories with spaces. # # Note: If this tag is empty the current directory is searched. diff --git a/doc/Makefile.am b/doc/Makefile.am index 8763599..216f070 100644 --- a/doc/Makefile.am +++ b/doc/Makefile.am @@ -1,25 +1,36 @@ ## Process this file with automake to produce Makefile.in AUTOMAKE_OPTIONS = 1.10 foreign dist-zip no-dist-gzip -noinst_SCRIPTS = phony_html_doc - -phony_html_doc : - rm -f html/*.css - rm -f html/*.gif - rm -f html/*.html - rm -f html/*.png - rm -f html/*.map - rm -f html/*.md5 - rm -f html/graph_legend.dot - rm -f html/index.* +## Build doc files +all-local: html/index.html + +html/index.html: $(srcdir)/../include/xspf/*.h \ + $(srcdir)/../src/*.cpp \ + $(srcdir)/../src/*.h + -rm -Rf "$(builddir)/html" doxygen Doxyfile + touch html/index.html + + +## Clean doc files +clean-local: + -rm -Rf "$(builddir)/html" + -rm -f *.qch + + +## Clean configure files +distclean-local: + -rm -f config.{log,status} release.sh Doxyfile + -DOC_FILES = \ - html/*.css \ - html/*.gif \ - html/*.html \ - html/*.png +## Install doc files +install-data-local: + $(MKDIR_P) "$(DESTDIR)$(docdir)/html" ## Didn't work with installdirs-local + $(INSTALL_DATA) html/*.{css,gif,html,png} "$(DESTDIR)$(docdir)/html/" + $(INSTALL_DATA) *.qch "$(DESTDIR)$(docdir)/" -## Make doc files get installed -nobase_nodist_doc_DATA = $(DOC_FILES) +## Uninstall doc files +uninstall-local: + -rm -Rf "$(DESTDIR)$(docdir)/html" + -rm -f "$(DESTDIR)$(docdir)"/*.qch diff --git a/doc/configure.ac b/doc/configure.ac index 16ddc33..1aa02a7 100644 --- a/doc/configure.ac +++ b/doc/configure.ac @@ -30,6 +30,7 @@ else fi AC_SUBST(GENERATE_HTMLHELP) AC_SUBST(QHG_LOCATION) +AC_SUBST(srcdir, [${ac_abs_confdir}]) AC_CONFIG_FILES([ diff --git a/doc/m4/pkg.m4 b/doc/m4/pkg.m4 new file mode 100644 index 0000000..e69de29 diff --git a/scripts/release.sh b/scripts/release.sh index 013e105..1edc589 100755 --- a/scripts/release.sh +++ b/scripts/release.sh @@ -20,7 +20,7 @@ echo ========== configure ========== echo echo ========== make distcheck ========== -make -j10 distcheck || exit 1 +make -j10 distcheck DISTCHECK_CONFIGURE_FLAGS='--enable-doc' || exit 1 echo echo ========== package docs ========== @@ -58,7 +58,7 @@ If so .. - SourceForge news * upload doc * update doc to website -* tag svn trunk +* git tag CHECKLIST exit $res -- 1.7.2.5