mirror
/
go
mirror of https://github.com/golang/go.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

gopls/doc: update instructions for generics following the beta 

Change-Id: Id163d51dfd3fc7583457792714398529a0a12dd7
Reviewed-on: https://go-review.googlesource.com/c/tools/+/372254
Trust: Robert Findley <rfindley@google.com>
Run-TryBot: Robert Findley <rfindley@google.com>
gopls-CI: kokoro <noreply+kokoro@google.com>
Reviewed-by: Hyang-Ah Hana Kim <hyangah@gmail.com>
TryBot-Result: Gopher Robot <gobot@golang.org>
This commit is contained in:
Robert Findley 2021-12-15 10:35:46 -05:00
parent 27fc7644e1
commit cd2143c081
1 changed files with 12 additions and 18 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

30
gopls/doc/advanced.md
View File

@ -46,36 +46,30 @@ editor.
## Working with generic code
Gopls has experimental support for generic Go, as defined by the type
Gopls has beta support for editing generic Go code, as defined by the type
parameters proposal ([golang/go#43651](https://golang.org/issues/43651)) and
type set addendum ([golang/go#45346](https://golang.org/issues/45346)).
To enable this support, you need to build gopls with a version of Go that
supports type parameters, currently just tip. This can be done by checking
out the `master` branch in the Go repository, or by using
`golang.org/dl/gotip`:
supports generics. The easiest way to do this is by installing Go 1.18 Beta
1 as described at
[Tutorial: Getting started with generics#prerequisites](https://go.dev/doc/tutorial/generics),
and then using this Go version to build gopls:
```
$ go install golang.org/dl/gotip@latest
$ gotip download
$ go1.18beta1 install golang.org/x/tools/gopls@latest
```
For building gopls with type parameter support, it is recommended that you
build gopls at tip. External APIs are under active development on the Go
`master` branch, so building gopls at tip minimizes the chances of a build
failure. You will also need to update the `go` directive in your `go.mod`
file to refer to `go 1.18` to use generics.
When using the Go 1.18, it is strongly recommended that you install the latest
version of `gopls`, or the latest **unstable** version as
[described above](#installing-unreleased-versions).
Build and install the latest **unstable** version of `gopls` following
[the instruction](#installing-unreleased-versions).
Remember to use `gotip` instead of `go`.
The `gopls` build with this instruction understands generic code. To actually
run the generic code you develop, you must also use the tip version of the Go
The `gopls` built with these instructions understands generic code. To actually
run the generic code you develop, you must also use the beta version of the Go
compiler. For example:
```
$ gotip run .
$ go1.18beta1 run .
```
[Go project]: https://go.googlesource.com/go