Skip to content

Commit 199bc00

Browse files
committed
doc/go1.14: -d=checkptr is not yet recommended on Windows
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]>
1 parent 10bfe5b commit 199bc00

File tree

1 file changed

+8
-3
lines changed

1 file changed

+8
-3
lines changed

doc/go1.14.html

Lines changed: 8 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -301,9 +301,9 @@ <h2 id="compiler">Compiler</h2>
301301
This release adds <code>-d=checkptr</code> as a compile-time option
302302
for adding instrumentation to check that Go code is following
303303
<code>unsafe.Pointer</code> safety rules dynamically.
304-
This option is enabled by default with the <code>-race</code>
305-
or <code>-msan</code> flags, and can be disabled
306-
with <code>-gcflags=-all=-d=checkptr=0</code>.
304+
This option is enabled by default (except on Windows) with
305+
the <code>-race</code> or <code>-msan</code> flags, and can be
306+
disabled with <code>-gcflags=all=-d=checkptr=0</code>.
307307
Specifically, <code>-d=checkptr</code> checks the following:
308308
</p>
309309

@@ -320,6 +320,11 @@ <h2 id="compiler">Compiler</h2>
320320
</li>
321321
</ol>
322322

323+
<p>
324+
Using <code>-d=checkptr</code> is not currently recommended on
325+
Windows because it causes false alerts in the standard library.
326+
</p>
327+
323328
<p><!-- CL 204338 -->
324329
The compiler can now emit machine-readable logs of key optimizations
325330
using the <code>-json</code> flag, including inlining, escape

0 commit comments

Comments
 (0)