Stowage/go
2
0
Fork 0
mirror of https://github.com/golang/go.git synced 2025-12-08 06:10:04 +00:00
Code Issues Projects Releases Packages Wiki Activity

cmd/go: document purego convention

Browse source 
Fixes #23172

Change-Id: I854e399471dfa22e62fbdec9719e561c4501e5ac
Reviewed-on: https://go-review.googlesource.com/c/go/+/660136
Reviewed-by: Michael Matloob <matloob@google.com>
LUCI-TryBot-Result: Go LUCI <golang-scoped@luci-project-accounts.iam.gserviceaccount.com>
Reviewed-by: Michael Matloob <matloob@golang.org>
Reviewed-by: Filippo Valsorda <filippo@golang.org>
Reviewed-by: Michael Knyszek <mknyszek@google.com>
This commit is contained in:
Sean Liao 2025-03-21 23:23:50 +00:00
parent 27937289dc
commit 99b724f454
2 changed files with 12 additions and 0 deletions
Download patch file Download diff file Expand all files Collapse all files

6
src/cmd/go/alldocs.go
View file

@ -2190,6 +2190,12 @@
// building the package for Windows; similarly, math_386.s will be included
// only when building the package for 32-bit x86.
//
// By convention, packages with assembly implementations may provide a go-only
// version under the "purego" build constraint. This does not limit the use of
// cgo (use the "cgo" build constraint) or unsafe. For example:
//
// //go:build purego
//
// Go versions 1.16 and earlier used a different syntax for build constraints,
// with a "// +build" prefix. The gofmt command will add an equivalent //go:build
// constraint when encountering the older syntax.

6
src/cmd/go/internal/help/helpdoc.go
View file

@ -1009,6 +1009,12 @@ Naming a file dns_windows.go will cause it to be included only when
building the package for Windows; similarly, math_386.s will be included
only when building the package for 32-bit x86.
By convention, packages with assembly implementations may provide a go-only
version under the "purego" build constraint. This does not limit the use of
cgo (use the "cgo" build constraint) or unsafe. For example:
//go:build purego
Go versions 1.16 and earlier used a different syntax for build constraints,
with a "// +build" prefix. The gofmt command will add an equivalent //go:build
constraint when encountering the older syntax.