public inbox for libstdc++@gcc.gnu.org
 help / color / mirror / Atom feed
From: Jonathan Wakely <jwakely@redhat.com>
To: libstdc++@gcc.gnu.org, gcc-patches@gcc.gnu.org
Subject: [committed] libstdc++: Improve docs for debug mode backtraces
Date: Fri, 16 Feb 2024 10:48:38 +0000	[thread overview]
Message-ID: <20240216104843.147957-1-jwakely@redhat.com> (raw)

Pushed to trunk.

-- >8 --

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.
---
 libstdc++-v3/doc/html/manual/debug_mode_using.html | 9 ++++-----
 libstdc++-v3/doc/xml/manual/debug_mode.xml         | 9 ++++-----
 2 files changed, 8 insertions(+), 10 deletions(-)

diff --git a/libstdc++-v3/doc/html/manual/debug_mode_using.html b/libstdc++-v3/doc/html/manual/debug_mode_using.html
index e26d06c9179..70d6692f514 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 ac15ef6f6d0..a12158fa03e 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>
-- 
2.43.0


                 reply	other threads:[~2024-02-16 10:48 UTC|newest]

Thread overview: [no followups] expand[flat|nested]  mbox.gz  Atom feed

Reply instructions:

You may reply publicly to this message via plain-text email
using any one of the following methods:

* Save the following mbox file, import it into your mail client,
  and reply-to-all from there: mbox

  Avoid top-posting and favor interleaved quoting:
  https://en.wikipedia.org/wiki/Posting_style#Interleaved_style

* Reply using the --to, --cc, and --in-reply-to
  switches of git-send-email(1):

  git send-email \
    --in-reply-to=20240216104843.147957-1-jwakely@redhat.com \
    --to=jwakely@redhat.com \
    --cc=gcc-patches@gcc.gnu.org \
    --cc=libstdc++@gcc.gnu.org \
    /path/to/YOUR_REPLY

  https://kernel.org/pub/software/scm/git/docs/git-send-email.html

* If your mail client supports setting the In-Reply-To header
  via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line before the message body.
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).