Updated documentation of go_prefix flag #1046
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
jayconrod
reviewed
May 14, 2021
README.rst
Outdated
| @@ -381,8 +381,9 @@ The following flags are accepted: | |||
| | :flag:`-go_prefix example.com/repo` | | | |||
| +--------------------------------------------------------------+----------------------------------------+ | |||
| | A prefix of import paths for libraries in the repository that corresponds to | | |||
| | the repository root. Gazelle infers this from the ``go_prefix`` rule in the | | |||
| | root BUILD.bazel file, if it exists. If not, this option is mandatory. | | |||
| | the repository root. Gazelle infers this from the ``# gazelle:prefix`` directive | | |||
There was a problem hiding this comment.
It would be more accurate to say that setting -go_prefix on the command line is equivalent to putting a # gazelle:prefix directive in the root build file. The prefix attribute on the gazelle rule actually causes gazelle to be invoked with this flag.
There was a problem hiding this comment.
Ah, I think I get it. It's updated. Does it makes sense now?
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
What type of PR is this?
Documentation
What does this PR do? Why is it needed?
It updates the description of the
go_prefixflag, since the go_prefix rule no longer exists. Hopefully my understanding is correct.