Skip to content

Commit 0271bbc

Browse files
gregestrencopybara-github
authored andcommitted
Tweak configuration documentation
- "default configuration" -> "rule's current configuration" - Rendering bug at https://bazel.build/rules/lib/builtins/configuration#test_env. Closes #27714. PiperOrigin-RevId: 834387681 Change-Id: Ie4c0ce9de72e06fe6d60e26ef4c20a18229180c4
1 parent fe51591 commit 0271bbc

File tree

2 files changed

+7
-4
lines changed

2 files changed

+7
-4
lines changed

src/main/java/com/google/devtools/build/lib/starlarkbuildapi/BuildConfigurationApi.java

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -61,7 +61,7 @@ public interface BuildConfigurationApi extends StarlarkValue {
6161
structField = true,
6262
doc =
6363
"A dictionary containing user-specified test environment variables and their values, as"
64-
+ " set by the --test_env options. DO NOT USE! This is not the complete"
64+
+ " set by the <code>--test_env</code> options. DO NOT USE! This is not the complete"
6565
+ " environment!")
6666
ImmutableMap<String, String> getTestEnv();
6767

@@ -91,7 +91,8 @@ public interface BuildConfigurationApi extends StarlarkValue {
9191
<li>The value may differ across Bazel versions, including patch releases. \
9292
<li>The value encodes the value of <b>every</b> flag, including those that aren't \
9393
otherwise relevant for the current target and may thus invalidate caches more \
94-
frequently.
94+
frequently. \
95+
</ul>
9596
""")
9697
String getShortId();
9798

src/main/java/com/google/devtools/build/lib/starlarkbuildapi/StarlarkRuleContextApi.java

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -206,8 +206,10 @@ public interface StarlarkRuleContextApi<ConstraintValueT extends ConstraintValue
206206
name = "configuration",
207207
structField = true,
208208
doc =
209-
"The default configuration. See the <a href=\"../builtins/configuration.html\">"
210-
+ "configuration</a> type for more details.")
209+
"The current target's build configuration. See the <a"
210+
+ " href=\"../builtins/configuration.html\">Starlark configuration type</a> and <a"
211+
+ " href=\"/extending/rules#configurations\">configuration documentation</a> for more"
212+
+ " details.")
211213
BuildConfigurationApi getConfiguration() throws EvalException;
212214

213215
@StarlarkMethod(

0 commit comments

Comments
 (0)