Google Git
Sign in
go / tools / 9ff31a5780b2d96e9f596fe09dc13f1510a84542
commit9ff31a5780b2d96e9f596fe09dc13f1510a84542[log] [tgz]
authorRuss Cox <rsc@golang.org>Wed Jan 18 10:11:20 2023 -0500
committerGopher Robot <gobot@golang.org>Wed Jan 18 15:33:02 2023 +0000
treece9cacc386d9d0661b0534f1fc34dacaa3c23660
parent2fa6ca1e245fb760cb11dac2d3b31587ff8621e2 [diff]
x/tools/go/analysis/passes/printf: revert URL in error message

Revert CL 422854, which added a URL to this one error message,
shortly after the Go 1.19 release, which means there is still time
to keep it from ending up in Go 1.20.

	% go test
	# runtime/metrics_test
	./description_test.go:61:4: (*testing.common).Errorf format %s has arg samples[0].Value.Kind() of wrong type runtime/metrics.ValueKind, see also https://pkg.go.dev/fmt#hdr-Printing

After this CL the ", see also" will not print.

The URL is undoubtedly helpful in some cases, but it makes the
error much longer and reduces the signal-to-noise ratio.
It is also not clear why this one error deserves special treatment.

We should have a general solution for getting users to details
about the specific errors being printed, not URLs in every message.

This reverts commit 88d981ef8f8158b15938bd1bc77e47cea16fe5f0.

Change-Id: Ib49e1fae94ba837f432d8a65e38e657cfa522668
Reviewed-on: https://go-review.googlesource.com/c/tools/+/462438
TryBot-Result: Gopher Robot <gobot@golang.org>
gopls-CI: kokoro <noreply+kokoro@google.com>
Run-TryBot: Russ Cox <rsc@golang.org>
Reviewed-by: Robert Findley <rfindley@google.com>
Auto-Submit: Russ Cox <rsc@golang.org>
1 file changed
tree: ce9cacc386d9d0661b0534f1fc34dacaa3c23660
  1. benchmark/
  2. blog/
  3. cmd/
  4. container/
  5. copyright/
  6. cover/
  7. go/
  8. godoc/
  9. gopls/
  10. imports/
  11. internal/
  12. playground/
  13. present/
  14. refactor/
  15. txtar/
  16. .gitattributes
  17. .gitignore
  18. .prettierrc
  19. codereview.cfg
  20. CONTRIBUTING.md
  21. go.mod
  22. go.sum
  23. LICENSE
  24. PATENTS
  25. README.md
README.md

Go Tools

PkgGoDev

This repository provides the golang.org/x/tools module, comprising various tools and packages mostly for static analysis of Go programs, some of which are listed below. Use the “Go reference” link above for more information about any package.

It also contains the golang.org/x/tools/gopls module, whose root package is a language-server protocol (LSP) server for Go. An LSP server analyses the source code of a project and responds to requests from a wide range of editors such as VSCode and Vim, allowing them to support IDE-like functionality.

Selected commands:

  • cmd/goimports formats a Go program like go fmt and additionally inserts import statements for any packages required by the file after it is edited.
  • cmd/callgraph prints the call graph of a Go program.
  • cmd/digraph is a utility for manipulating directed graphs in textual notation.
  • cmd/stringer generates declarations (including a String method) for “enum” types.
  • cmd/toolstash is a utility to simplify working with multiple versions of the Go toolchain.

These commands may be fetched with a command such as

go install golang.org/x/tools/cmd/goimports@latest

Selected packages:

  • go/ssa provides a static single-assignment form (SSA) intermediate representation (IR) for Go programs, similar to a typical compiler, for use by analysis tools.

  • go/packages provides a simple interface for loading, parsing, and type checking a complete Go program from source code.

  • go/analysis provides a framework for modular static analysis of Go programs.

  • go/callgraph provides call graphs of Go programs using a variety of algorithms with different trade-offs.

  • go/ast/inspector provides an optimized means of traversing a Go parse tree for use in analysis tools.

  • go/cfg provides a simple control-flow graph (CFG) for a Go function.

  • go/expect reads Go source files used as test inputs and interprets special comments within them as queries or assertions for testing.

  • go/gcexportdata and go/gccgoexportdata read and write the binary files containing type information used by the standard and gccgo compilers.

  • go/types/objectpath provides a stable naming scheme for named entities (“objects”) in the go/types API.

Numerous other packages provide more esoteric functionality.

Contributing

This repository uses Gerrit for code changes. To learn how to submit changes, see https://golang.org/doc/contribute.html.

The main issue tracker for the tools repository is located at https://github.com/golang/go/issues. Prefix your issue with “x/tools/(your subdir):” in the subject line, so it is easy to find.

JavaScript and CSS Formatting

This repository uses prettier to format JS and CSS files.

The version of prettier used is 1.18.2.

It is encouraged that all JS and CSS code be run through this before submitting a change. However, it is not a strict requirement enforced by CI.