From a523d1b46beb75150094dafd82cb065bd7cec463 Mon Sep 17 00:00:00 2001 From: Jonathan Wakely Date: Fri, 23 Aug 2024 21:32:14 +0100 Subject: [PATCH] libstdc++: Update and clarify Doxygen version requirements in manual There are lots of bugs that affect libstdc++ output from Doxygen, so using 1.9.6 or later is recommended. Give a lower minimum, because some distros still use 1.9.1 and that will work, albeit suboptimally. libstdc++-v3/ChangeLog: * doc/xml/manual/documentation_hacking.xml: Update minimum Doxygen version. * doc/html/*: Regenerate. --- libstdc++-v3/doc/html/manual/debug.html | 2 +- libstdc++-v3/doc/html/manual/documentation_hacking.html | 5 +++-- libstdc++-v3/doc/html/manual/setup.html | 3 +-- libstdc++-v3/doc/html/manual/using_exceptions.html | 4 ++-- libstdc++-v3/doc/html/manual/using_headers.html | 2 +- libstdc++-v3/doc/xml/manual/documentation_hacking.xml | 5 +++-- 6 files changed, 11 insertions(+), 10 deletions(-) diff --git a/libstdc++-v3/doc/html/manual/debug.html b/libstdc++-v3/doc/html/manual/debug.html index a5f51569e008..1623cd304867 100644 --- a/libstdc++-v3/doc/html/manual/debug.html +++ b/libstdc++-v3/doc/html/manual/debug.html @@ -250,4 +250,4 @@ with C++11 and later standards. They might be removed at a future date.

Prev Up Next
Exceptions Home Part II.  Standard Contents -
+ \ No newline at end of file diff --git a/libstdc++-v3/doc/html/manual/documentation_hacking.html b/libstdc++-v3/doc/html/manual/documentation_hacking.html index 047a62e0831e..6b462b44acf4 100644 --- a/libstdc++-v3/doc/html/manual/documentation_hacking.html +++ b/libstdc++-v3/doc/html/manual/documentation_hacking.html @@ -112,9 +112,10 @@ supported, and are always aliased to dummy rules. These unsupported formats are: info, ps, and dvi. -

Doxygen

Prerequisites

Table B.1. Doxygen Prerequisites

ToolVersionRequired By
coreutils8.5all
bash4.1all
doxygen1.7.6.1all
graphviz2.26graphical hierarchies
pdflatex2007-59pdf output

+

Doxygen

Prerequisites

Table B.1. Doxygen Prerequisites

ToolVersionRequired By
coreutils8.5all
bash4.1all
doxygen1.9.1all
graphviz2.26graphical hierarchies
pdflatex2007-59pdf output

Prerequisite tools are Bash 2.0 or later, - Doxygen, and + Doxygen + 1.9.1 or later (for best results use at least 1.9.6), and the GNU coreutils. (GNU versions of find, xargs, and possibly sed and grep are used, just because the GNU versions make diff --git a/libstdc++-v3/doc/html/manual/setup.html b/libstdc++-v3/doc/html/manual/setup.html index d8c5ff65cffe..67bb6c108a1b 100644 --- a/libstdc++-v3/doc/html/manual/setup.html +++ b/libstdc++-v3/doc/html/manual/setup.html @@ -22,8 +22,7 @@ Because libstdc++ is part of GCC, the primary source for installation instructions is the GCC install page. - In particular, the list of prerequisite software needed to build - the library + In particular, list of prerequisite software needed to build the library starts with those requirements. The same pages also list the tools you will need if you wish to modify the source. diff --git a/libstdc++-v3/doc/html/manual/using_exceptions.html b/libstdc++-v3/doc/html/manual/using_exceptions.html index f3556ef9d755..706b27e14793 100644 --- a/libstdc++-v3/doc/html/manual/using_exceptions.html +++ b/libstdc++-v3/doc/html/manual/using_exceptions.html @@ -166,8 +166,8 @@ exception neutrality and exception safety. implicitly generated magic necessary to support try and catch blocks and thrown objects. (Language support - for -fno-exceptions is documented in the GNU - GCC manual.) + for -fno-exceptions is documented in the GCC + manual.)

Before detailing the library support for -fno-exceptions, first a passing note on the things lost when this flag is used: it will break exceptions diff --git a/libstdc++-v3/doc/html/manual/using_headers.html b/libstdc++-v3/doc/html/manual/using_headers.html index 5f6698626541..49a826143441 100644 --- a/libstdc++-v3/doc/html/manual/using_headers.html +++ b/libstdc++-v3/doc/html/manual/using_headers.html @@ -186,5 +186,5 @@ g++ -Winvalid-pch -I. -include stdc++.h -H -g -O2 hello.cc -o test.exe ! ./stdc++.h.gch . /mnt/share/bld/H-x86-gcc.20071201/include/c++/4.3.0/iostream . /mnt/share/bld/H-x86-gcc.20071201include/c++/4.3.0/string -

The exclamation point to the left of the stdc++.h.gch listing means that the generated PCH file was used.

Detailed information about creating precompiled header files can be found in the GCC documentation. +

The exclamation point to the left of the stdc++.h.gch listing means that the generated PCH file was used.

Detailed information about creating precompiled header files can be found in the GCC documentation.

Prev Up Next
Chapter 3. Using Home Macros
\ No newline at end of file diff --git a/libstdc++-v3/doc/xml/manual/documentation_hacking.xml b/libstdc++-v3/doc/xml/manual/documentation_hacking.xml index 692b724ca113..ffd0fc7f5681 100644 --- a/libstdc++-v3/doc/xml/manual/documentation_hacking.xml +++ b/libstdc++-v3/doc/xml/manual/documentation_hacking.xml @@ -238,7 +238,7 @@ doxygen - 1.7.6.1 + 1.9.1 all @@ -261,7 +261,8 @@ Prerequisite tools are Bash 2.0 or later, - Doxygen, and + Doxygen + 1.9.1 or later (for best results use at least 1.9.6), and the GNU coreutils. (GNU versions of find, xargs, and possibly sed and grep are used, just because the GNU versions make -- 2.47.2