From: Diane Meirowitz <diane.meirowitz@oracle.com>
Date: Wed, 15 Sep 2021 21:03:00 +0000 (+0000)
Subject: doc: improve -fsanitize=undefined description
X-Git-Tag: releases/gcc-11.3.0~798
X-Git-Url: http://git.ipfire.org/cgi-bin/gitweb.cgi?a=commitdiff_plain;h=b7c46a1d1ce1b29cc5c78d91d83a82c6a488bde7;p=thirdparty%2Fgcc.git

doc: improve -fsanitize=undefined description

gcc/ChangeLog:
	* doc/invoke.texi: Add link to UndefinedBehaviorSanitizer
	documentation, mention UBSAN_OPTIONS, similar to what is done
	for AddressSanitizer.

(cherry picked from commit 1c0a83eff7bb5b1db997a9726ae6542aec893baa)
---

diff --git a/gcc/doc/invoke.texi b/gcc/doc/invoke.texi
index 6fb740bacd38..eae00f879182 100644
--- a/gcc/doc/invoke.texi
+++ b/gcc/doc/invoke.texi
@@ -14837,7 +14837,8 @@ The option cannot be combined with @option{-fsanitize=thread}.
 @opindex fsanitize=undefined
 Enable UndefinedBehaviorSanitizer, a fast undefined behavior detector.
 Various computations are instrumented to detect undefined behavior
-at runtime.  Current suboptions are:
+at runtime.  See @uref{https://clang.llvm.org/docs/UndefinedBehaviorSanitizer.html} for more details.   The run-time behavior can be influenced using the
+@env{UBSAN_OPTIONS} environment variable.  Current suboptions are:
 
 @table @gcctabopt