Skip to content

gopls/doc: clarify go work use #409

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.

Sign up for GitHub

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

Jump to bottom
Closed
wants to merge 1 commit into from
Closed

gopls/doc: clarify go work use #409

wants to merge 1 commit into from

Conversation

angaz
Copy link
Contributor

@angaz angaz commented Oct 9, 2022

I felt a bit confused on my first reading of the docs for using go work.

It wasn't clear to me if the tools argument in go work use tools tools/gopls was an alias or a directory name, so I thought this might make it very clear to understand for first time users.

@gopherbot
Copy link
Contributor

This PR (HEAD: 5a41c78) has been imported to Gerrit for code review.

Please visit https://go-review.googlesource.com/c/tools/+/441415 to see it.

Tip: You can toggle comments from me using the comments slash command (e.g. /comments off)
See the Wiki page for more info

@gopherbot
Copy link
Contributor

Message from Gopher Robot:

Patch Set 1:

Congratulations on opening your first change. Thank you for your contribution!

Next steps:
A maintainer will review your change and provide feedback. See
https://go.dev/doc/contribute#review for more info and tips to get your
patch through code review.

Most changes in the Go project go through a few rounds of revision. This can be
surprising to people new to the project. The careful, iterative review process
is our way of helping mentor contributors and ensuring that their contributions
have a lasting impact.

Please don’t reply on this GitHub thread. Visit golang.org/cl/441415.
After addressing review feedback, remember to publish your drafts!

@gopherbot
Copy link
Contributor

Message from Robert Findley:

Patch Set 1: Code-Review+2

(2 comments)

Please don’t reply on this GitHub thread. Visit golang.org/cl/441415.
After addressing review feedback, remember to publish your drafts!

@gopherbot
Copy link
Contributor

Message from Robert Findley:

Patch Set 1: -Code-Review

Please don’t reply on this GitHub thread. Visit golang.org/cl/441415.
After addressing review feedback, remember to publish your drafts!

@gopherbot
Copy link
Contributor

Message from Robert Findley:

Patch Set 1: Run-TryBot+1

Please don’t reply on this GitHub thread. Visit golang.org/cl/441415.
After addressing review feedback, remember to publish your drafts!

@gopherbot
Copy link
Contributor

Message from Gopher Robot:

Patch Set 1:

(1 comment)

Please don’t reply on this GitHub thread. Visit golang.org/cl/441415.
After addressing review feedback, remember to publish your drafts!

@gopherbot
Copy link
Contributor

Message from kokoro:

Patch Set 1:

Kokoro presubmit build starting for golang/tools/gopls-legacy/presubmit
Logs at:
https://source.cloud.google.com/results/invocations/deb63dfa-dcec-46b1-ae79-ca61ef380ed3

Please don’t reply on this GitHub thread. Visit golang.org/cl/441415.
After addressing review feedback, remember to publish your drafts!

@gopherbot
Copy link
Contributor

Message from Gopher Robot:

Patch Set 1:

(1 comment)

Please don’t reply on this GitHub thread. Visit golang.org/cl/441415.
After addressing review feedback, remember to publish your drafts!

@gopherbot
Copy link
Contributor

Message from kokoro:

Patch Set 1: gopls-CI+1

Kokoro presubmit build finished with status: SUCCESS
Logs at: https://source.cloud.google.com/results/invocations/deb63dfa-dcec-46b1-ae79-ca61ef380ed3

Please don’t reply on this GitHub thread. Visit golang.org/cl/441415.
After addressing review feedback, remember to publish your drafts!

@gopherbot
Copy link
Contributor

Message from Robert Findley:

Patch Set 1:

(1 comment)

Please don’t reply on this GitHub thread. Visit golang.org/cl/441415.
After addressing review feedback, remember to publish your drafts!

@gopherbot
Copy link
Contributor

Message from Gopher Robot:

Patch Set 1: TryBot-Result-1

(1 comment)

Please don’t reply on this GitHub thread. Visit golang.org/cl/441415.
After addressing review feedback, remember to publish your drafts!

@gopherbot
Copy link
Contributor

Message from Angus Dippenaar:

Patch Set 1:

(1 comment)

