public inbox for libstdc++@gcc.gnu.org
 help / color / mirror / Atom feed
* [committed] libstdc++: Reduce output of 'make doc-pdf-doxygen'
@ 2021-04-28 13:59 Jonathan Wakely
  0 siblings, 0 replies; only message in thread
From: Jonathan Wakely @ 2021-04-28 13:59 UTC (permalink / raw)
  To: libstdc++, gcc-patches

[-- Attachment #1: Type: text/plain, Size: 794 bytes --]

Use '@' to prevent Make from echoing the recipe, so that users don't see
this every time:

  if [ -f ${doxygen_pdf} ]; then
    mv ${doxygen_pdf} ${api_pdf} ;
    echo ":: PDF file is ${api_pdf}";
  else
    echo "... error";
    grep -F 'LaTeX Error' ${doxygen_outdir}/latex/refman.log;
    grep -F 'TeX capacity exceeded, sorry' ${doxygen_outdir}/latex/refman.log;
    exit 12;
  fi

The presence of the "error" strings in the output makes it look like an
error happened. By suppressing the echoing user's will only see "error"
if the 'else' branch is taken.

libstdc++-v3/ChangeLog:

	* doc/Makefile.am (stamp-pdf-doxygen): Improve comment about
	dealing with errors. Use '@' to prevent shell command being
	echoed.
	* doc/Makefile.in: Regenerate.

Tested x86_64-linux. Committed to trunk.


[-- Attachment #2: patch.txt --]
[-- Type: text/plain, Size: 2129 bytes --]

commit 43a35b26e2fd2fab9c0c3ebac67e3a6c439daef4
Author: Jonathan Wakely <jwakely@redhat.com>
Date:   Wed Apr 28 14:49:28 2021

    libstdc++: Reduce output of 'make doc-pdf-doxygen'
    
    Use '@' to prevent Make from echoing the recipe, so that users don't see
    this every time:
    
      if [ -f ${doxygen_pdf} ]; then
        mv ${doxygen_pdf} ${api_pdf} ;
        echo ":: PDF file is ${api_pdf}";
      else
        echo "... error";
        grep -F 'LaTeX Error' ${doxygen_outdir}/latex/refman.log;
        grep -F 'TeX capacity exceeded, sorry' ${doxygen_outdir}/latex/refman.log;
        exit 12;
      fi
    
    The presence of the "error" strings in the output makes it look like an
    error happened. By suppressing the echoing user's will only see "error"
    if the 'else' branch is taken.
    
    libstdc++-v3/ChangeLog:
    
            * doc/Makefile.am (stamp-pdf-doxygen): Improve comment about
            dealing with errors. Use '@' to prevent shell command being
            echoed.
            * doc/Makefile.in: Regenerate.

diff --git a/libstdc++-v3/doc/Makefile.am b/libstdc++-v3/doc/Makefile.am
index cb9b68ffaea..2f8bb0770f3 100644
--- a/libstdc++-v3/doc/Makefile.am
+++ b/libstdc++-v3/doc/Makefile.am
@@ -256,12 +256,13 @@ stamp-latex-doxygen: ${doxygen_outdir}/latex
 # look at refman.log and see if TeX's memory is exhausted. Symptoms
 # include asking a wizard to enlarge capacity. If this is the case,
 # find texmf.cnf and add a zero for pool_size, string_vacancies,
-# max_strings, and pool_free values.
+# max_strings, and pool_free values. A much simpler workaround is to install
+# lualatex and set LATEX_CMD_NAME = lualatex in the doxygen user.cfg file.
 # Errors like "File `foo.sty' not found" mean a TeX package is missing.
 stamp-pdf-doxygen: stamp-latex-doxygen ${doxygen_outdir}/pdf
 	-(cd ${doxygen_outdir}/latex && $(MAKE) -i pdf;)
-	echo "Generating doxygen pdf file...";
-	if [ -f ${doxygen_pdf} ]; then \
+	@echo "Generating doxygen pdf file...";
+	@if [ -f ${doxygen_pdf} ]; then \
 	  mv ${doxygen_pdf} ${api_pdf} ; \
 	  echo ":: PDF file is ${api_pdf}"; \
 	else \

^ permalink raw reply	[flat|nested] only message in thread

only message in thread, other threads:[~2021-04-28 14:00 UTC | newest]

Thread overview: (only message) (download: mbox.gz / follow: Atom feed)
-- links below jump to the message on this page --
2021-04-28 13:59 [committed] libstdc++: Reduce output of 'make doc-pdf-doxygen' Jonathan Wakely

This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for read-only IMAP folder(s) and NNTP newsgroup(s).