public inbox for gcc-patches@gcc.gnu.org
 help / color / mirror / Atom feed
From: Xi Ruoyao <xry111@xry111.site>
To: gcc-patches@gcc.gnu.org
Subject: doc: extend --{enable,disable}-libsanitizer description [PR 105614]
Date: Thu, 30 Jun 2022 18:34:31 +0800	[thread overview]
Message-ID: <c92b41f5883f997abc5dad5aee37c4a87edeb06d.camel@xry111.site> (raw)

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
-- 
2.37.0



             reply	other threads:[~2022-06-30 10:34 UTC|newest]

Thread overview: 2+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2022-06-30 10:34 Xi Ruoyao [this message]
2022-06-30 11:54 ` Rainer Orth

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=c92b41f5883f997abc5dad5aee37c4a87edeb06d.camel@xry111.site \
    --to=xry111@xry111.site \
    --cc=gcc-patches@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).