Please don’t reply on this GitHub thread. Visit golang.org/cl/441415.
After addressing review feedback, remember to publish your drafts!

@gopherbot
Copy link
Contributor

Message from Robert Findley:

Patch Set 1:

(1 comment)

Please don’t reply on this GitHub thread. Visit golang.org/cl/441415.
After addressing review feedback, remember to publish your drafts!

@angaz angaz changed the title clarify go work use gopls/doc: clarify go work use Nov 8, 2022
@angaz angaz force-pushed the clarify_go_work_use branch from 5a41c78 to 9ef2018 Compare November 8, 2022 15:02
@gopherbot
Copy link
Contributor

This PR (HEAD: 9ef2018) has been imported to Gerrit for code review.

Please visit https://go-review.googlesource.com/c/tools/+/441415 to see it.

Tip: You can toggle comments from me using the comments slash command (e.g. /comments off)
See the Wiki page for more info

@angaz angaz force-pushed the clarify_go_work_use branch from 9ef2018 to cfd04a1 Compare November 8, 2022 15:08
@gopherbot
Copy link
Contributor

This PR (HEAD: cfd04a1) has been imported to Gerrit for code review.

Please visit https://go-review.googlesource.com/c/tools/+/441415 to see it.

Tip: You can toggle comments from me using the comments slash command (e.g. /comments off)
See the Wiki page for more info

@gopherbot
Copy link
Contributor

Message from kokoro:

Patch Set 2:

Kokoro presubmit build starting for golang/tools/gopls-legacy/presubmit
Logs at:
https://source.cloud.google.com/results/invocations/949dff81-042c-4a29-b130-bd4c423399fd

Please don’t reply on this GitHub thread. Visit golang.org/cl/441415.
After addressing review feedback, remember to publish your drafts!

@gopherbot
Copy link
Contributor

Message from Angus Dippenaar:

Patch Set 2:

(3 comments)

Please don’t reply on this GitHub thread. Visit golang.org/cl/441415.
After addressing review feedback, remember to publish your drafts!

@gopherbot
Copy link
Contributor

Message from kokoro:

Patch Set 2: gopls-CI+1

Kokoro presubmit build finished with status: SUCCESS
Logs at: https://source.cloud.google.com/results/invocations/949dff81-042c-4a29-b130-bd4c423399fd

Please don’t reply on this GitHub thread. Visit golang.org/cl/441415.
After addressing review feedback, remember to publish your drafts!

@gopherbot
Copy link
Contributor

Message from Robert Findley:

Patch Set 3: Run-TryBot+1

Please don’t reply on this GitHub thread. Visit golang.org/cl/441415.
After addressing review feedback, remember to publish your drafts!

@angaz angaz force-pushed the clarify_go_work_use branch from cfd04a1 to 2745ee5 Compare November 8, 2022 15:48
@gopherbot
Copy link
Contributor

Message from Gopher Robot:

Patch Set 3:

(1 comment)

Please don’t reply on this GitHub thread. Visit golang.org/cl/441415.
After addressing review feedback, remember to publish your drafts!

@gopherbot
Copy link
Contributor

Message from Gopher Robot:

Patch Set 3:

(1 comment)

Please don’t reply on this GitHub thread. Visit golang.org/cl/441415.
After addressing review feedback, remember to publish your drafts!

@gopherbot
Copy link
Contributor

Message from kokoro:

Patch Set 3:

Kokoro presubmit build starting for golang/tools/gopls-legacy/presubmit
Logs at:
https://source.cloud.google.com/results/invocations/c18ca881-55a0-4629-aa0d-069101a9c9c5

Please don’t reply on this GitHub thread. Visit golang.org/cl/441415.
After addressing review feedback, remember to publish your drafts!

@gopherbot
Copy link
Contributor

This PR (HEAD: 2745ee5) has been imported to Gerrit for code review.

Please visit https://go-review.googlesource.com/c/tools/+/441415 to see it.

Tip: You can toggle comments from me using the comments slash command (e.g. /comments off)
See the Wiki page for more info

@gopherbot
Copy link
Contributor

Message from Gopher Robot:

Patch Set 3: TryBot-Result-1

(1 comment)

Please don’t reply on this GitHub thread. Visit golang.org/cl/441415.
After addressing review feedback, remember to publish your drafts!

