[Lemon-commits] Akos Ladanyi: Reworked documentation generation ...

[Lemon HG]

details:   http://lemon.cs.elte.hu/hg/lemon/rev/6ec5dbed8f18
changeset: 60:6ec5dbed8f18
user:      Akos Ladanyi <ladanyi [at] tmit.bme.hu>
date:      Wed Jan 23 16:26:41 2008 +0100
description:
	Reworked documentation generation and installation. Details:
	- Remove configure flag used to disable the automatic generation of
	the documentation when istalling.
	- Now 'make html' generates the documentation.
	- Now 'make install' does not install the documentation, 'make
	install-html' does that. The latter two changes follow newer
	automake conventions.
	- This also fixes the bug that caused the documentation missing from
	the tarball.

diffstat:

2 files changed, 29 insertions(+), 63 deletions(-)
configure.ac    |   35 +--------------------------------
doc/Makefile.am |   57 ++++++++++++++++++++++++++-----------------------------

diffs (147 lines):

diff -r 4ab73d92f0fb -r 6ec5dbed8f18 configure.ac
--- a/configure.ac	Tue Jan 22 10:59:14 2008 +0000
+++ b/configure.ac	Wed Jan 23 16:26:41 2008 +0100
@@ -26,43 +26,16 @@ AC_DISABLE_SHARED
 AC_DISABLE_SHARED
 AC_PROG_LIBTOOL
 
+AC_CHECK_PROG([doxygen_found],[doxygen],[yes],[no])
+
 if test x"$lx_cmdline_cxxflags_set" != x"set" -a "$GXX" = yes; then
   CXXFLAGS="$CXXFLAGS -Wall -W -Wall -W -Wunused -Wformat=2 -Wctor-dtor-privacy -Wnon-virtual-dtor -Wno-char-subscripts -Wwrite-strings -Wno-char-subscripts -Wreturn-type -Wcast-qual -Wcast-align -Wsign-promo -Woverloaded-virtual -Woverloaded-virtual -ansi -fno-strict-aliasing -Wold-style-cast -Wno-unknown-pragmas"
 fi
-
-AC_CHECK_PROG([doxygen_found],[doxygen],[yes],[no])
 
 dnl Checks for libraries.
 LX_CHECK_GLPK
 LX_CHECK_CPLEX
 LX_CHECK_SOPLEX
