aboutsummaryrefslogtreecommitdiffhomepage
path: root/src/main/java/com/google/devtools/build/lib/rules/config
diff options
context:
space:
mode:
authorGravatar Dan Fabulich <DanFabulich@gmail.com>2018-07-05 16:08:06 -0700
committerGravatar Copybara-Service <copybara-piper@google.com>2018-07-05 16:10:02 -0700
commit1d35ca03b8a1c431937a9be74a9efedc15b5707a (patch)
treef1f0c20ac99ec54c450de0d238d5213758c4cbe0 /src/main/java/com/google/devtools/build/lib/rules/config
parent2b62182c9854321396d7d287e8b645261d9cda82 (diff)
Replace instances of Blaze with Bazel.
PiperOrigin-RevId: 203300374 Change-Id: Iaa47f870ab2e0cad40a202aad2c7f9430f73c856 PiperOrigin-RevId: 203407392
Diffstat (limited to 'src/main/java/com/google/devtools/build/lib/rules/config')
-rw-r--r--src/main/java/com/google/devtools/build/lib/rules/config/ConfigRuleClasses.java204
1 files changed, 102 insertions, 102 deletions
diff --git a/src/main/java/com/google/devtools/build/lib/rules/config/ConfigRuleClasses.java b/src/main/java/com/google/devtools/build/lib/rules/config/ConfigRuleClasses.java
index bf0256ab92..8c5966bab4 100644
--- a/src/main/java/com/google/devtools/build/lib/rules/config/ConfigRuleClasses.java
+++ b/src/main/java/com/google/devtools/build/lib/rules/config/ConfigRuleClasses.java
@@ -139,21 +139,21 @@ public class ConfigRuleClasses {
public RuleClass build(RuleClass.Builder builder, RuleDefinitionEnvironment env) {
return builder
/* <!-- #BLAZE_RULE(config_setting).ATTRIBUTE(values) -->
- The set of configuration values that match this rule (expressed as Blaze flags)
+ The set of configuration values that match this rule (expressed as Bazel flags)
<i>(Dictionary mapping flags to expected values, both expressed as strings;
mandatory)</i>
<p>This rule inherits the configuration of the configured target that
references it in a <code>select</code> statement. It is considered to
- "match" a Blaze invocation if, for every entry in the dictionary, its
+ "match" a Bazel invocation if, for every entry in the dictionary, its
configuration matches the entry's expected value. For example
<code>values = {"compilation_mode": "opt"}</code> matches the invocations
- <code>blaze build --compilation_mode=opt ...</code> and
- <code>blaze build -c opt ...</code> on target-configured rules.
+ <code>bazel build --compilation_mode=opt ...</code> and
+ <code>bazel build -c opt ...</code> on target-configured rules.
</p>
- <p>For convenience's sake, configuration values are specified as Blaze flags (without
+ <p>For convenience's sake, configuration values are specified as Bazel flags (without
the preceding <code>"--"</code>). But keep in mind that the two are not the same. This
is because targets can be built in multiple configurations within the same
build. For example, a host configuration's "cpu" matches the value of
@@ -165,7 +165,7 @@ public class ConfigRuleClasses {
<p>If a flag is not explicitly set at the command line, its default value is used.
If a key appears multiple times in the dictionary, only the last instance is used.
If a key references a flag that can be set multiple times on the command line (e.g.
- <code>blaze build --copt=foo --copt=bar --copt=baz ...</code>), a match occurs if
+ <code>bazel build --copt=foo --copt=bar --copt=baz ...</code>), a match occurs if
<i>any</i> of those settings match.
<p>
@@ -183,10 +183,10 @@ public class ConfigRuleClasses {
<p><code>--define</code> is special for two reasons:
<ol>
- <li>It's the primary interface Blaze has today for declaring user-definable settings.
+ <li>It's the primary interface Bazel has today for declaring user-definable settings.
</li>
<li>Its syntax (<code>--define KEY=VAL</code>) means <code>KEY=VAL</code> is
- a <i>value</i> from a Blaze flag perspective.</li>
+ a <i>value</i> from a Bazel flag perspective.</li>
</ol>
<p>That means:
@@ -212,7 +212,7 @@ public class ConfigRuleClasses {
})
</pre>
- <p>corrrectly matches <code>blaze build //foo --define a=1 --define b=2</code>.
+ <p>corrrectly matches <code>bazel build //foo --define a=1 --define b=2</code>.
<p><code>--define</code> can still appear in
<a href="${link config_setting.values}"><code>values</code></a> with normal flag syntax,
@@ -248,12 +248,12 @@ public class ConfigRuleClasses {
<p>As mentioned above, this rule inherits the configuration of the configured target that
references it in a <code>select</code> statement. This <code>constraint_values</code>
- attribute is considered to "match" a Blaze invocation if it includes each
+ attribute is considered to "match" a Bazel invocation if it includes each
<code>constraint_value</code> specified in the configuration's target platform which is
set with the command line flag <code>--experimental_platforms</code>. If it contains
extra <code>constraint_values</code> not included in the target platform, it is still
considered a match. In this example, both <code>slate</code> and
- <code>marble</code> would be considered matches for a blaze invocation which
+ <code>marble</code> would be considered matches for a bazel invocation which
uses <code>--experimental_platforms=my_platform_rocks</code>. Multiple matches like this
may lead to ambiguous select resolves and are not allowed.
</p>
@@ -302,97 +302,97 @@ public class ConfigRuleClasses {
.build();
}
}
-/*<!-- #BLAZE_RULE (NAME = config_setting, TYPE = OTHER, FAMILY = General)[GENERIC_RULE] -->
-
-<p>
- Matches an expected configuration state (expressed as Blaze flags) for the purpose of triggering
- configurable attributes. See <a href="${link select}">select</a> for how to consume this
- rule and <a href="${link common-definitions#configurable-attributes}">
- Configurable attributes</a> for an overview of the general feature.
-
-<h4 id="config_setting_examples">Examples</h4>
-
-<p>The following matches any Blaze invocation that specifies <code>--compilation_mode=opt</code>
- or <code>-c opt</code> (either explicitly at the command line or implicitly from .blazerc
- files, etc.), when applied to a target configuration rule:
-</p>
-
-<pre class="code">
-config_setting(
- name = "simple",
- values = {"compilation_mode": "opt"}
-)
-</pre>
-
-<p>The following matches any Blaze invocation that builds for ARM and applies a custom define
- (e.g. <code>blaze build --cpu=armeabi --define FOO=bar ...</code>), when applied to a target
- configuration rule:
-</p>
-
-<pre class="code">
-config_setting(
- name = "two_conditions",
- values = {
- "cpu": "armeabi",
- "define": "FOO=bar"
- }
-)
-</pre>
-
-<p>The following config_setting matches any Blaze invocation that builds a platform which contains
- exactly the same or a subset of its constraint_values (like the example below).
-</p>
-
-<pre class=""code">
-config_setting(
- name = "marble",
- constraint_values = [
- "white",
- "metamorphic",
- ]
-)
-
-platform(
- name = "marble_platform",
- constraint_values = [
- "white",
- "metamorphic"
- ]
-)
-</pre>
-
-<h4 id="config_setting_notes">Notes</h4>
-
-<p>See <a href="${link select}">select</a> for policies on what happens depending on how
- many rules match an invocation.
-</p>
-
-<p>For flags that support shorthand forms (e.g. <code>--compilation_mode</code> vs.
- <code>-c</code>), <code>values</code> definitions must use the full form. These automatically
- match invocations using either form.
-</p>
-
-<p>The currently endorsed method for creating custom conditions that can't be expressed through
- dedicated build flags is through the --define flag. Use this flag with caution: it's not ideal
- and only endorsed for lack of a currently better workaround. See the
- <a href="${link common-definitions#configurable-attributes}">
- Configurable attributes</a> section for more discussion.
-</p>
-
-<p>Try to consolidate <code>config_setting</code> definitions as much as possible. In other words,
- define <code>//common/conditions:foo</code> in one common package instead of repeating separate
- instances in <code>//project1:foo</code>, <code>//project2:foo</code>, etc. that all mean the
- same thing.
-</p>
-
-<p><a href="general.html#config_setting.values"><code>values</code></a>,
- <a href="general.html#config_setting.define_values"><code>define_values</code></a>, and
- <a href=general.html#config_setting.constraint_values"><code>constraint_values</code></a>
- can be used in any combination in the same config_setting but at least one must be set for any
- given config_setting.
-</p>
-
-<!-- #END_BLAZE_RULE -->*/
+ /*<!-- #BLAZE_RULE (NAME = config_setting, TYPE = OTHER, FAMILY = General)[GENERIC_RULE] -->
+
+ <p>
+ Matches an expected configuration state (expressed as Bazel flags) for the purpose of triggering
+ configurable attributes. See <a href="${link select}">select</a> for how to consume this
+ rule and <a href="${link common-definitions#configurable-attributes}">
+ Configurable attributes</a> for an overview of the general feature.
+
+ <h4 id="config_setting_examples">Examples</h4>
+
+ <p>The following matches any Bazel invocation that specifies <code>--compilation_mode=opt</code>
+ or <code>-c opt</code> (either explicitly at the command line or implicitly from .blazerc
+ files, etc.), when applied to a target configuration rule:
+ </p>
+
+ <pre class="code">
+ config_setting(
+ name = "simple",
+ values = {"compilation_mode": "opt"}
+ )
+ </pre>
+
+ <p>The following matches any Bazel invocation that builds for ARM and applies a custom define
+ (e.g. <code>bazel build --cpu=armeabi --define FOO=bar ...</code>), when applied to a target
+ configuration rule:
+ </p>
+
+ <pre class="code">
+ config_setting(
+ name = "two_conditions",
+ values = {
+ "cpu": "armeabi",
+ "define": "FOO=bar"
+ }
+ )
+ </pre>
+
+ <p>The following config_setting matches any Bazel invocation that builds a platform which contains
+ exactly the same or a subset of its constraint_values (like the example below).
+ </p>
+
+ <pre class=""code">
+ config_setting(
+ name = "marble",
+ constraint_values = [
+ "white",
+ "metamorphic",
+ ]
+ )
+
+ platform(
+ name = "marble_platform",
+ constraint_values = [
+ "white",
+ "metamorphic"
+ ]
+ )
+ </pre>
+
+ <h4 id="config_setting_notes">Notes</h4>
+
+ <p>See <a href="${link select}">select</a> for policies on what happens depending on how
+ many rules match an invocation.
+ </p>
+
+ <p>For flags that support shorthand forms (e.g. <code>--compilation_mode</code> vs.
+ <code>-c</code>), <code>values</code> definitions must use the full form. These automatically
+ match invocations using either form.
+ </p>
+
+ <p>The currently endorsed method for creating custom conditions that can't be expressed through
+ dedicated build flags is through the --define flag. Use this flag with caution: it's not ideal
+ and only endorsed for lack of a currently better workaround. See the
+ <a href="${link common-definitions#configurable-attributes}">
+ Configurable attributes</a> section for more discussion.
+ </p>
+
+ <p>Try to consolidate <code>config_setting</code> definitions as much as possible. In other words,
+ define <code>//common/conditions:foo</code> in one common package instead of repeating separate
+ instances in <code>//project1:foo</code>, <code>//project2:foo</code>, etc. that all mean the
+ same thing.
+ </p>
+
+ <p><a href="general.html#config_setting.values"><code>values</code></a>,
+ <a href="general.html#config_setting.define_values"><code>define_values</code></a>, and
+ <a href=general.html#config_setting.constraint_values"><code>constraint_values</code></a>
+ can be used in any combination in the same config_setting but at least one must be set for any
+ given config_setting.
+ </p>
+
+ <!-- #END_BLAZE_RULE -->*/
/** Rule definition for Android's config_feature_flag rule. */
public static final class ConfigFeatureFlagRule implements RuleDefinition {