@gopherbot
Copy link
Contributor

Message from kokoro:

Patch Set 3: gopls-CI+1

Kokoro presubmit build finished with status: SUCCESS
Logs at: https://source.cloud.google.com/results/invocations/c18ca881-55a0-4629-aa0d-069101a9c9c5

Please don’t reply on this GitHub thread. Visit golang.org/cl/441415.
After addressing review feedback, remember to publish your drafts!

@gopherbot
Copy link
Contributor

Message from Robert Findley:

Patch Set 3:

(2 comments)

Please don’t reply on this GitHub thread. Visit golang.org/cl/441415.
After addressing review feedback, remember to publish your drafts!

@angaz angaz force-pushed the clarify_go_work_use branch from 2745ee5 to eb7dcb0 Compare November 8, 2022 15:59
@angaz angaz force-pushed the clarify_go_work_use branch from eb7dcb0 to 49e125d Compare November 8, 2022 16:01
@gopherbot
Copy link
Contributor

This PR (HEAD: 49e125d) has been imported to Gerrit for code review.

Please visit https://go-review.googlesource.com/c/tools/+/441415 to see it.

Tip: You can toggle comments from me using the comments slash command (e.g. /comments off)
See the Wiki page for more info

@gopherbot
Copy link
Contributor

Message from Angus Dippenaar:

Patch Set 4:

(2 comments)

Please don’t reply on this GitHub thread. Visit golang.org/cl/441415.
After addressing review feedback, remember to publish your drafts!

@gopherbot
Copy link
Contributor

Message from Robert Findley:

Patch Set 5: Run-TryBot+1

Please don’t reply on this GitHub thread. Visit golang.org/cl/441415.
After addressing review feedback, remember to publish your drafts!

@gopherbot
Copy link
Contributor

Message from Gopher Robot:

Patch Set 5:

(1 comment)

Please don’t reply on this GitHub thread. Visit golang.org/cl/441415.
After addressing review feedback, remember to publish your drafts!

@gopherbot
Copy link
Contributor

Message from kokoro:

Patch Set 5:

Kokoro presubmit build starting for golang/tools/gopls-legacy/presubmit
Logs at:
https://source.cloud.google.com/results/invocations/351cde84-8ee0-4ad6-820b-924ecd1e680a

Please don’t reply on this GitHub thread. Visit golang.org/cl/441415.
After addressing review feedback, remember to publish your drafts!

@gopherbot
Copy link
Contributor

Message from kokoro:

Patch Set 5: gopls-CI+1

Kokoro presubmit build finished with status: SUCCESS
Logs at: https://source.cloud.google.com/results/invocations/351cde84-8ee0-4ad6-820b-924ecd1e680a

Please don’t reply on this GitHub thread. Visit golang.org/cl/441415.
After addressing review feedback, remember to publish your drafts!

@gopherbot
Copy link
Contributor

Message from Gopher Robot:

Patch Set 5: TryBot-Result+1

(1 comment)

Please don’t reply on this GitHub thread. Visit golang.org/cl/441415.
After addressing review feedback, remember to publish your drafts!

gopherbot pushed a commit that referenced this pull request Nov 8, 2022
@angaz @findleyr
gopls/doc: clarify go work use
9474ca3 
I felt a bit confused on my first reading of the docs for using `go work`.

It wasn't clear to me if the `tools` argument in `go work use tools tools/gopls` was an alias or a directory name, so I thought this might make it very clear to understand for first time users.

Change-Id: I9c5a04a8928207b53acfb36ce7add8ca5f033d46
GitHub-Last-Rev: 49e125d
GitHub-Pull-Request: #409
Reviewed-on: https://go-review.googlesource.com/c/tools/+/441415
TryBot-Result: Gopher Robot <[email protected]>
gopls-CI: kokoro <[email protected]>
Reviewed-by: Suzy Mueller <[email protected]>
Reviewed-by: Robert Findley <[email protected]>
Run-TryBot: Robert Findley <[email protected]>
@gopherbot
Copy link
Contributor

This PR is being closed because golang.org/cl/441415 has been merged.

@gopherbot gopherbot closed this Nov 8, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers
No reviews
Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
2 participants
@angaz @gopherbot