]> Cypherpunks repositories - gostls13.git/commitdiff
doc/go1.14: -d=checkptr is not yet recommended on Windows
authorAustin Clements <austin@google.com>
Thu, 9 Jan 2020 17:44:52 +0000 (12:44 -0500)
committerAustin Clements <austin@google.com>
Thu, 9 Jan 2020 20:43:24 +0000 (20:43 +0000)
Hopefully we'll have the remaining safety violations in the standard
library ironed out by 1.15.

We also fix a minor (but important) typo while we're here.

Updates #34964, #34972.

Change-Id: Ic72fd4d9411b749f8c0cea87e95ab68347009893
Reviewed-on: https://go-review.googlesource.com/c/go/+/214118
Reviewed-by: Brad Fitzpatrick <bradfitz@golang.org>
doc/go1.14.html

index 6811868bc20bccb1a33423d8aa4b3143caa4c537..87d2fac1aa7f183375937e0e3f8d3cb1c16bb3c3 100644 (file)
@@ -301,9 +301,9 @@ TODO
   This release adds <code>-d=checkptr</code> as a compile-time option
   for adding instrumentation to check that Go code is following
   <code>unsafe.Pointer</code> safety rules dynamically.
-  This option is enabled by default with the <code>-race</code>
-  or <code>-msan</code> flags, and can be disabled
-  with <code>-gcflags=-all=-d=checkptr=0</code>.
+  This option is enabled by default (except on Windows) with
+  the <code>-race</code> or <code>-msan</code> flags, and can be
+  disabled with <code>-gcflags=all=-d=checkptr=0</code>.
   Specifically, <code>-d=checkptr</code> checks the following:
 </p>
 
@@ -320,6 +320,11 @@ TODO
   </li>
 </ol>
 
+<p>
+  Using <code>-d=checkptr</code> is not currently recommended on
+  Windows because it causes false alerts in the standard library.
+</p>
+
 <p><!-- CL 204338 -->
   The compiler can now emit machine-readable logs of key optimizations
   using the <code>-json</code> flag, including inlining, escape