The Go programming language
Go to file
Rebecca Stambler d78b04bdf9 gopls/doc: clean up and slightly reorganize documentation
This is a first CL to clean up the gopls documentation. The main changes
are cosmetic (to correct warnings found by the MD Lint VS Code
extension), though some parts are reworded or moved around. Ultimately,
more work needs to be done, particularly on the user guide and features
overview.

My current thinking is that we should rename settings.md to
configuration and move the configuration piece out of the user guide,
and also reorganize the user guide to be more "getting started"
oriented.

I'm still not sure where miscellaneous items should go (e.g., working on
the Go distribution itself)--I deleted the FAQ because it seemed useless
and is probably not the most discoverable, but it's the only place that
comes to mind so far.

Change-Id: I3689362067672f7ad8d5e8fd97ca9c7c45cfc8c4
Reviewed-on: https://go-review.googlesource.com/c/tools/+/280595
Trust: Rebecca Stambler <rstambler@golang.org>
Run-TryBot: Rebecca Stambler <rstambler@golang.org>
Reviewed-by: Robert Findley <rfindley@google.com>
2021-01-14 06:55:38 +00:00
benchmark/parse benchmark/parse: add unit test for String function 2019-12-16 21:43:19 +00:00
blog copyright: test that all files in the repo have copyright notices 2021-01-11 22:19:46 +00:00
cmd copyright: test that all files in the repo have copyright notices 2021-01-11 22:19:46 +00:00
container/intsets copyright: test that all files in the repo have copyright notices 2021-01-11 22:19:46 +00:00
copyright copyright: test that all files in the repo have copyright notices 2021-01-11 22:19:46 +00:00
cover cover: fix sorting of profile segment boundaries 2020-09-16 14:01:29 +00:00
go go/packages: don't crash if given an invalid overlay 2021-01-12 18:33:07 +00:00
godoc godoc: change godoc.org links to pkg.go.dev 2020-12-07 16:54:04 +00:00
gopls gopls/doc: clean up and slightly reorganize documentation 2021-01-14 06:55:38 +00:00
imports all: add copyright notices to files that are missing them 2021-01-06 17:23:47 +00:00
internal gopls/doc: clean up and slightly reorganize documentation 2021-01-14 06:55:38 +00:00
playground copyright: test that all files in the repo have copyright notices 2021-01-11 22:19:46 +00:00
present all: add copyright notices to files that are missing them 2021-01-06 17:23:47 +00:00
refactor copyright: test that all files in the repo have copyright notices 2021-01-11 22:19:46 +00:00
txtar txtar/archive: add unit test function for Format 2019-11-20 20:49:00 +00:00
.gitattributes tools: copying .gitattributes to all subrepositories (fixes windows build) 2014-12-23 06:32:51 +00:00
.gitignore .gitignore: roll back ".gitignore: ignore emacs backup files" 2018-02-13 00:43:28 +00:00
.prettierrc all: add a section on JS/CSS formatting to README 2020-05-28 15:31:34 +00:00
AUTHORS go.empty: prototype for new subrepository 2012-01-25 14:45:13 -05:00
CONTRIBUTING.md CONTRIBUTING.md: remove note about not accepting Pull Requests 2018-03-14 18:02:17 +00:00
CONTRIBUTORS go.empty: prototype for new subrepository 2012-01-25 14:45:13 -05:00
LICENSE LICENSE: add 2012-03-17 15:20:58 +11:00
PATENTS go.empty: add PATENTS file to the subrepo. 2012-04-16 11:24:04 +10:00
README.md tools, gopls: add pkg.go.dev badges to READMEs 2020-12-03 23:01:54 +00:00
codereview.cfg tools: add codereview.cfg 2015-03-18 17:04:00 +00:00
go.mod all: update all dependencies to latest pseudoversions 2020-10-22 03:59:29 +00:00
go.sum all: update all dependencies to latest pseudoversions 2020-10-22 03:59:29 +00:00

README.md

Go Tools

PkgGoDev

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.

Download/Install

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.

JS/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.

Report Issues / Send Patches

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.