From patchwork Fri Feb 16 10:48:38 2024 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: Jonathan Wakely X-Patchwork-Id: 202079 Return-Path: Delivered-To: ouuuleilei@gmail.com Received: by 2002:a05:7300:c619:b0:108:e6aa:91d0 with SMTP id hn25csp428354dyb; Fri, 16 Feb 2024 02:51:00 -0800 (PST) X-Forwarded-Encrypted: i=3; AJvYcCW1kVzkB6qqLtgXhjXd28nFJbN6VTlhzuwzVtw2HV97DpXwQD63hFIBANLuXP+Kex5L9xiX0BEnUUqJ2RrEHrywmjAzHg== X-Google-Smtp-Source: AGHT+IGixcBjc+9Ve5EW0th559d3X7xHqWbmbocCX7a4m6Gldz4jJvcL8+nUVzZ6B6dZXbFcy9yx X-Received: by 2002:a05:620a:1095:b0:785:af71:be3f with SMTP id g21-20020a05620a109500b00785af71be3fmr4419364qkk.16.1708080660044; Fri, 16 Feb 2024 02:51:00 -0800 (PST) ARC-Seal: i=2; a=rsa-sha256; t=1708080660; cv=pass; d=google.com; s=arc-20160816; b=caPyMu9jc3AMzIVB/0BoswLoSPqmdEvR+pdilWZ0Ipi90VGD+nK23XGBzZEosOvPgB 8tnhYZw906xzyRUG4+bMHMiYlJx58V4jHIicNVZGbSjnegh5WZ6NXS2fqegJfwL8LdnR +TS6SvRoqJVtWmnGZQ1wEKs9PThCPbS6UqxqZkLdx5083OQl8OgiTKxFtS1JNRvvQ+Tg peRqW4oN1YjmW/pgLauBMJdWK+LiaAEgyFISaGzIwAhQm6eDwxOfM+JRNEhcgU5CpdCF OSnDxga2xvgZyfqEa6zHhodfXVwi26/rTKMiFIy8JdX352Yi4/q6ZnVfDYKNM7P+BB6w iZxQ== ARC-Message-Signature: i=2; a=rsa-sha256; c=relaxed/relaxed; d=google.com; s=arc-20160816; h=errors-to:list-subscribe:list-help:list-post:list-archive :list-unsubscribe:list-id:precedence:content-transfer-encoding :mime-version:message-id:date:subject:to:from:dkim-signature :arc-filter:dmarc-filter:delivered-to; bh=1wHe84bwsJvg9obIq88pjA3kzF/5PSUpViF9sV8b94A=; fh=sJ+2/4g29YdyXkoRrFZSpsL2zxijepB7X/1rB0LDDh8=; b=bpG3VWxEO0hWje8V7cmVFZ2PGcFTtD+/RJTcisyILAZ3oPZbIuwONxr0iYNhe1I6D1 ziORBvpiWcnMtiuI/ZY8Tm0bQoWOSUx5VIred5tO18Er22x8NPZnEvpnOBM3TkrzhUEj If6cSoMw371GYi07RZ8qKUzcT0PpNmLPBPQkP3XNd4Gpnm+RemF1C9wctxBya+lGPjam MJ6MRNRXqZXrzAw3ouQ6Aelt4dvYNBLRT2SJON17iaWfig3hoN+1KzmYtCaADiGWLMhr zVrL0aX8gm/Tr+vtQfKcUV4icfkQfKu1/gH1JsTyEy9nIkBq+AZp2hBQJXK5L0oJPBw7 RG3w==; dara=google.com ARC-Authentication-Results: i=2; mx.google.com; dkim=pass header.i=@redhat.com header.s=mimecast20190719 header.b="GhVS/wor"; arc=pass (i=1); spf=pass (google.com: domain of gcc-patches-bounces+ouuuleilei=gmail.com@gcc.gnu.org designates 2620:52:3:1:0:246e:9693:128c as permitted sender) smtp.mailfrom="gcc-patches-bounces+ouuuleilei=gmail.com@gcc.gnu.org"; dmarc=pass (p=NONE sp=NONE dis=NONE) header.from=redhat.com Received: from server2.sourceware.org (server2.sourceware.org. [2620:52:3:1:0:246e:9693:128c]) by mx.google.com with ESMTPS id x18-20020ae9e912000000b00786e8836d3esi3723951qkf.673.2024.02.16.02.50.59 for (version=TLS1_3 cipher=TLS_AES_256_GCM_SHA384 bits=256/256); Fri, 16 Feb 2024 02:51:00 -0800 (PST) Received-SPF: pass (google.com: domain of gcc-patches-bounces+ouuuleilei=gmail.com@gcc.gnu.org designates 2620:52:3:1:0:246e:9693:128c as permitted sender) client-ip=2620:52:3:1:0:246e:9693:128c; Authentication-Results: mx.google.com; dkim=pass header.i=@redhat.com header.s=mimecast20190719 header.b="GhVS/wor"; arc=pass (i=1); spf=pass (google.com: domain of gcc-patches-bounces+ouuuleilei=gmail.com@gcc.gnu.org designates 2620:52:3:1:0:246e:9693:128c as permitted sender) smtp.mailfrom="gcc-patches-bounces+ouuuleilei=gmail.com@gcc.gnu.org"; dmarc=pass (p=NONE sp=NONE dis=NONE) header.from=redhat.com Received: from server2.sourceware.org (localhost [IPv6:::1]) by sourceware.org (Postfix) with ESMTP id BF0203858285 for ; Fri, 16 Feb 2024 10:50:59 +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 ESMTPS id D4BF33858285 for ; Fri, 16 Feb 2024 10:48:46 +0000 (GMT) DMARC-Filter: OpenDMARC Filter v1.4.2 sourceware.org D4BF33858285 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 D4BF33858285 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=1708080528; cv=none; b=E914rmaOYMgw50WfK+np+b4RN8VuomQoxfEm9axUPOalbaKMvU/MMedLuA2jB52I4LTYuTMpEOBy7X+0ThUtFHjhe/tV2fn3T0PK8/c+EjkDKjwwKdUDtrAn1jmKiKbdXY4Ta2HO7RZRPH2VyLAYAMhfbNSS3SVVRk2Be4VUy+w= ARC-Message-Signature: i=1; a=rsa-sha256; d=sourceware.org; s=key; t=1708080528; c=relaxed/simple; bh=qhPCTCDxYO7LPCSTWVXblAbO3lMgt8gcKM0vD9oWASw=; h=DKIM-Signature:From:To:Subject:Date:Message-ID:MIME-Version; b=VTiieixhwqHZauHM1ebF8GzwFragseG6RXfevxjKgZbrhPWjx7gA9VA6hCJrKLSrOdgAXW3Ry+xEhLF26JLrYl0xbQEizML9ffTKV38MaOTEkxw2+FW9oVe6dbkvDzpPMV2M8LZuLUQGyIK3IZoo/rERIfaJqN8d2scz9S8Js98= ARC-Authentication-Results: i=1; server2.sourceware.org DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=redhat.com; s=mimecast20190719; t=1708080526; 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=1wHe84bwsJvg9obIq88pjA3kzF/5PSUpViF9sV8b94A=; b=GhVS/wora+vZQKm1sdkw87zC5PP7HIiB3ojhmMm4qJBVB63Z8TeNFuC7u/3o6fT1ZczG23 7urkAdq6BqrFbXBDJbBrxnNM4PUUtuu/hJtmA7CJH3JkEB1VK44IifX+osWWX3GKeKJK/i bUJ+3EkvFaUDm+exgeoHLg3ArC2CY9w= Received: from mimecast-mx02.redhat.com (mx-ext.redhat.com [66.187.233.73]) by relay.mimecast.com with ESMTP with STARTTLS (version=TLSv1.3, cipher=TLS_AES_256_GCM_SHA384) id us-mta-512-2zE24vjEOrq4oOaDs68grg-1; Fri, 16 Feb 2024 05:48:44 -0500 X-MC-Unique: 2zE24vjEOrq4oOaDs68grg-1 Received: from smtp.corp.redhat.com (int-mx05.intmail.prod.int.rdu2.redhat.com [10.11.54.5]) (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 mimecast-mx02.redhat.com (Postfix) with ESMTPS id 7A3D33C000BC; Fri, 16 Feb 2024 10:48:44 +0000 (UTC) Received: from localhost (unknown [10.42.28.206]) by smtp.corp.redhat.com (Postfix) with ESMTP id 480D68CED; Fri, 16 Feb 2024 10:48:44 +0000 (UTC) From: Jonathan Wakely 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 Message-ID: <20240216104843.147957-1-jwakely@redhat.com> MIME-Version: 1.0 X-Scanned-By: MIMEDefang 3.4.1 on 10.11.54.5 X-Mimecast-Spam-Score: 0 X-Mimecast-Originator: redhat.com X-Spam-Status: No, score=-12.3 required=5.0 tests=BAYES_00, DKIMWL_WL_HIGH, DKIM_SIGNED, DKIM_VALID, DKIM_VALID_AU, DKIM_VALID_EF, GIT_PATCH_0, RCVD_IN_DNSWL_NONE, RCVD_IN_MSPIKE_H4, RCVD_IN_MSPIKE_WL, 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+ouuuleilei=gmail.com@gcc.gnu.org X-getmail-retrieved-from-mailbox: INBOX X-GMAIL-THRID: 1791052386166121513 X-GMAIL-MSGID: 1791052386166121513 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 GLIBCXX_DEBUG_MESSAGE_LENGTH can be used to request a different length.

Note that libstdc++ is able to produce backtraces on error. - It requires that you configure libstdc++ build with - --enable-libstdcxx-backtrace=yes. - Use -D_GLIBCXX_DEBUG_BACKTRACE to activate it. - You'll then have to link with libstdc++_libbacktrace static library - (-lstdc++_libbacktrace) to build your application.

Using a Specific Debug Container

When it is not feasible to recompile your entire application, or + To enable these, compile with -D_GLIBCXX_DEBUG_BACKTRACE + and then link with -lstdc++exp. + These backtraces are not supported on all platforms. +

Using a Specific Debug Container

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. Note that libstdc++ is able to produce backtraces on error. - It requires that you configure libstdc++ build with - . - Use -D_GLIBCXX_DEBUG_BACKTRACE to activate it. - You'll then have to link against libstdc++exp static library - () to build your application. + To enable these, compile with -D_GLIBCXX_DEBUG_BACKTRACE + and then link with . + These backtraces are not supported on all platforms. +

Using a Specific Debug Container