Skip to content

Commit 1ea9102

Browse files
authored
docs: correct some xrefs, add various missing Bazel external xrefs (#2907)
Adds a variety of Bazel builtins to the external Bazel inventory. Along the way, fFixes a couple of bad xrefs in rule_builders.
1 parent ec0dcd2 commit 1ea9102

File tree

2 files changed

+11
-3
lines changed

2 files changed

+11
-3
lines changed

python/private/rule_builders.bzl

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -253,7 +253,7 @@ def _ToolchainType_build(self):
253253
self: implicitly added
254254
255255
Returns:
256-
{type}`config_common.toolchain_type`
256+
{type}`toolchain_type`
257257
"""
258258
kwargs = dict(self.kwargs)
259259
name = kwargs.pop("name") # Name must be positional
@@ -673,7 +673,7 @@ def _AttrsDict_build(self):
673673
"""Build an attribute dict for passing to `rule()`.
674674
675675
Returns:
676-
{type}`dict[str, attribute]` where the values are `attr.XXX` objects
676+
{type}`dict[str, Attribute]` where the values are `attr.XXX` objects
677677
"""
678678
attrs = {}
679679
for k, v in self.map.items():

sphinxdocs/inventories/bazel_inventory.txt

Lines changed: 9 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,8 +3,10 @@
33
# Version: 7.3.0
44
# The remainder of this file is compressed using zlib
55
Action bzl:type 1 rules/lib/Action -
6+
Attribute bzl:type 1 rules/lib/builtins/Attribute -
67
CcInfo bzl:provider 1 rules/lib/providers/CcInfo -
78
CcInfo.linking_context bzl:provider-field 1 rules/lib/providers/CcInfo#linking_context -
9+
DefaultInfo bzl:type 1 rules/lib/providers/DefaultInfo -
810
ExecutionInfo bzl:type 1 rules/lib/providers/ExecutionInfo -
911
File bzl:type 1 rules/lib/File -
1012
Label bzl:type 1 rules/lib/Label -
@@ -38,6 +40,7 @@ config.string_list bzl:function 1 rules/lib/toplevel/config#string_list -
3840
config.target bzl:function 1 rules/lib/toplevel/config#target -
3941
config_common.FeatureFlagInfo bzl:type 1 rules/lib/toplevel/config_common#FeatureFlagInfo -
4042
config_common.toolchain_type bzl:function 1 rules/lib/toplevel/config_common#toolchain_type -
43+
ctx bzl:type 1 rules/lib/builtins/repository_ctx -
4144
ctx.actions bzl:obj 1 rules/lib/builtins/ctx#actions -
4245
ctx.aspect_ids bzl:obj 1 rules/lib/builtins/ctx#aspect_ids -
4346
ctx.attr bzl:obj 1 rules/lib/builtins/ctx#attr -
@@ -96,6 +99,7 @@ module_ctx.report_progress bzl:function 1 rules/lib/builtins/module_ctx#report_p
9699
module_ctx.root_module_has_non_dev_dependency bzl:function 1 rules/lib/builtins/module_ctx#root_module_has_non_dev_dependency -
97100
module_ctx.watch bzl:function 1 rules/lib/builtins/module_ctx#watch -
98101
module_ctx.which bzl:function 1 rules/lib/builtins/module_ctx#which -
102+
native bzl:obj 1 rules/lib/toplevel/native -
99103
native.existing_rule bzl:function 1 rules/lib/toplevel/native#existing_rule -
100104
native.existing_rules bzl:function 1 rules/lib/toplevel/native#existing_rules -
101105
native.exports_files bzl:function 1 rules/lib/toplevel/native#exports_files -
@@ -140,6 +144,8 @@ repository_os bzl:type 1 rules/lib/builtins/repository_os -
140144
repository_os.arch bzl:obj 1 rules/lib/builtins/repository_os#arch
141145
repository_os.environ bzl:obj 1 rules/lib/builtins/repository_os#environ
142146
repository_os.name bzl:obj 1 rules/lib/builtins/repository_os#name
147+
rule bzl:type 1 rules/lib/builtins/rule -
148+
rule bzl:function rules/lib/globals/bzl.html#rule -
143149
runfiles bzl:type 1 rules/lib/builtins/runfiles -
144150
runfiles.empty_filenames bzl:type 1 rules/lib/builtins/runfiles#empty_filenames -
145151
runfiles.files bzl:type 1 rules/lib/builtins/runfiles#files -
@@ -156,6 +162,8 @@ testing.TestEnvironment bzl:function 1 rules/lib/toplevel/testing#TestEnvironmen
156162
testing.analysis_test bzl:rule 1 rules/lib/toplevel/testing#analysis_test -
157163
toolchain bzl:rule 1 reference/be/platforms-and-toolchains#toolchain -
158164
toolchain.exec_compatible_with bzl:rule 1 reference/be/platforms-and-toolchains#toolchain.exec_compatible_with -
159-
toolchain.target_settings bzl:attr 1 reference/be/platforms-and-toolchains#toolchain.target_settings -
160165
toolchain.target_compatible_with bzl:attr 1 reference/be/platforms-and-toolchains#toolchain.target_compatible_with -
166+
toolchain.target_settings bzl:attr 1 reference/be/platforms-and-toolchains#toolchain.target_settings -
161167
toolchain_type bzl:type 1 rules/lib/builtins/toolchain_type.html -
168+
transition bzl:type 1 rules/lib/builtins/transition -
169+
tuple bzl:type 1 rules/lib/core/tuple -

0 commit comments

Comments
 (0)