Skip to content

Guide the user to doxygen_manual.log when building the manual PDF fails #10740

@ryandesign

Description

@ryandesign

Describe the bug
Building the manual PDF failed for me:

[100%] Generating Doxygen Manual PDF.
cd build/latex && /opt/local/bin/cmake -E remove refman.tex
cd build/latex && /opt/local/bin/cmake -E copy build/doc/manual.sty .
cd build/latex && /opt/local/bin/cmake -E copy doxygen-1.10.0/doc/doxygen_logo.pdf .
cd build/latex && /opt/local/bin/cmake -E chdir build/latex /opt/local/bin/python3.12 doxygen-1.10.0/doc/replace_version.py build/doc/doxygen_manual.tex build/latex/doxygen_manual.tex 1.10.0
cd build/latex && /opt/local/bin/cmake -E chdir build/latex /opt/local/bin/python3.12 doxygen-1.10.0/doc/replace_version.py build/doc/manual.sty build/latex/manual.sty 1.10.0
cd build/latex && /opt/local/bin/pdflatex -shell-escape doxygen_manual.tex
This is pdfTeX, Version 3.141592653-2.6-1.40.25 (TeX Live 2023/MacPorts 2023.66589_5) (preloaded format=pdflatex)
 \write18 enabled.
entering extended mode
(./doxygen_manual.tex
LaTeX2e <2022-11-01> patch level 1
L3 programming layer <2023-02-22>
make[3]: *** [doc/CMakeFiles/doxygen_pdf] Error 1

The reason why is not important; I'm sure it's just a missing dependency. The bug I'm reporting is that there is no information in the above output explaining what went wrong or where to go to figure that out. By searching your issue tracker, I found previous similar failures in which the user was asked to consult the file doxygen_manual.log. There is no mention of that file in the above output, nor anywhere in the doxygen source distribution that I can see.

Expected behavior
If a build fails and a logfile like doxygen_manual.log is generated whose contains may help the user understand why the build failed, the existence of that logfile should be communicated to the user in the error message.

Version
1.10.0

Metadata

Metadata

Assignees

No one assigned

    Labels

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions