doc: document change of cgocheck=2 from debug to experiment

Change-Id: I98bdfe8ab338a5b92c466a5aacfa95266171e5c3
Reviewed-on: https://go-review.googlesource.com/c/go/+/499279
Reviewed-by: Keith Randall <khr@google.com>
TryBot-Bypass: Keith Randall <khr@golang.org>
Reviewed-by: Ian Lance Taylor <iant@google.com>
This commit is contained in:
Keith Randall 2023-05-30 11:36:19 -07:00
parent 4497b12344
commit 2a129f3e8a
1 changed files with 6 additions and 1 deletions

View File

@ -748,7 +748,12 @@ Do not send CLs removing the interior tags from such phrases.
</p>
<p><!-- CL 447778 -->
TODO: <a href="https://go.dev/cl/447778">https://go.dev/cl/447778</a>: runtime: reimplement GODEBUG=cgocheck=2 as a GOEXPERIMENT
<code>GODEBUG=cgocheck=2</code>, a thorough checker of cgo pointer passing rules,
is no longer available as a <a href="/pkg/runtime#hdr-Environment_Variables">debug option</a>.
Instead, it is available as an experiment using <code>GOEXPERIMENT=cgocheck2</code>.
In particular this means that this mode has to be selected at build time instead of startup time.
<p>
<code>GODEBUG=cgocheck=1</code> is still available (and is still the default).
</p>
<p><!-- CL 472195 -->