allow documentation to be configured
authorZachary T Welch <zw@superlucidity.net>
Tue, 17 Nov 2009 14:54:56 +0000 (06:54 -0800)
committerZachary T Welch <zw@superlucidity.net>
Tue, 17 Nov 2009 19:42:48 +0000 (11:42 -0800)
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.

Doxyfile.in
Makefile.am
README
configure.in

index 077db10..49630f2 100644 (file)
@@ -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
index be42c28..c067712 100644 (file)
@@ -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 33258e8..0ba6f76 100644 (file)
--- 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
 -------------------------------
 
index fa2a498..8ba8951 100644 (file)
@@ -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])