Skip to content

Commit f0680f9

Browse files
committed
docs: remove modules.md because it is not relevant with gopls enabled
This document only refers to issues that occur when gopls is disabled. Remove it, and update any links that used to point to it. I didn't fix links in the README, troubleshooting, or gopls files because those will be modified soon. I did run the link checker on all of the files so I fixed any other links I noticed. Change-Id: If4db3cd555154410a41740c110543aaf210dacfe Reviewed-on: https://go-review.googlesource.com/c/vscode-go/+/284835 Trust: Rebecca Stambler <[email protected]> Run-TryBot: Rebecca Stambler <[email protected]> Reviewed-by: Hyang-Ah Hana Kim <[email protected]>
1 parent bcd1314 commit f0680f9

File tree

7 files changed

+16
-42
lines changed

7 files changed

+16
-42
lines changed

docs/debugging.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -112,7 +112,7 @@ logOutput | Comma-separated list of Delve components (`debugger`, `gdbwire`, `l
112112
buildFlags | Build flags to pass to the Go compiler. This corresponds to `dlv`'s `--build-flags` flag.
113113
dlvFlags | Extra flags passed to `dlv`. See `dlv help` for the full list of supported flags. This is useful when users need to pass less commonly used or new flags such as `--only-same-user`, `--check-go-version`. Note that some flags such as `--log-output`, `--log`, `--init`, `--api-version` already have corresponding properties in the debug configuration, and flags such as `--listen` and `--headless` are used internally. If they are specified in `dlvFlags`, they may be ignored or cause an error.
114114
remotePath | If remote debugging (`mode`: `remote`), this should be the absolute path to the package being debugged on the remote machine. See the section on [Remote Debugging](#remote-debugging) for further details. [golang/vscode-go#45](https://github.com/golang/vscode-go/issues/45) is also relevant. Becomes the first mapping in substitutePath.
115-
substitutePath | An array of mappings from an absolute local path to an absolute remote path that is used by the debuggee. The debug adapter will replace the local path with the remote path in all of the calls. The mappings are applied in order, and the first matching mapping is used. This can be used to map files that have moved since the program was built, different remote paths, and symlinked files or directories. This is intended to be equivalent to the [substitute-path]((https://github.com/go-delve/delve/tree/master/Documentation/cli#config)(https://github.com/go-delve/delve/tree/master/Documentation/cli#config)) configuration, and will eventually configure substitute-path in Delve directly.
115+
substitutePath | An array of mappings from an absolute local path to an absolute remote path that is used by the debuggee. The debug adapter will replace the local path with the remote path in all of the calls. The mappings are applied in order, and the first matching mapping is used. This can be used to map files that have moved since the program was built, different remote paths, and symlinked files or directories. This is intended to be equivalent to the [substitute-path](https://github.com/go-delve/delve/tree/master/Documentation/cli#config) configuration, and will eventually configure substitute-path in Delve directly.
116116
cwd | The working directory to be used in running the program. If remote debugging (`mode`: `remote`), this should be the absolute path to the working directory being debugged on the local machine. See the section on [Remote Debugging](#remote-debugging) for further details. [golang/vscode-go#45](https://github.com/golang/vscode-go/issues/45) is also relevant.
117117
processId | This is the process ID of the executable you want to debug. Applicable only when using the `attach` request in `local` mode.
118118

docs/features.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -210,7 +210,7 @@ Behind the scenes, the `Debug: Start without Debugging` command calls `go run`.
210210

211211
### Code Coverage
212212

213-
Show code coverage in the editor, either after running a test or on-demand. This can be done via the commands: [`Go: Apply Cover Profile`](commands.md#go-apply-cover-profile) and [`Go: Toggle Test Coverage in Current Package`](commands.go-toggle-test-coverage-in-current-package).
213+
Show code coverage in the editor, either after running a test or on-demand. This can be done via the commands: [`Go: Apply Cover Profile`](commands.md#go-apply-cover-profile) and [`Go: Toggle Test Coverage in Current Package`](commands.md#go-toggle-test-coverage-in-current-package).
214214

215215
## [Debugging](debugging.md)
216216

docs/gopath.md

+9-3
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,14 @@
11
# `GOPATH`
22

3-
The `GOPATH` environment variable is a fundamental part of writing Go code **without** [Go modules]. It specifies the location of your workspace, and it defaults to `$HOME/go`. A `GOPATH` directory contains `src`, `bin`, and `pkg` directories. Your code is typically located in the `$GOPATH/src` directory.
3+
The `GOPATH` environment variable is a fundamental part of writing Go code
4+
**without** [Go modules]. It specifies the location of your workspace, and it
5+
defaults to `$HOME/go`. A `GOPATH` directory contains `src`, `bin`, and `pkg`
6+
directories. Your code is typically located in the `$GOPATH/src` directory.
47

5-
If you are not familiar with Go and `GOPATH`, please first read about [writing Go code with `GOPATH`](https://golang.org/doc/gopath_code.html#GOPATH).
8+
If you are not familiar with Go and `GOPATH`, please first read about [writing
9+
Go code with `GOPATH`](https://golang.org/doc/gopath_code.html#GOPATH).
10+
11+
**If you are just starting out with Go, we recommend [using Go modules](https://blog.golang.org/using-go-modules) instead of GOPATH.**
612

713
## Overview
814

@@ -21,7 +27,7 @@ If the `GOPATH` value is incorrect, see the details below on how to configure it
2127

2228
## Setting `GOPATH`
2329

24-
If you have chosen not to use [Go modules], you will need to configure your `GOPATH`. Modules have largely eliminated the need for a `GOPATH`, so if you're interested in using them, taking a look at the [modules documentation](modules.md) for the VS Code Go extension.
30+
If you have chosen not to use [Go modules], you will need to configure your `GOPATH`.
2531

2632
Setting `GOPATH` is typically as simple as setting the environment variable once in your system's configuration. Take a look at the [Setting `GOPATH` Wiki](https://github.com/golang/go/wiki/SettingGOPATH) if you're unsure how to do this.
2733

docs/modules.md

-34
This file was deleted.

docs/nightly.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22

33
This master branch of this extension is built and published nightly through the [Go Nightly]. If you're interested in testing new features and bug fixes, you may be interested in switching to the [Go Nightly] extension. Also, if you file an issue, we may suggest trying out the fix in [Go Nightly].
44

5-
[Go Nightly] is the **preview** version of the Go extension, so it may be broken or unstable at times. The [Changelog](nightly/CHANGELOG.md) and [README](nightly/README.md) for [Go Nightly] can be found in the [docs/nightly](nightly/) directory.
5+
[Go Nightly] is the **preview** version of the Go extension, so it may be broken or unstable at times.
66

77
## Installation
88

docs/testing.md

+3-1
Original file line numberDiff line numberDiff line change
@@ -37,7 +37,9 @@ gcloud builds submit --config=build/cloudbuild.container.yaml
3737

3838
This is the workflow triggered for every PR and commit made to our mirror repository on GitHub, [github.com/golang/vscode-go](https://github.com/golang/vscode-go). We use this CI system to run tests on platforms that GCB does not yet support. This workflow is not triggered by CLs sent via Gerrit yet.
3939

40-
[`.github/workflows/ci.yml`](../.github/workflows/ci.yml) defines the GitHub Actions-based CI workflow.
40+
[`.github/workflows/test-long.yml`](../.github/workflows/test-long.yml) and
41+
[`.github/workflows/test-smoke.yml`](../.github/workflows/test-smoke.yml)
42+
define the GitHub Actions-based CI workflow.
4143

4244
### [Nightly Release](nightly.md)
4345

docs/ui.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -29,7 +29,7 @@ Once the download completes, VS Code Go will make use of this new Go version.
2929

3030
### Language Server Status
3131

32-
`gopls` is the official Go [language server](https://langserver.org/) developed by the Go team. It was developed in response to the release of [Go modules](docs/modules.md), and it is the recommended approach when working with [Go modules](docs/modules.md) in VS Code.
32+
`gopls` is the official Go [language server](https://langserver.org/) developed by the Go team. It was developed in response to the release of [Go modules](docs/modules.md), and it is the recommended approach when working with Go modules in VS Code.
3333

3434
When `gopls` is enabled, :zap: is displayed next to the Go version in the status bar and the `gopls` version is displayed in the menu.
3535

0 commit comments

Comments
 (0)