| commit | 3113a4aab4805e1f124d6912d4ad84647d9f86a9 | [log] [tgz] |
|---|---|---|
| author | Dmitri Shuralyov <dmitshur@golang.org> | Mon Sep 23 18:16:04 2019 -0400 |
| committer | Dmitri Shuralyov <dmitshur@golang.org> | Thu Nov 07 17:57:43 2019 +0000 |
| tree | f35402e07afca0439babc978b7bbd8becfdb7dce | |
| parent | f79515f338230420deefba76e168cfd29f52942d [diff] |
cmd/godoc: add initial support for module mode This change implements initial support for viewing Go package documentation with godoc in module mode. There are no UI changes. When running the godoc binary in a directory where module mode is active (i.e., go env GOMOD reports a non-empty path), the documentation will be shown for packages provided by modules rather than from the GOPATH workspace. The mode can be controlled in the same way as the go command, by changing the GO111MODULE environment variable¹ value. For example, 'GO111MODULE=on godoc' will force godoc to run in module mode, and 'GO111MODULE=off godoc' will force godoc to run in GOPATH mode. It is implemented by reusing the existing virtual filesystem abstraction. The main module and all of its dependencies (in other words, the build list²) are determined by invoking the go list -m all command in the same directory. An attempt is made to fill the module cache with any selected module versions that are not already in the local module cache. This behavior can be controlled in the same way as the go command, by setting the GOPROXY environment variable. For example, setting GOPROXY=off disables downloading of any modules. If any of the modules could not be fetched, it is printed to stderr and documentation is shown for all other available packages. ¹ https://golang.org/cmd/go/#hdr-Module_support ² https://golang.org/cmd/go/#hdr-The_main_module_and_the_build_list Fixes golang/go#33655 Change-Id: I86f795537b65acae3771afd19d2e7cb360425467 Reviewed-on: https://go-review.googlesource.com/c/tools/+/196983 Reviewed-by: Andrew Bonventre <andybons@golang.org>
This subrepository holds the source for various packages and tools that support the Go programming language.
Some of the tools, godoc and vet for example, are included in binary Go distributions.
Others, including the Go guru and the test coverage tool, can be fetched with go get.
Packages include a type-checker for Go and an implementation of the Static Single Assignment form (SSA) representation for Go programs.
The easiest way to install is to run go get -u golang.org/x/tools/.... You can also manually git clone the repository to $GOPATH/src/golang.org/x/tools.
This repository uses Gerrit for code changes. To learn how to submit changes to this repository, 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.