From patchwork Thu Oct 26 19:16:13 2023 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: Sam James X-Patchwork-Id: 1855964 Return-Path: X-Original-To: incoming@patchwork.ozlabs.org Delivered-To: patchwork-incoming@legolas.ozlabs.org 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 4SGbCD3PcBz23jV for ; Fri, 27 Oct 2023 06:17:12 +1100 (AEDT) Received: from server2.sourceware.org (localhost [IPv6:::1]) by sourceware.org (Postfix) with ESMTP id 7C82838323EA for ; Thu, 26 Oct 2023 19:17:10 +0000 (GMT) X-Original-To: gcc-patches@gcc.gnu.org Delivered-To: gcc-patches@gcc.gnu.org Received: from smtp.gentoo.org (woodpecker.gentoo.org [140.211.166.183]) by sourceware.org (Postfix) with ESMTP id 3443E3831E0F for ; Thu, 26 Oct 2023 19:16:58 +0000 (GMT) DMARC-Filter: OpenDMARC Filter v1.4.2 sourceware.org 3443E3831E0F Authentication-Results: sourceware.org; dmarc=pass (p=none dis=none) header.from=gentoo.org Authentication-Results: sourceware.org; spf=pass smtp.mailfrom=gentoo.org ARC-Filter: OpenARC Filter v1.0.0 sourceware.org 3443E3831E0F Authentication-Results: server2.sourceware.org; arc=none smtp.remote-ip=140.211.166.183 ARC-Seal: i=1; a=rsa-sha256; d=sourceware.org; s=key; t=1698347820; cv=none; b=vagxXe0Foj0JZ9lt+H2q2AKXpFkw19h4nx6esavTTw/rCad9SXNpNLCUSm4O900Fb5rF825f2G6N+ZczPf9Syzo5OQ5OIhNx/RNxSNyBMuzm7hWn/TzqrJSZP5s9eVL0tTMFgSNwJxpZVJicWQRZ9XUhPNGqotR2Y4AfZYWYTNc= ARC-Message-Signature: i=1; a=rsa-sha256; d=sourceware.org; s=key; t=1698347820; c=relaxed/simple; bh=HgR3x5woe5SLzAxImqlOxLsQ+GpiIiVuHR4drIT3pUw=; h=From:To:Subject:Date:Message-ID:MIME-Version; b=hRYeAT56FLS2Y7WnnDi2tPstAGtgR2heD1ZJo8pvr6n369X5w5x8Orsux87nnVsm79kXDErYYv86egaTC0qDSpPpB9Mi3Q8YSlMoHevsSJBZiVGkKAOdzfEc836gik0n+Idu4yZUO4+LZYwTbjF1uFsR8qi2zHQo8+BiZJy9+2c= ARC-Authentication-Results: i=1; server2.sourceware.org From: Sam James To: gcc-patches@gcc.gnu.org Cc: gerald@pfeifer.com, jwakely@redhat.com, Sam James Subject: [PATCH htdocs v2] bugs: Mention -D_GLIBCXX_ASSERTIONS and -D_GLIBCXX_DEBUG Date: Thu, 26 Oct 2023 20:16:13 +0100 Message-ID: <20231026191628.196706-1-sam@gentoo.org> X-Mailer: git-send-email 2.42.0 MIME-Version: 1.0 X-Spam-Status: No, score=-9.9 required=5.0 tests=BAYES_00, GIT_PATCH_0, JMQ_SPF_NEUTRAL, KAM_DMARC_STATUS, RCVD_IN_MSPIKE_H3, RCVD_IN_MSPIKE_WL, SPF_HELO_PASS, SPF_PASS, TXREP 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 These options both enabled more checking within the C++ standard library and can expose errors in submitted code. -D_GLIBCXX_DEBUG is mentioned separately because while we want people to try it, it's not always feasible because it requires the whole program and any used libraries to also be built with it (as it breaks ABI). Signed-off-by: Sam James --- v2: Improve phrasing for the types of checks and be less scornful about ABI changes. htdocs/bugs/index.html | 7 +++++++ 1 file changed, 7 insertions(+) diff --git a/htdocs/bugs/index.html b/htdocs/bugs/index.html index da3d4c0d..162d846a 100644 --- a/htdocs/bugs/index.html +++ b/htdocs/bugs/index.html @@ -56,6 +56,13 @@ makes a difference, or if compiling with -fsanitize=undefined produces any run-time errors, then your code is probably not correct.

+

We also ask that for C++ code, users test their programs with +-D_GLIBCXX_ASSERTIONS. If you're able to rebuild the entire +program (including any libraries it uses, because it changes ABI), please do try +-D_GLIBCXX_DEBUG which enables more thorough checking in parts of +the C++ standard library. If either of these fail, this is a strong indicator +of an error in your code.

+

Summarized bug reporting instructions

After this summary, you'll find detailed instructions that explain