Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

x/tools/go/packages: document GOPACKAGESDRIVER #34341

Open
jmhodges opened this issue Sep 17, 2019 · 3 comments
Open

x/tools/go/packages: document GOPACKAGESDRIVER #34341

jmhodges opened this issue Sep 17, 2019 · 3 comments

Comments

@jmhodges
Copy link
Contributor

@jmhodges jmhodges commented Sep 17, 2019

There is currently no documentation that shows up on godoc.org for the GOPACKAGESDRIVER environment variable. However, it's very useful for alternative build systems to provide lookups for gopls and other tools. For instance, it's mentioned in the bazel rules_go design doc for editor support.

It'd be nice for GOPACKAGESDRIVER to have publicly available documents.

@toothrot

This comment has been minimized.

Copy link
Contributor

@toothrot toothrot commented Sep 17, 2019

This sounds related to https://golang.org/cl/184943, which documents this environment variable in the code: https://github.com/golang/tools/blob/3b4f30a44f3bd52b676ee9e88db10d11971b7363/go/packages/external.go#L19-L28

/cc @matloob who may be able to explain why this is not exposed in the public documentation.

@jmhodges

This comment has been minimized.

Copy link
Contributor Author

@jmhodges jmhodges commented Oct 3, 2019

Ping!

@matloob

This comment has been minimized.

Copy link
Contributor

@matloob matloob commented Oct 28, 2019

We didn't document GOPACKAGESDRIVER earlier because it wasn't as stable, but I think it's reasonable to add documentation now.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Linked pull requests

Successfully merging a pull request may close this issue.

None yet
4 participants
You can’t perform that action at this time.