[1/2] wwwdocs: Group sanitiser changes together

Message ID mpt5yp7i69j.fsf@arm.com
State New
Headers
Series [1/2] wwwdocs: Group sanitiser changes together |

Commit Message

Richard Sandiford Feb. 22, 2022, 9:45 a.m. UTC
  Group the ThreadSanitizer and HardwareAssistedAddressSanitizer
changes under a single top-level bullet point.  This makes it
easier to add a third sanitiser-related change.

No (intended) change to the actual text or wording.  (TBH I don't
understand the ThreadSanitizer bit: is it describing three changes
(KCSAN + two new options), four changes (other environments),
or one big inter-related change?)

OK to install?

Richard

---
 htdocs/gcc-11/changes.html | 63 ++++++++++++++++++++++----------------
 1 file changed, 36 insertions(+), 27 deletions(-)
  

Comments

Richard Sandiford Feb. 22, 2022, 9:49 a.m. UTC | #1
Richard Sandiford <richard.sandiford@arm.com> writes:
> Group the ThreadSanitizer and HardwareAssistedAddressSanitizer
> changes under a single top-level bullet point.  This makes it
> easier to add a third sanitiser-related change.
>
> No (intended) change to the actual text or wording.  (TBH I don't
> understand the ThreadSanitizer bit: is it describing three changes
> (KCSAN + two new options), four changes (other environments),
> or one big inter-related change?)
>
> OK to install?

Err, scratch that.  Clearly I've not had tea this morning, and forgot
which version we're about to release :-)

Richard

>
> Richard
>
> ---
>  htdocs/gcc-11/changes.html | 63 ++++++++++++++++++++++----------------
>  1 file changed, 36 insertions(+), 27 deletions(-)
>
> diff --git a/htdocs/gcc-11/changes.html b/htdocs/gcc-11/changes.html
> index 8e6d4ec8..cc3ae989 100644
> --- a/htdocs/gcc-11/changes.html
> +++ b/htdocs/gcc-11/changes.html
> @@ -69,18 +69,6 @@ You may also want to check out our
>  <h2 id="general">General Improvements</h2>
>  
>  <ul>
> -  <li>
> -    <a href="https://github.com/google/sanitizers/wiki/ThreadSanitizerCppManual">
> -    ThreadSanitizer</a> improvements to support alternative runtimes and
> -    environments. The <a href="https://www.kernel.org/doc/html/latest/dev-tools/kcsan.html">
> -    Linux Kernel Concurrency Sanitizer (KCSAN)</a> is now supported.
> -    <ul>
> -      <li>Add <code>--param tsan-distinguish-volatile</code> to optionally emit
> -          instrumentation distinguishing volatile accesses.</li>
> -      <li>Add <code>--param tsan-instrument-func-entry-exit</code> to optionally
> -          control if function entries and exits should be instrumented.</li>
> -    </ul>
> -  </li>
>    <li>
>      <p>
>        In previous releases of GCC, the "column numbers" emitted in diagnostics
> @@ -121,22 +109,43 @@ You may also want to check out our
>      </p>
>    </li>
>    <li>
> -    <p>
> -    Introduce <a href="https://clang.llvm.org/docs/HardwareAssistedAddressSanitizerDesign.html">
> -      Hardware-assisted AddressSanitizer</a> support.  This sanitizer currently
> -    only works for the AArch64 target.  It helps debug address problems
> -    similarly to
> -    <a href="https://github.com/google/sanitizers/wiki/AddressSanitizer">
> -      AddressSanitizer</a> but is based on partial hardware assistance and
> -    provides probabilistic protection to use less RAM at run time.
> -    <a href="https://clang.llvm.org/docs/HardwareAssistedAddressSanitizerDesign.html">
> -      Hardware-assisted AddressSanitizer</a> is not production-ready for user
> -    space, and is provided mainly for use compiling the Linux Kernel.
> -    </p>
> -    To use this sanitizer the command line arguments are:
> +    Sanitizer improvements:
>      <ul>
> -      <li><code>-fsanitize=hwaddress</code> to instrument userspace code.</li>
> -      <li><code>-fsanitize=kernel-hwaddress</code> to instrument kernel code.</li>
> +      <li>
> +	<a href="https://github.com/google/sanitizers/wiki/ThreadSanitizerCppManual">
> +	ThreadSanitizer</a> improvements to support alternative runtimes
> +	and environments.  The
> +	<a href="https://www.kernel.org/doc/html/latest/dev-tools/kcsan.html">
> +	Linux Kernel Concurrency Sanitizer (KCSAN)</a> is now supported.
> +	<ul>
> +	  <li>Add <code>--param tsan-distinguish-volatile</code> to optionally
> +	      emit instrumentation distinguishing volatile accesses.</li>
> +	  <li>Add <code>--param tsan-instrument-func-entry-exit</code> to
> +	      optionally control if function entries and exits should be
> +	      instrumented.</li>
> +	</ul>
> +      </li>
> +      <li>
> +	<p>
> +	  Introduce <a href="https://clang.llvm.org/docs/HardwareAssistedAddressSanitizerDesign.html">
> +	  Hardware-assisted AddressSanitizer</a> support.  This sanitizer currently
> +	  only works for the AArch64 target.  It helps debug address problems
> +	  similarly to
> +	  <a href="https://github.com/google/sanitizers/wiki/AddressSanitizer">
> +	  AddressSanitizer</a> but is based on partial hardware assistance and
> +	  provides probabilistic protection to use less RAM at run time.
> +	  <a href="https://clang.llvm.org/docs/HardwareAssistedAddressSanitizerDesign.html">
> +	  Hardware-assisted AddressSanitizer</a> is not production-ready for user
> +	  space, and is provided mainly for use compiling the Linux Kernel.
> +	</p>
> +	<p>
> +	  To use this sanitizer the command line arguments are:
> +	  <ul>
> +	    <li><code>-fsanitize=hwaddress</code> to instrument userspace code.</li>
> +	    <li><code>-fsanitize=kernel-hwaddress</code> to instrument kernel code.</li>
> +	  </ul>
> +	</p>
> +      </li>
>      </ul>
>    </li>
>    <li>
  
