This is an automated email from Gerrit. "Marc Schink <[email protected]>" just uploaded a new patch set to Gerrit, which you can find at https://review.openocd.org/c/openocd/+/9495
-- gerrit commit 09adc6ca03db407eae68eb5f691a0a6880693d78 Author: Marc Schink <[email protected]> Date: Mon Mar 9 14:39:14 2026 +0100 docs: Drop support for Doxygen PDF output The Doxygen PDF output is effectively unusable. Generating it takes more than 8 minutes and then fails with a TeX memory error: ! TeX capacity exceeded, sorry [main memory size=5000000]. <inserted text> ..._async\_timestamps}{272}{p\ETC. l.147 \begin{document} ^^M If you really absolutely need more capacity, you can ask a wizard to enlarge me. Even if you manually increase the memory limits, the result is a document with around 5000 pages in which tables are damaged and dependency graphs are unreadable, meaning that there is no practical benefit in maintaining this option. The Doxygen PDF option is not documented, disabled by default, and we have received no bug reports about it, which strongly suggests it is unused. With the Doxygen PDF output removed, HTML remains the only supported output format. Always build the HTML documentation and drop the corresponding build-system option to simplify the configuration. If someone really needs a PDF version, they can still enable it manually in a local Doxygen setup. Change-Id: Id246483722b87d13174c1ce41b0604be5459527a Signed-off-by: Marc Schink <[email protected]> diff --git a/Doxyfile.in b/Doxyfile.in index 9be53d0fc6..be136be7d4 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 = @doxygen_as_html@ +GENERATE_HTML = YES # 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 = @doxygen_as_pdf@ +GENERATE_LATEX = NO # 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 79bc599e6e..240e146bde 100644 --- a/Makefile.am +++ b/Makefile.am @@ -99,26 +99,12 @@ Doxyfile: $(srcdir)/Doxyfile.in echo "### @@@ -= DO NOT EDIT THIS FILE =- @@@ ###" && \ echo "### @@@ Make changes to Doxyfile.in @@@ ###" && \ sed -e 's,@srcdir\@,$(srcdir),' \ - -e 's,@builddir\@,$(builddir),' \ - -e 's,@doxygen_as_html\@,$(doxygen_as_html),' \ - -e 's,@doxygen_as_pdf\@,$(doxygen_as_pdf),' $< \ + -e 's,@builddir\@,$(builddir),' $< \ ) > $@ -THE_MANUAL = doxygen/latex/refman.pdf - doxygen:: $(MAKE) Doxyfile doxygen Doxyfile 2>&1 | perl $(srcdir)/tools/logger.pl > doxygen.log - @if [ -f doxygen/latex/refman.tex ]; then \ - echo "Creating $(THE_MANUAL)..."; \ - $(MAKE) $(THE_MANUAL); \ - else \ - echo "Skipping Doxygen PDF..."; \ - fi - -$(THE_MANUAL): %.pdf: %.tex - -cd $$(dirname $*) && pdflatex $$(basename $*) - -cd $$(dirname $*) && pdflatex $$(basename $*) TCL_PATH = tcl # command to find paths of script files, relative to TCL_PATH diff --git a/configure.ac b/configure.ac index 39f5e074ed..d87660f8a0 100644 --- a/configure.ac +++ b/configure.ac @@ -223,22 +223,6 @@ m4_define([OPTIONAL_LIBRARIES], m4_define([COVERAGE], [[[gcov], [Collect coverage using gcov], []]]) -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]) --
