[Bug sanitizer/67204] New: documentation for sanitizer missing/incomplete

2015-08-13 Thread smagnet at yopmail dot com
https://gcc.gnu.org/bugzilla/show_bug.cgi?id=67204

Bug ID: 67204
   Summary: documentation for sanitizer missing/incomplete
   Product: gcc
   Version: unknown
Status: UNCONFIRMED
  Severity: normal
  Priority: P3
 Component: sanitizer
  Assignee: unassigned at gcc dot gnu.org
  Reporter: smagnet at yopmail dot com
CC: dodji at gcc dot gnu.org, dvyukov at gcc dot gnu.org,
jakub at gcc dot gnu.org, kcc at gcc dot gnu.org
  Target Milestone: ---

The GCC manual contains next to no documentation about the use of the various
-fsanitize options.

At the moment, the best source of information are 3rd party sites like the
google AddressSanitizer wiki
<https://code.google.com/p/address-sanitizer/wiki/AddressSanitizer> which refer
primarily to LLVM/Clang; it's not clear how applicable they are to the current
sanitizer implementations in GCC.

The GCC manual should contain a proper description of the sanitizer
functionality.


[Bug sanitizer/67204] documentation for sanitizer missing/incomplete

2015-08-13 Thread smagnet at yopmail dot com
https://gcc.gnu.org/bugzilla/show_bug.cgi?id=67204

--- Comment #3 from smagnet at yopmail dot com ---
> https://gcc.gnu.org/onlinedocs/gcc/Debugging-Options.html#Debugging-Options
> What exactly are you missing?

Basically, I think the information from the address sanitizer wiki (and the
other linked pages) should be integrated into the GCC manual, rather than the
manual referring to the wiki, such that the manual is self-contained.

The google code wiki only refers to LLVM, and it's not clear to the reader (to
me at least) if it is still being maintained (given that "Google Code will be
turning read-only") and to what extent it applies to GCC.

Moreover, the undefined behavior sanitizer runtime options (UBSAN_OPTIONS, as
described here
<https://www.chromium.org/developers/testing/undefinedbehaviorsanitizer>)
aren't documented at all in the manual.