From: Jonathan Wakely <jwakely@redhat.com>
Date: Fri, 16 Feb 2024 10:43:19 +0000 (+0000)
Subject: libstdc++: Improve docs for debug mode backtraces
X-Git-Tag: basepoints/gcc-15~1112
X-Git-Url: http://git.ipfire.org/?a=commitdiff_plain;h=1aef0a9b07766d100a218ef3e9576d0a0dd35a2d;p=thirdparty%2Fgcc.git

libstdc++: Improve docs for debug mode backtraces

The configure option is no longer necessary.

libstdc++-v3/ChangeLog:

	* doc/xml/manual/debug_mode.xml: Update docs for backtraces.
	* doc/html/manual/debug_mode_using.html: Regenerate.
---

diff --git a/libstdc++-v3/doc/html/manual/debug_mode_using.html b/libstdc++-v3/doc/html/manual/debug_mode_using.html
index e26d06c91799..70d6692f5140 100644
--- a/libstdc++-v3/doc/html/manual/debug_mode_using.html
+++ b/libstdc++-v3/doc/html/manual/debug_mode_using.html
@@ -10,11 +10,10 @@
   78 characters.  The environment variable
   <code class="code">GLIBCXX_DEBUG_MESSAGE_LENGTH</code> can be used to request a
   different length.</p><p>Note that libstdc++ is able to produce backtraces on error.
-  It requires that you configure libstdc++ build with
-  <code class="option">--enable-libstdcxx-backtrace=yes</code>.
-  Use <code class="code">-D_GLIBCXX_DEBUG_BACKTRACE</code> to activate it.
-  You'll then have to link with libstdc++_libbacktrace static library
-  (<code class="option">-lstdc++_libbacktrace</code>) to build your application.</p></div><div class="section"><div class="titlepage"><div><div><h3 class="title"><a id="debug_mode.using.specific"></a>Using a Specific Debug Container</h3></div></div></div><p>When it is not feasible to recompile your entire application, or
+  To enable these, compile with <code class="code">-D_GLIBCXX_DEBUG_BACKTRACE</code>
+  and then link with <code class="option">-lstdc++exp</code>.
+  These backtraces are not supported on all platforms.
+</p></div><div class="section"><div class="titlepage"><div><div><h3 class="title"><a id="debug_mode.using.specific"></a>Using a Specific Debug Container</h3></div></div></div><p>When it is not feasible to recompile your entire application, or
   only specific containers need checking, debugging containers are
   available as GNU extensions. These debugging containers are
   functionally equivalent to the standard drop-in containers used in
diff --git a/libstdc++-v3/doc/xml/manual/debug_mode.xml b/libstdc++-v3/doc/xml/manual/debug_mode.xml
index ac15ef6f6d07..a12158fa03ea 100644
--- a/libstdc++-v3/doc/xml/manual/debug_mode.xml
+++ b/libstdc++-v3/doc/xml/manual/debug_mode.xml
@@ -162,11 +162,10 @@ which always works correctly.
   different length.</para>
 
 <para>Note that libstdc++ is able to produce backtraces on error.
-  It requires that you configure libstdc++ build with
-  <option>--enable-libstdcxx-backtrace=yes</option>.
-  Use <code>-D_GLIBCXX_DEBUG_BACKTRACE</code> to activate it.
-  You'll then have to link against libstdc++exp static library
-  (<option>-lstdc++exp</option>) to build your application.</para>
+  To enable these, compile with <code>-D_GLIBCXX_DEBUG_BACKTRACE</code>
+  and then link with <option>-lstdc++exp</option>.
+  These backtraces are not supported on all platforms.
+</para>
 </section>
 
 <section xml:id="debug_mode.using.specific" xreflabel="Using Specific"><info><title>Using a Specific Debug Container</title></info>