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

Update the documentation on GOROOT_FINAL before release of go1.6 #13816

Closed
johnjaylward opened this issue Jan 4, 2016 · 1 comment
Closed

Comments

@johnjaylward
Copy link

see #13809

https://golang.org/cmd/go/#hdr-Environment_variables

The above documentation is very sparse and should be expanded. It is not clear enough on what this variable does and what it's used for. Some questions that should be answered in the documentation:

  • What are valid values? Does it have to be a valid go installation path, or can it be any value? (The documentation makes it sound like it should to be a valid go installation, but maybe not? It just says it's used to overwrite the stack trace, not that it's used for actual building)
  • Does it overwrite paths that are relative to GOPATH (i.e. user source), or only paths relative to GOROOT? (The documentation makes it sound like only GOROOT paths are overwritten)
  • When should the variable be used (i.e. under what use cases)? Currently, the documentation makes this variable seem downright useless. It doesn't appear to offer any benefit over the standard GOROOT.

Maybe more clarification could be added that I didn't think of.

@rsc
Copy link
Contributor

rsc commented Jan 5, 2016

I'm sorry for the runaround but I don't think GOROOT_FINAL should be any more documented than it already is in make.bash:

# GOROOT_FINAL: The expected final Go root, baked into binaries.
# The default is the location of the Go tree during the build.

It sets the default value of GOROOT for the built toolchain, and it sets the paths that show up in the binaries in that toolchain (like the go command and go compiler). It has nothing to do with user programs. I will comment more on #13809 for your specific problem, which GOROOT_FINAL does not solve.

@rsc rsc closed this as completed Jan 5, 2016
@golang golang locked and limited conversation to collaborators Jan 4, 2017
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Projects
None yet
Development

No branches or pull requests

3 participants