Document visibility requirements #906
Conversation
The targets to rust_analyzer need to be visible to the root rust_analyzer. Unfortunately, because rust_analyzer is a singular rule at the source of the repo, any package_gorup based visibility will lead to cycles in the build graph. Thus, the rules must have //visibility:public.
Co-authored-by: UebelAndre <[email protected]>
|
:/ Something about my corp environment is making it difficult to run that. Any chance you could move those automated steps to github actions to make it easier to contribute in the future? |
It's likely having to download the stardoc jar... I've encountered the same. There's an open issue to address that on #695 but we're not sure what the right path forward is... |
|
@DavidSouther I've opened DavidSouther#1 which is just me having run the script on my machine. |
Regenerated Documentation
|
All (the pull request submitter and all commit authors) CLAs are signed, but one or more commits were authored or co-authored by someone other than the pull request submitter. We need to confirm that all authors are ok with their commits being contributed to this project. Please have them confirm that by leaving a comment that contains only Note to project maintainer: There may be cases where the author cannot leave a comment, or the comment is not properly detected as consent. In those cases, you can manually confirm consent of the commit author(s), and set the ℹ️ Googlers: Go here for more info. |
|
Haha awesome - by our powers combined! |
|
Oh dear, now the CLA bot has lost your ownership chain when I merged your commit into my branch |
|
@googlebot I consent. |
|
With our powers combined! We jumped through all the hoops! Thanks for opening this PR and sticking through it with me 😄 |
| @@ -51,7 +51,7 @@ A list of `rust_analyzer` compatible targets can be found by usign the following | |||
| bazel query 'kind("rust_*library|rust_binary", //...:all)' | |||
| ``` | |||
|
|
|||
| Note that visibility rules apply. | |||
| Note: __All `rust_*` targets provided to the root rust_analyzer must have `//visibility:public`.__ | |||
There was a problem hiding this comment.
It's actually not true - all rust targets provided to the rust_analyzer target have to be visible to the rust_analyzer target. That's a slightly weaker restriction.
There was a problem hiding this comment.
When I exposed the targets to the analyzer rule, either individually or via a package_group rule, Bazel failed analysis because of a circular dependency. If you know of another way to have two targets reference each other explicitly, please update the docs.
The targets to rust_analyzer need to be visible to the root rust_analyzer. Unfortunately, because rust_analyzer is a singular rule at the source of the repo, any package_gorup based visibility will lead to cycles in the build graph. Thus, the rules must have //visibility:public.
See conversation in #905