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

x/tools/go/analysis/passes/printf, cmd/vet: gate non-constant format string check on 1.24 language version #71485

Open
findleyr opened this issue Jan 30, 2025 · 4 comments
Assignees
Labels
release-blocker ToolProposal Issues describing a requested change to a Go tool or command-line program. Tools This label describes issues relating to any tools in the x/tools repository.
Milestone

Comments

@findleyr
Copy link
Member

The new check added to the printf analyzer in #60529 reports errors for non-constant format strings. In almost all cases we've investigated, these turn out to be bugs.

However, they are mild bugs, and the analyzer can produce quite a large number of findings.
We experienced this in our own codebase when the analyzer landed, and the community is experiencing a similar amount of churn:
https://lwn.net/ml/fedora-devel/CAM4%3DqPKbUw4DoLkdXtk4XJM718bm8soGuHE%2BL58Lq5UJ%3DBZBwg%40mail.gmail.com/

To reduce the friction caused by this change, we should gate the new check on a 1.24 language version, so as to not break the tests of existing codebases. Users can address the new vet errors incrementally as they update the language versions of their modules.

(@rsc and @adonovan suggest doing this as a matter of principle when we add new vet checks, but that is a policy question outside the scope of this issue)

Marking this as a release blocker, to guard the RC.

@findleyr findleyr added this to the Go1.24 milestone Jan 30, 2025
@findleyr findleyr self-assigned this Jan 30, 2025
@gopherbot gopherbot added the Tools This label describes issues relating to any tools in the x/tools repository. label Jan 30, 2025
@gabyhelp
Copy link

@gabyhelp gabyhelp added the ToolProposal Issues describing a requested change to a Go tool or command-line program. label Jan 30, 2025
@gopherbot
Copy link
Contributor

Change https://go.dev/cl/645595 mentions this issue: go/analysis/passes/printf: suppress errors for non-const format strings

gopherbot pushed a commit to golang/tools that referenced this issue Jan 30, 2025
The new check added in golang/go#60529 reports errors for non-constant
format strings with no arguments. These are almost always bugs, but are
often mild or inconsequential, and can be numerous in existing code
bases.

To reduce friction from this change, gate the new check on the implied
language version.

For golang/go#71485

Change-Id: I4926da2809dd14ba70ae530cd1657119f5377ad5
Reviewed-on: https://go-review.googlesource.com/c/tools/+/645595
Reviewed-by: Alan Donovan <[email protected]>
LUCI-TryBot-Result: Go LUCI <[email protected]>
Auto-Submit: Robert Findley <[email protected]>
@gopherbot
Copy link
Contributor

Change https://go.dev/cl/645615 mentions this issue: cmd: update golang.org/x/tools to 9f450b0, and revendor

@gopherbot
Copy link
Contributor

Change https://go.dev/cl/645697 mentions this issue: [internal-branch.go1.24-vendor] go/analysis/passes/printf: suppress errors for non-const format strings

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
release-blocker ToolProposal Issues describing a requested change to a Go tool or command-line program. Tools This label describes issues relating to any tools in the x/tools repository.
Projects
None yet
Development

No branches or pull requests

3 participants