-
-dnl Enable/disable installing the documentation
-AC_ARG_ENABLE([doc],
-AS_HELP_STRING([--enable-doc@<:@=yes|no|full@:>@], [build the documentation (full enables internal documentation too) @<:@default=yes@:>@])
-AS_HELP_STRING([--disable-doc], [do not build the documentation]),
-              [], [enable_doc=yes])
-
-AC_MSG_CHECKING([whether to build the documention])
-case "$enable_doc" in
-  yes)
-    DOXYGEN_INTERNAL_DOCS=NO
-    AC_MSG_RESULT([yes])
-    ;;
-  full)
-    DOXYGEN_INTERNAL_DOCS=YES
-    AC_MSG_RESULT([full])
-    ;;
-  no)
-    DOXYGEN_INTERNAL_DOCS=NO
-    AC_MSG_RESULT([no])
-    ;;
-  *)
-    AC_MSG_ERROR([bad value $enable_doc for option --enable-doc])
-    ;;
-esac
-AC_SUBST(DOXYGEN_INTERNAL_DOCS)
-AM_CONDITIONAL([WANT_DOC], [test x"$enable_doc" != x"no"])
 
 dnl Disable/enable building the demo programs
 AC_ARG_ENABLE([demo],
@@ -145,10 +118,6 @@ echo -n '  '
 echo -n '  '
 echo $prefix.
 echo
-echo The documentation will be installed in
-echo -n '  '
-eval echo ${datadir}/doc/$PACKAGE.
-echo
 echo '*********************************************************************'
 
 echo
diff -r 4ab73d92f0fb -r 6ec5dbed8f18 doc/Makefile.am
--- a/doc/Makefile.am	Tue Jan 22 10:59:14 2008 +0000
+++ b/doc/Makefile.am	Wed Jan 23 16:26:41 2008 +0100
@@ -1,56 +1,53 @@ htmldir = $(datadir)/doc/$(PACKAGE)/html
-htmldir = $(datadir)/doc/$(PACKAGE)/html
-
 EXTRA_DIST += \
 	doc/Makefile \
-	doc/Doxyfile.in
+	doc/Doxyfile.in \
+	doc/coding_style.dox \
+	doc/dirs.dox \
+	doc/groups.dox \
+	doc/license.dox \
+	doc/mainpage.dox \
+	doc/namespaces.dox \
+	doc/html
 
-doc:
+doc/html:
+	$(MAKE) $(AM_MAKEFLAGS) html
+
+html-local:
 	if test ${doxygen_found} = yes; then \
 	  cd doc; \
 	  doxygen Doxyfile; \
 	  cd ..; \
-	fi
-
-doc-clean:
-	if test ${doxygen_found} = yes; then \
-	  rm -rf doc/html; \
-	  rm -f doc/doxygen.log; \
-	  cd doc; \
-	  doxygen Doxyfile; \
-	  cd ..; \
+	else \
+	  echo; \
+	  echo "Doxygen not found."; \
+	  echo; \
+	  exit 1; \
 	fi
 
 clean-local:
 	-rm -rf doc/html
 	-rm -f doc/doxygen.log
 
-doc/html:
-	$(MAKE) $(AM_MAKEFLAGS) doc-clean
-
 update-external-tags:
 	wget -O doc/libstdc++.tag.tmp http://gcc.gnu.org/onlinedocs/libstdc++/latest-doxygen/libstdc++.tag && \
 	mv doc/libstdc++.tag.tmp doc/libstdc++.tag || \
 	rm doc/libstdc++.tag.tmp
 
-if WANT_DOC
-
-install-data-local: doc/html
+install-html-local: doc/html
 	@$(NORMAL_INSTALL)
-	$(mkinstalldirs) $(DESTDIR)$(htmldir)
-	@dir='doc/html'; shopt -s nullglob; for p in $$dir/*.html $$dir/*.css $$dir/*.png $$dir/*.gif $$dir/*.dot $$dir/*.php $$dir/*.idx $$dir/*.tag ; do \
+	$(mkinstalldirs) $(DESTDIR)$(htmldir)/docs
+	for p in doc/html/*.{html,css,png,map,gif,tag} ; do \
 	  f="`echo $$p | sed -e 's|^.*/||'`"; \
-	  echo " $(INSTALL_DATA) $$p $(DESTDIR)$(htmldir)/$$f"; \
-	  $(INSTALL_DATA) $$p $(DESTDIR)$(htmldir)/$$f; \
+	  echo " $(INSTALL_DATA) $$p $(DESTDIR)$(htmldir)/docs/$$f"; \
+	  $(INSTALL_DATA) $$p $(DESTDIR)$(htmldir)/docs/$$f; \
 	done
 
-uninstall-local: doc/html
+uninstall-local:
 	@$(NORMAL_UNINSTALL)
-	@dir='doc/html'; shopt -s nullglob; for p in $$dir/*.html $$dir/*.css $$dir/*.png $$dir/*.gif $$dir/*.dot $$dir/*.php $$dir/*.idx $$dir/*.tag ; do \
+	for p in doc/html/*.{html,css,png,map,gif,tag} ; do \
 	  f="`echo $$p | sed -e 's|^.*/||'`"; \
-	  echo " rm -f $(DESTDIR)$(htmldir)/$$f"; \
-	  rm -f $(DESTDIR)$(htmldir)/$$f; \
+	  echo " rm -f $(DESTDIR)$(htmldir)/docs/$$f"; \
+	  rm -f $(DESTDIR)$(htmldir)/docs/$$f; \
 	done
 
-endif WANT_DOC
-
-.PHONY: doc doc-clean
+.PHONY: update-external-tags