From: Zachary T Welch <zw@superlucidity.net>
Date: Tue, 17 Nov 2009 14:54:56 +0000 (-0800)
Subject: allow documentation to be configured
X-Git-Tag: v0.4.0-rc1~522
X-Git-Url: https://review.openocd.org/gitweb?p=openocd.git;a=commitdiff_plain;h=0091e59d2a18c293fd952a9d707e609afdd6b17f

allow documentation to be configured

Add --disable-doxygen-html and --enable-doxygen-pdf options to the
configure script, allowing user to change the defaults.  These
update the proess of munging the Doxygen configuration file to
use the settings thusly provided.  Add options in README.
---

diff --git a/Doxyfile.in b/Doxyfile.in
index 077db10a21..49630f2ffb 100644
--- a/Doxyfile.in
+++ b/Doxyfile.in
@@ -764,7 +764,7 @@ IGNORE_PREFIX          =
 # If the GENERATE_HTML tag is set to YES (the default) Doxygen will
 # generate HTML output.
 
-GENERATE_HTML          = YES
+GENERATE_HTML          = @doxygen_as_html@
 
 # The HTML_OUTPUT tag is used to specify where the HTML docs will be put.
 # If a relative path is entered the value of OUTPUT_DIRECTORY will be
@@ -981,7 +981,7 @@ FORMULA_FONTSIZE       = 10
 # If the GENERATE_LATEX tag is set to YES (the default) Doxygen will
 # generate Latex output.
 
-GENERATE_LATEX         = YES
+GENERATE_LATEX         = @doxygen_as_pdf@
 
 # The LATEX_OUTPUT tag is used to specify where the LaTeX docs will be put.
 # If a relative path is entered the value of OUTPUT_DIRECTORY will be
diff --git a/Makefile.am b/Makefile.am
index be42c2832a..c06771204b 100644
--- a/Makefile.am
+++ b/Makefile.am
@@ -25,7 +25,9 @@ Doxyfile: $(srcdir)/Doxyfile.in
 	@( \
 	  echo "### @@@ -= DO NOT EDIT THIS FILE =- @@@ ###" && \
 	  echo "### @@@ Make changes to Doxyfile.in @@@ ###" && \
-	  sed -e 's,@srcdir\@,$(srcdir),' $< \
+	  sed -e 's,@srcdir\@,$(srcdir),' \
+	    -e 's,@doxygen_as_html\@,$(doxygen_as_html),' \
+	    -e 's,@doxygen_as_pdf\@,$(doxygen_as_pdf),' $< \
 	) > $@
 
 THE_MANUAL = doxygen/latex/refman.pdf
diff --git a/README b/README
index 33258e8aab..0ba6f76b3c 100644
--- a/README
+++ b/README
@@ -258,6 +258,9 @@ options may be available there:
   --enable-httpd          Enable builtin httpd server - useful for standalone
                           OpenOCD implementations
 
+  --disable-doxygen-html Disable building Doxygen manual as HTML.
+  --enable-doxygen-pdf   Enable building Doxygen manual as PDF.
+
 Miscellaneous Configure Options
 -------------------------------
 
diff --git a/configure.in b/configure.in
index fa2a4985bf..8ba8951234 100644
--- a/configure.in
+++ b/configure.in
@@ -277,6 +277,24 @@ AC_ARG_WITH(ftd2xx-lib,
   with_ftd2xx_lib=static
   ])
 
+
+AC_ARG_ENABLE(doxygen-html,
+  AS_HELP_STRING([--disable-doxygen-html],
+    [Disable building Doxygen manual as HTML.]),
+  [doxygen_as_html=$enableval], [doxygen_as_html=yes])
+AC_SUBST(doxygen_as_html)
+AC_MSG_CHECKING([whether to build Doxygen as HTML])
+AC_MSG_RESULT($doxygen_as_html)
+
+AC_ARG_ENABLE(doxygen-pdf,
+  AS_HELP_STRING([--enable-doxygen-pdf],
+    [Enable building Doxygen manual as PDF.]),
+  [doxygen_as_pdf=$enableval], [doxygen_as_pdf=no])
+AC_SUBST(doxygen_as_pdf)
+AC_MSG_CHECKING([whether to build Doxygen as PDF])
+AC_MSG_RESULT($doxygen_as_pdf)
+
+
 AC_ARG_ENABLE(gccwarnings,
   AS_HELP_STRING([--disable-gccwarnings], [Disable compiler warnings]),
   [gcc_warnings=$enableval], [gcc_warnings=yes])