Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

go/build: “Build constraints” section of package comment should mention //go:build syntax #46124

Closed
bcmills opened this issue May 12, 2021 · 1 comment
Closed

go/build: “Build constraints” section of package comment should mention //go:build syntax #46124

bcmills opened this issue May 12, 2021 · 1 comment
Labels
Documentation FrozenDueToAge NeedsFix The path to resolution is known, but the work has not been done. release-blocker
Milestone
Go1.17

Comments

@bcmills
Copy link
Contributor

bcmills commented May 12, 2021

https://tip.golang.org/pkg/go/build/#hdr-Build_Constraints currently says:

A build constraint, also known as a build tag, is a line comment that begins

// +build

Now that the //go:build syntax is recognized by the toolchain (#41184), we should be sure to update that documentation before the 1.17 release. It is currently the top Google search hit for [golang build constraint].
@bcmills bcmills added Documentation release-blocker okay-after-beta1 Used by release team to mark a release-blocker issue as okay to resolve either before or after beta1 labels May 12, 2021
@bcmills bcmills added this to the Go1.17 milestone May 12, 2021
@heschi heschi added the NeedsFix The path to resolution is known, but the work has not been done. label May 12, 2021
@heschi heschi removed the okay-after-beta1 Used by release team to mark a release-blocker issue as okay to resolve either before or after beta1 label Jun 10, 2021
@gopherbot
Copy link

Change https://golang.org/cl/326931 mentions this issue: cmd/go, go/build: update docs to use //go:build syntax

@golang golang locked and limited conversation to collaborators Jun 15, 2022
@rsc rsc unassigned neild Jun 23, 2022
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Assignees
No one assigned
Labels
Documentation FrozenDueToAge NeedsFix The path to resolution is known, but the work has not been done. release-blocker
Projects
None yet
Milestone
Go1.17
Development

No branches or pull requests
4 participants
@neild @bcmills @gopherbot @heschi