Golang/go
1
0
Fork 0
mirror of https://github.com/golang/go.git synced 2024-11-22 05:40:42 +00:00
Code Issues Actions Packages Projects Releases Wiki Activity

move troubleshooting higher

Rebecca Stambler 2019-05-31 13:20:56 -04:00
parent 13df6038e1
commit 175782bdea
1 changed files with 7 additions and 7 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

14
gopls.md

@ -3,8 +3,8 @@ The LSP allows any text editor to be extended with IDE-like features (see https:
# Table of Contents
[Status](#status)
[Installation](#installation)
[Troubleshooting](#troubleshooting)
[Installation](#installation)
[Contributing](#contributing)
[FAQ](#faq)
[Integrator FAQ](#integrator-faq)
@ -14,6 +14,12 @@ The LSP allows any text editor to be extended with IDE-like features (see https:
`gopls` is currently under active development by the Go team. The code is in the x/tools repository, in [golang.org/x/tools/internal/lsp](https://golang.org/x/tools/internal/lsp) and [golang.org/x/tools/cmd/gopls](https://golang.org/x/tools/cmd/gopls). Because we are actively working on `gopls`, it is not stable. If you choose to use it, be aware that things may regularly break or change.
## Troubleshooting
If you see a `gopls` error or crash, or `gopls` just stops working, please capture your `gopls` log and file an issue on the [Go issue tracker](https://github.com/golang/go/issues). Please attach the log and any other relevant information, or if you have one, a case that reproduces the issue. It would also be helpful to see your `gopls` editor configurations, such as a VSCode `settings.json` file. You can then try to restart your `gopls` instance by restarting your editor, which, in most cases, should correct the problem.
For VSCode users, the `gopls` log can be found by going to "View: Debug Console" -> "Output" -> "Tasks" -> "gopls".
## Installation
First, install `gopls` by running `go get -u golang.org/x/tools/cmd/gopls`.
@ -164,12 +170,6 @@ After doing the above, you might want to take a look at the LSP package's settin
---
## Troubleshooting
If you see a `gopls` error or crash, or `gopls` just stops working, please capture your `gopls` log and file an issue on the [Go issue tracker](https://github.com/golang/go/issues) with the log attached and any other relevant information or a case that reproduces the issue. You can then try to restart your `gopls` instance by restarting your editor, which, in most cases, should correct the problem.
For VSCode users, the `gopls` log can be found by going to "View: Debug Console" -> "Output" -> "Tasks" -> "gopls".
## Contributing
Contributions are welcome, but since development is so active, we request that you file an issue and claim it before starting to work on something. Otherwise, it is likely that we might already be working on a fix for your issue.