Google Git
Sign in
go / tools / 516063ad6043ac2bfacc2442f3e99e87a995b058
commit516063ad6043ac2bfacc2442f3e99e87a995b058[log] [tgz]
authorRuss Cox <rsc@golang.org>Wed May 03 01:07:24 2023 -0400
committerRuss Cox <rsc@golang.org>Fri May 05 00:46:02 2023 +0000
treee878c2cb3ad536f08638cffe27be09eae8c22750
parent58fedf60c6b1b72e6adf6224d45ebbab7d6ba64e [diff]
bisect, cmd/bisect: add new library and tool

cmd/bisect automates culprit finding in a large set of
independent changes that together provoke a failure
(either when all enabled or when all disabled, but not both).
By repeating a target command with different subsets of
the changes enabled, bisect identifies the smallest number
of changes that need to be toggled away from the passing
state to cause the failing state.

Package bisect provides functionality to help target commands that
want to support running under cmd/bisect.

This is based on work done by khr and drchase in the Go compiler
and by drchase in github.com/dr2chase/gossahash,
but generalized to support other kinds of targets and
simplify the invocation.

This tool will be useful for finding call sites where a GODEBUG
setting changes a test outcome, as well as source code locations
where applying per-iteration loop semantics changes a test outcome.

Package bisect could use some direct tests of its own, but it is tested
quite a bit via the cmd/bisect test.

Change-Id: Id29efad9936bebee17c1475d92cb167019905aa4
Reviewed-on: https://go-review.googlesource.com/c/tools/+/491875
TryBot-Result: Gopher Robot <gobot@golang.org>
Run-TryBot: Russ Cox <rsc@golang.org>
gopls-CI: kokoro <noreply+kokoro@google.com>
Reviewed-by: David Chase <drchase@google.com>
20 files changed
tree: e878c2cb3ad536f08638cffe27be09eae8c22750
  1. benchmark/
  2. bisect/
  3. blog/
  4. cmd/
  5. container/
  6. copyright/
  7. cover/
  8. go/
  9. godoc/
  10. gopls/
  11. imports/
  12. internal/
  13. playground/
  14. present/
  15. refactor/
  16. txtar/
  17. .gitattributes
  18. .gitignore
  19. .prettierrc
  20. codereview.cfg
  21. CONTRIBUTING.md
  22. go.mod
  23. go.sum
  24. LICENSE
  25. PATENTS
  26. 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.