From patchwork Fri Aug 23 21:11:40 2024 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 8bit X-Patchwork-Submitter: Jonathan Wakely X-Patchwork-Id: 1976292 Return-Path: X-Original-To: incoming@patchwork.ozlabs.org Delivered-To: patchwork-incoming@legolas.ozlabs.org Authentication-Results: legolas.ozlabs.org; dkim=pass (1024-bit key; unprotected) header.d=redhat.com header.i=@redhat.com header.a=rsa-sha256 header.s=mimecast20190719 header.b=SDWBha8C; dkim-atps=neutral Authentication-Results: legolas.ozlabs.org; spf=pass (sender SPF authorized) smtp.mailfrom=gcc.gnu.org (client-ip=8.43.85.97; helo=server2.sourceware.org; envelope-from=gcc-patches-bounces~incoming=patchwork.ozlabs.org@gcc.gnu.org; receiver=patchwork.ozlabs.org) Received: from server2.sourceware.org (server2.sourceware.org [8.43.85.97]) (using TLSv1.3 with cipher TLS_AES_256_GCM_SHA384 (256/256 bits) key-exchange X25519 server-signature ECDSA (secp384r1) server-digest SHA384) (No client certificate requested) by legolas.ozlabs.org (Postfix) with ESMTPS id 4WrCT75KXhz1yXd for ; Sat, 24 Aug 2024 07:12:43 +1000 (AEST) Received: from server2.sourceware.org (localhost [IPv6:::1]) by sourceware.org (Postfix) with ESMTP id 7C0163882043 for ; Fri, 23 Aug 2024 21:12:41 +0000 (GMT) X-Original-To: gcc-patches@gcc.gnu.org Delivered-To: gcc-patches@gcc.gnu.org Received: from us-smtp-delivery-124.mimecast.com (us-smtp-delivery-124.mimecast.com [170.10.133.124]) by sourceware.org (Postfix) with ESMTP id 6C53D3861030 for ; Fri, 23 Aug 2024 21:12:00 +0000 (GMT) DMARC-Filter: OpenDMARC Filter v1.4.2 sourceware.org 6C53D3861030 Authentication-Results: sourceware.org; dmarc=pass (p=none dis=none) header.from=redhat.com Authentication-Results: sourceware.org; spf=pass smtp.mailfrom=redhat.com ARC-Filter: OpenARC Filter v1.0.0 sourceware.org 6C53D3861030 Authentication-Results: server2.sourceware.org; arc=none smtp.remote-ip=170.10.133.124 ARC-Seal: i=1; a=rsa-sha256; d=sourceware.org; s=key; t=1724447525; cv=none; b=FWeQjoC5OFWQXsaQbWzdD8C0DX8N2GT7dZYAGCWksAcr0oMYpRGFgGirAu7SfS0aiJ0z7RAGBS3yJ9DyZW4ZfOZ1ZwVmzUNtEWVCizXJrZ2GRGk3iGyd/QQAkh8c+R6qHu8gizwDK5rM/FKRXT3JDvngHNskLXuF5iuu7MhDbNU= ARC-Message-Signature: i=1; a=rsa-sha256; d=sourceware.org; s=key; t=1724447525; c=relaxed/simple; bh=ku0ky4ELdDo9xmHnNUKjP+h4EwQ55XeAvRiJ4gtC/rA=; h=DKIM-Signature:From:To:Subject:Date:Message-ID:MIME-Version; b=xbNDfUE4e7nD8folU5r3LJCY0NFnmhITktZ+Y6gWfFbFdSknuE5EXH/8pzUCKRf5NfZJe5ytl+js74JQdCDPXcjtqtv/iQnOHu5oM/a8oLmbJ1qbkUALjvn3Cbei3xTMYZy5B1MpMJXWa6B//k2Z01IzQQJwO4L3LDl0FLkzZ5Q= ARC-Authentication-Results: i=1; server2.sourceware.org DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=redhat.com; s=mimecast20190719; t=1724447520; h=from:from:reply-to:subject:subject:date:date:message-id:message-id: to:to:cc:mime-version:mime-version:content-type:content-type: content-transfer-encoding:content-transfer-encoding; bh=F1jL4l57ET3ueItciPpseUjI2vv2wdDXMBFSKaUPQso=; b=SDWBha8C3if/U09yhBzKr8H5Gh/Ci/0DSMzOQNrmgvxCMRiJ/WbMePa2UbBIs0g4WPcgaV waX65mvn7aiRuO0Zt/eumpMtVZwQhMem/RQChL78tDfeH7+osxONwT9KDcNNL+JmN7AloD qIijJ1YcC3NudIgS+VkEiCcuOQA//+M= Received: from mx-prod-mc-01.mail-002.prod.us-west-2.aws.redhat.com (ec2-54-186-198-63.us-west-2.compute.amazonaws.com [54.186.198.63]) by relay.mimecast.com with ESMTP with STARTTLS (version=TLSv1.3, cipher=TLS_AES_256_GCM_SHA384) id us-mta-564-5C2q_JMINmeFGjh_fPv3AA-1; Fri, 23 Aug 2024 17:11:58 -0400 X-MC-Unique: 5C2q_JMINmeFGjh_fPv3AA-1 Received: from mx-prod-int-02.mail-002.prod.us-west-2.aws.redhat.com (mx-prod-int-02.mail-002.prod.us-west-2.aws.redhat.com [10.30.177.15]) (using TLSv1.3 with cipher TLS_AES_256_GCM_SHA384 (256/256 bits) key-exchange X25519 server-signature RSA-PSS (2048 bits) server-digest SHA256) (No client certificate requested) by mx-prod-mc-01.mail-002.prod.us-west-2.aws.redhat.com (Postfix) with ESMTPS id 0A3C41955BED; Fri, 23 Aug 2024 21:11:57 +0000 (UTC) Received: from localhost (unknown [10.42.28.41]) by mx-prod-int-02.mail-002.prod.us-west-2.aws.redhat.com (Postfix) with ESMTP id 073061955E8C; Fri, 23 Aug 2024 21:11:55 +0000 (UTC) From: Jonathan Wakely To: libstdc++@gcc.gnu.org, gcc-patches@gcc.gnu.org Subject: [committed] libstdc++: Update and clarify Doxygen version requirements in manual Date: Fri, 23 Aug 2024 22:11:40 +0100 Message-ID: <20240823211154.1039672-1-jwakely@redhat.com> MIME-Version: 1.0 X-Scanned-By: MIMEDefang 3.0 on 10.30.177.15 X-Mimecast-Spam-Score: 0 X-Mimecast-Originator: redhat.com X-Spam-Status: No, score=-10.5 required=5.0 tests=BAYES_00, DKIMWL_WL_HIGH, DKIM_SIGNED, DKIM_VALID, DKIM_VALID_AU, DKIM_VALID_EF, GIT_PATCH_0, KAM_SHORT, RCVD_IN_DNSWL_NONE, RCVD_IN_MSPIKE_H4, RCVD_IN_MSPIKE_WL, RCVD_IN_SBL_CSS, SPF_HELO_NONE, SPF_NONE, TXREP, T_SCC_BODY_TEXT_LINE autolearn=ham autolearn_force=no version=3.4.6 X-Spam-Checker-Version: SpamAssassin 3.4.6 (2021-04-09) on server2.sourceware.org X-BeenThere: gcc-patches@gcc.gnu.org X-Mailman-Version: 2.1.30 Precedence: list List-Id: Gcc-patches mailing list List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , Errors-To: gcc-patches-bounces~incoming=patchwork.ozlabs.org@gcc.gnu.org Pushed to trunk. -- >8 -- 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 a5f51569e00..1623cd30486 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 047a62e0831..6b462b44acf 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 d8c5ff65cff..67bb6c108a1 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 f3556ef9d75..706b27e1479 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 5f669862654..49a82614344 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 692b724ca11..ffd0fc7f568 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