docs: Fix wording describing the hwaddress sanitizer
authorMatthew Malcomson <matthew.malcomson@arm.com>
Mon, 4 Jan 2021 12:06:27 +0000 (12:06 +0000)
committerMatthew Malcomson <matthew.malcomson@arm.com>
Mon, 4 Jan 2021 12:06:27 +0000 (12:06 +0000)
The original documentation added to mention the clash between
-fsanitize=address and -fsanitize=hwaddress used confusing wording trying
to say that -fsanitize=hwaddress is only available on AArch64.

It read as if -fsanitize=address were only supported on AArch64.

This patch fixes that wording by being more explicit.

gcc/ChangeLog:

PR other/98437
* doc/invoke.texi (-fsanitize=address): Fix wording describing
clash with -fsanitize=hwaddress.

gcc/doc/invoke.texi

index 97aea535d900c0145340cc7af9141097ca1cc492..b378e63d6bce12d4dd9293e4c88039298daac9e8 100644 (file)
@@ -14672,8 +14672,8 @@ the available options are shown at startup of the instrumented program.  See
 @url{https://github.com/google/sanitizers/wiki/AddressSanitizerFlags#run-time-flags}
 for a list of supported options.
 The option cannot be combined with @option{-fsanitize=thread} or
-@option{-fsanitize=hwaddress}.  Note that the only target this option is
-currently supported on is AArch64.
+@option{-fsanitize=hwaddress}.  Note that the only target
+@option{-fsanitize=hwaddress} is currently supported on is AArch64.
 
 @item -fsanitize=kernel-address
 @opindex fsanitize=kernel-address