diff mbox

invoke.texi: Sanitizer – update link, mention environment variables and link to wiki page with the flags

Message ID 52922CE2.100@net-b.de
State New
Headers show

Commit Message

Tobias Burnus Nov. 24, 2013, 4:44 p.m. UTC
As the subject says.

OK for the trunk?

Tobias

Comments

Konstantin Serebryany Nov. 24, 2013, 4:48 p.m. UTC | #1
I am not sure about the lsan part. Sergey?
The rest looks good.

On Sun, Nov 24, 2013 at 8:44 PM, Tobias Burnus <burnus@net-b.de> wrote:
> As the subject says.
>
> OK for the trunk?
>
> Tobias
diff mbox

Patch

2013-11-24  Tobias Burnus  <burnus@net-b.de>

	PR sanitizer/59275
	* doc/invoke.texi (-fsanitize=address,leak): Mention the associated
	environment variable and link to a list with flags.
	(-fsanitize=thread): Ditto and update link.

diff --git a/gcc/doc/invoke.texi b/gcc/doc/invoke.texi
index 568c90d..fbf111c 100644
--- a/gcc/doc/invoke.texi
+++ b/gcc/doc/invoke.texi
@@ -5261,14 +5261,20 @@  many times it is given.  This is mainly intended to be used with
 Enable AddressSanitizer, a fast memory error detector.
 Memory access instructions will be instrumented to detect
 out-of-bounds and use-after-free bugs.
-See @uref{http://code.google.com/p/address-sanitizer/} for more details.
+See @uref{http://code.google.com/p/address-sanitizer/} for
+more details.  The run-time behavior can be influenced using the
+@env{ASAN_OPTIONS} environment variable; see
+@url{https://code.google.com/p/address-sanitizer/wiki/Flags#Run-time_flags} for
+a list of supported options.
 
 @item -fsanitize=thread
 Enable ThreadSanitizer, a fast data race detector.
 Memory access instructions will be instrumented to detect
-data race bugs.
-See @uref{http://code.google.com/p/data-race-test/wiki/ThreadSanitizer} for
-more details.
+data race bugs.  See @uref{http://code.google.com/p/thread-sanitizer/} for more
+details. The run-time behavior can be influenced using the @env{TSAN_OPTIONS}
+environment variable; see
+@url{https://code.google.com/p/thread-sanitizer/wiki/Flags} for a list of
+supported options.
 
 @item -fsanitize=leak
 Enable LeakSanitizer, a memory leak detector.
@@ -5277,7 +5283,9 @@  This option only matters for linking of executables and if neither
 case it will link the executable against a library that overrides @code{malloc}
 and other allocator functions.  See
 @uref{https://code.google.com/p/address-sanitizer/wiki/LeakSanitizer} for more
-details.
+details.  The run-time behavior can be influenced using the
+@env{LSAN_OPTIONS} environment variable; see @option{-fsanitize=address}
+for the supported options.
 
 @item -fsanitize=undefined
 Enable UndefinedBehaviorSanitizer, a fast undefined behavior detector.