refactor(sphinxdocs): use bazel label format for internal object tracking#2174
Merged
aignas merged 1 commit intobazel-contrib:mainfrom Sep 2, 2024
Merged
Conversation
246fef1 to
f949721
Compare
f949721 to
d0c249d
Compare
aignas
approved these changes
Sep 2, 2024
This file contains hidden or 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
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.
This changes the way objects are tracked to use Bazel label format instead of dotted notation.
The dotted notation was problematic because it was ambiguous. For example,
foo.bar.bazcould mean
@foo//bar:bazor@foo//:bar.bzl%baz. It also required various internal hacksto try and "unparse" the dotted notation into the "meaningful" part of an object to use
in various contexts. For example,
//foo:barusually meansbaris the key term toshow, and
//foo:bar.bzl%baz.quxusually meansquxorbaz.quxis the meaningful part.Also:
baz.quxcan beused to reference
//foo:bar.bzl%baz.qux--jobs=autoforsphinx_run; multi-job invocations of Sphinx make it difficultto interactively run Sphinx for debugging, which is the point of
sphinx_run--nameformat force looking in the flag object type. This avoids findingobjects of a matching name of another object type; e.g "precompile" is both a flag and
attribute name.
e.g. "foo (target in //bar)" instead of "//foo:bar (target in //bar:BUILD.bazel)"