From patchwork Thu Jun 30 10:34:31 2022 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: Xi Ruoyao X-Patchwork-Id: 1650676 Return-Path: X-Original-To: incoming@patchwork.ozlabs.org Delivered-To: patchwork-incoming@bilbo.ozlabs.org Authentication-Results: bilbo.ozlabs.org; dkim=pass (1024-bit key; unprotected) header.d=gcc.gnu.org header.i=@gcc.gnu.org header.a=rsa-sha256 header.s=default header.b=scRZMLXw; dkim-atps=neutral Authentication-Results: ozlabs.org; spf=pass (sender SPF authorized) smtp.mailfrom=gcc.gnu.org (client-ip=2620:52:3:1:0:246e:9693:128c; helo=sourceware.org; envelope-from=gcc-patches-bounces+incoming=patchwork.ozlabs.org@gcc.gnu.org; receiver=) Received: from sourceware.org (server2.sourceware.org [IPv6:2620:52:3:1:0:246e:9693:128c]) (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 bilbo.ozlabs.org (Postfix) with ESMTPS id 4LYZTf3Z8Tz9s07 for ; Thu, 30 Jun 2022 20:35:00 +1000 (AEST) Received: from server2.sourceware.org (localhost [IPv6:::1]) by sourceware.org (Postfix) with ESMTP id 2D87E386EC0E for ; Thu, 30 Jun 2022 10:34:57 +0000 (GMT) DKIM-Filter: OpenDKIM Filter v2.11.0 sourceware.org 2D87E386EC0E DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=gcc.gnu.org; s=default; t=1656585297; bh=LIg/fOdqUQ5yX98PT1gDcI3Dz6Yxkv5GABh3IWoe3A4=; h=Subject:To:Date:List-Id:List-Unsubscribe:List-Archive:List-Post: List-Help:List-Subscribe:From:Reply-To:From; b=scRZMLXwjTY308tiQI/BA3S7PmS3nzKHUwsbztVeGbfwtLiuRV0fRs91t/VDUjv9M VNq+XUiYaIjyRf2AtoOac9pt0pLMev5AaXbJ34qB2PjOy1+kiIgMdtqOsFOsifvzm7 inDlTJk+FlELtI87ZfSROWAmVELxntrbKpQwEmKg= X-Original-To: gcc-patches@gcc.gnu.org Delivered-To: gcc-patches@gcc.gnu.org Received: from xry111.site (xry111.site [IPv6:2001:470:683e::1]) by sourceware.org (Postfix) with ESMTPS id 056C6386DC50 for ; Thu, 30 Jun 2022 10:34:36 +0000 (GMT) DMARC-Filter: OpenDMARC Filter v1.4.1 sourceware.org 056C6386DC50 Received: from [192.168.124.21] (unknown [113.140.11.4]) (using TLSv1.3 with cipher TLS_AES_256_GCM_SHA384 (256/256 bits) key-exchange ECDHE (P-256) server-signature ECDSA (P-384) server-digest SHA384) (Client did not present a certificate) (Authenticated sender: xry111@xry111.site) by xry111.site (Postfix) with ESMTPSA id B134C668D3 for ; Thu, 30 Jun 2022 06:34:33 -0400 (EDT) Message-ID: Subject: doc: extend --{enable,disable}-libsanitizer description [PR 105614] To: gcc-patches@gcc.gnu.org Date: Thu, 30 Jun 2022 18:34:31 +0800 User-Agent: Evolution 3.44.2 MIME-Version: 1.0 X-Spam-Status: No, score=-5.8 required=5.0 tests=BAYES_00, DKIM_SIGNED, DKIM_VALID, DKIM_VALID_AU, DKIM_VALID_EF, FROM_SUSPICIOUS_NTLD, FROM_SUSPICIOUS_NTLD_FP, GIT_PATCH_0, LIKELY_SPAM_FROM, RCVD_IN_BARRACUDACENTRAL, SPF_HELO_PASS, SPF_PASS, TXREP, T_PDS_OTHER_BAD_TLD, 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.29 Precedence: list List-Id: Gcc-patches mailing list List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , X-Patchwork-Original-From: Xi Ruoyao via Gcc-patches From: Xi Ruoyao Reply-To: Xi Ruoyao Errors-To: gcc-patches-bounces+incoming=patchwork.ozlabs.org@gcc.gnu.org Sender: "Gcc-patches" A documentation improvement with no code change. OK for trunk? -- >8 -- We are receiving several reports that people are (mis)using --enable-libsanitizer option, which was not documented by GCC installation doc. It forces to build libsanitizer even for unsupported targets, causing build failure. Extend the --disable-libsanitizer description to also include --enable-libsanitizer, and warn about the possible consequences if it's enabled explicitly. gcc/ChangeLog: PR sanitizer/105614 * doc/install.texi: Document --enable-libsanitizer and possible consequences. --- gcc/doc/install.texi | 9 +++++++-- 1 file changed, 7 insertions(+), 2 deletions(-) diff --git a/gcc/doc/install.texi b/gcc/doc/install.texi index 460da3a0fd5..136ee24e450 100644 --- a/gcc/doc/install.texi +++ b/gcc/doc/install.texi @@ -1866,9 +1866,14 @@ be built. This can be useful for debugging, or for compatibility with previous Ada build procedures, when it was required to explicitly do a @samp{make -C gcc gnatlib_and_tools}. -@item --disable-libsanitizer +@item --enable-libsanitizer +@itemx --disable-libsanitizer Specify that the run-time libraries for the various sanitizers should -not be built. +(should not) be built. The default is @option{--enable-libsanitizer} +for targets where those libraries are tested and supported, +@option{--disable-libsanitizer} for other targets. Explicitly +requesting @option{--enable-libsanitizer} for unsupported targets may +cause build failure or runtime issues. @item --disable-libssp Specify that the run-time libraries for stack smashing protection