Gerald Pfeifer Feb. 22, 2022, 10:34 a.m. UTC | #2
On Tue, 22 Feb 2022, Richard Sandiford wrote:
> Err, scratch that.  Clearly I've not had tea this morning, and forgot 
> which version we're about to release :-)

No worries!  (And it's not even 13 yet. ;-)

For the record, I for one am happy for you to make such changes
as you see fit (where applicable), i.e., happy to provide a second
pair of eyes, but that's an offer, not a requirement.

Gerald
  

Patch

diff --git a/htdocs/gcc-11/changes.html b/htdocs/gcc-11/changes.html
index 8e6d4ec8..cc3ae989 100644
--- a/htdocs/gcc-11/changes.html
+++ b/htdocs/gcc-11/changes.html
@@ -69,18 +69,6 @@  You may also want to check out our
 <h2 id="general">General Improvements</h2>
 
 <ul>
-  <li>
-    <a href="https://github.com/google/sanitizers/wiki/ThreadSanitizerCppManual">
-    ThreadSanitizer</a> improvements to support alternative runtimes and
-    environments. The <a href="https://www.kernel.org/doc/html/latest/dev-tools/kcsan.html">
-    Linux Kernel Concurrency Sanitizer (KCSAN)</a> is now supported.
-    <ul>
-      <li>Add <code>--param tsan-distinguish-volatile</code> to optionally emit
-          instrumentation distinguishing volatile accesses.</li>
-      <li>Add <code>--param tsan-instrument-func-entry-exit</code> to optionally
-          control if function entries and exits should be instrumented.</li>
-    </ul>
-  </li>
   <li>
     <p>
       In previous releases of GCC, the "column numbers" emitted in diagnostics
@@ -121,22 +109,43 @@  You may also want to check out our
     </p>
   </li>
   <li>
-    <p>
-    Introduce <a href="https://clang.llvm.org/docs/HardwareAssistedAddressSanitizerDesign.html">
-      Hardware-assisted AddressSanitizer</a> support.  This sanitizer currently
-    only works for the AArch64 target.  It helps debug address problems
-    similarly to
-    <a href="https://github.com/google/sanitizers/wiki/AddressSanitizer">
-      AddressSanitizer</a> but is based on partial hardware assistance and
-    provides probabilistic protection to use less RAM at run time.
-    <a href="https://clang.llvm.org/docs/HardwareAssistedAddressSanitizerDesign.html">
-      Hardware-assisted AddressSanitizer</a> is not production-ready for user
-    space, and is provided mainly for use compiling the Linux Kernel.
-    </p>
-    To use this sanitizer the command line arguments are:
+    Sanitizer improvements:
     <ul>
-      <li><code>-fsanitize=hwaddress</code> to instrument userspace code.</li>
-      <li><code>-fsanitize=kernel-hwaddress</code> to instrument kernel code.</li>
+      <li>
+	<a href="https://github.com/google/sanitizers/wiki/ThreadSanitizerCppManual">
+	ThreadSanitizer</a> improvements to support alternative runtimes
+	and environments.  The
+	<a href="https://www.kernel.org/doc/html/latest/dev-tools/kcsan.html">
+	Linux Kernel Concurrency Sanitizer (KCSAN)</a> is now supported.
+	<ul>
+	  <li>Add <code>--param tsan-distinguish-volatile</code> to optionally
+	      emit instrumentation distinguishing volatile accesses.</li>
+	  <li>Add <code>--param tsan-instrument-func-entry-exit</code> to
+	      optionally control if function entries and exits should be
+	      instrumented.</li>
+	</ul>
+      </li>
+      <li>
+	<p>
+	  Introduce <a href="https://clang.llvm.org/docs/HardwareAssistedAddressSanitizerDesign.html">
+	  Hardware-assisted AddressSanitizer</a> support.  This sanitizer currently
+	  only works for the AArch64 target.  It helps debug address problems
+	  similarly to
+	  <a href="https://github.com/google/sanitizers/wiki/AddressSanitizer">
+	  AddressSanitizer</a> but is based on partial hardware assistance and
+	  provides probabilistic protection to use less RAM at run time.
+	  <a href="https://clang.llvm.org/docs/HardwareAssistedAddressSanitizerDesign.html">
+	  Hardware-assisted AddressSanitizer</a> is not production-ready for user
+	  space, and is provided mainly for use compiling the Linux Kernel.
+	</p>
+	<p>
+	  To use this sanitizer the command line arguments are:
+	  <ul>
+	    <li><code>-fsanitize=hwaddress</code> to instrument userspace code.</li>
+	    <li><code>-fsanitize=kernel-hwaddress</code> to instrument kernel code.</li>
+	  </ul>
+	</p>
+      </li>
     </ul>
   </li>
   <li>