Skip to content

Commit

Permalink
doc/go1.14: -d=checkptr is not yet recommended on Windows
Browse files Browse the repository at this point in the history
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 <[email protected]>
  • Loading branch information
aclements committed Jan 9, 2020
1 parent 10bfe5b commit 199bc00
Showing 1 changed file with 8 additions and 3 deletions.
11 changes: 8 additions & 3 deletions doc/go1.14.html
Original file line number Diff line number Diff line change
Expand Up @@ -301,9 +301,9 @@ <h2 id="compiler">Compiler</h2>
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>

Expand All @@ -320,6 +320,11 @@ <h2 id="compiler">Compiler</h2>
</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
Expand Down

0 comments on commit 199bc00

Please sign in to comment.