diff options
Diffstat (limited to 'docs/common_settings_doc.md')
| -rwxr-xr-x | docs/common_settings_doc.md | 301 |
1 files changed, 90 insertions, 211 deletions
diff --git a/docs/common_settings_doc.md b/docs/common_settings_doc.md index 676f070..736e48c 100755 --- a/docs/common_settings_doc.md +++ b/docs/common_settings_doc.md @@ -1,6 +1,15 @@ <!-- Generated with Stardoc: http://skydoc.bazel.build --> -<a name="#bool_flag"></a> +Common build setting rules + +These rules return a BuildSettingInfo with the value of the build setting. +For label-typed settings, use the native label_flag and label_setting rules. + +More documentation on how to use build settings at +https://docs.bazel.build/versions/main/skylark/config.html#user-defined-build-settings + + +<a id="#bool_flag"></a> ## bool_flag @@ -10,28 +19,15 @@ bool_flag(<a href="#bool_flag-name">name</a>) A bool-typed build setting that can be set on the command line -### Attributes - -<table class="params-table"> - <colgroup> - <col class="col-param" /> - <col class="col-description" /> - </colgroup> - <tbody> - <tr id="bool_flag-name"> - <td><code>name</code></td> - <td> - <a href="https://bazel.build/docs/build-ref.html#name">Name</a>; required - <p> - A unique name for this target. - </p> - </td> - </tr> - </tbody> -</table> - - -<a name="#bool_setting"></a> +**ATTRIBUTES** + + +| Name | Description | Type | Mandatory | Default | +| :------------- | :------------- | :------------- | :------------- | :------------- | +| <a id="bool_flag-name"></a>name | A unique name for this target. | <a href="https://bazel.build/docs/build-ref.html#name">Name</a> | required | | + + +<a id="#bool_setting"></a> ## bool_setting @@ -41,28 +37,15 @@ bool_setting(<a href="#bool_setting-name">name</a>) A bool-typed build setting that cannot be set on the command line -### Attributes - -<table class="params-table"> - <colgroup> - <col class="col-param" /> - <col class="col-description" /> - </colgroup> - <tbody> - <tr id="bool_setting-name"> - <td><code>name</code></td> - <td> - <a href="https://bazel.build/docs/build-ref.html#name">Name</a>; required - <p> - A unique name for this target. - </p> - </td> - </tr> - </tbody> -</table> - - -<a name="#int_flag"></a> +**ATTRIBUTES** + + +| Name | Description | Type | Mandatory | Default | +| :------------- | :------------- | :------------- | :------------- | :------------- | +| <a id="bool_setting-name"></a>name | A unique name for this target. | <a href="https://bazel.build/docs/build-ref.html#name">Name</a> | required | | + + +<a id="#int_flag"></a> ## int_flag @@ -72,28 +55,15 @@ int_flag(<a href="#int_flag-name">name</a>) An int-typed build setting that can be set on the command line -### Attributes - -<table class="params-table"> - <colgroup> - <col class="col-param" /> - <col class="col-description" /> - </colgroup> - <tbody> - <tr id="int_flag-name"> - <td><code>name</code></td> - <td> - <a href="https://bazel.build/docs/build-ref.html#name">Name</a>; required - <p> - A unique name for this target. - </p> - </td> - </tr> - </tbody> -</table> - - -<a name="#int_setting"></a> +**ATTRIBUTES** + + +| Name | Description | Type | Mandatory | Default | +| :------------- | :------------- | :------------- | :------------- | :------------- | +| <a id="int_flag-name"></a>name | A unique name for this target. | <a href="https://bazel.build/docs/build-ref.html#name">Name</a> | required | | + + +<a id="#int_setting"></a> ## int_setting @@ -103,28 +73,15 @@ int_setting(<a href="#int_setting-name">name</a>) An int-typed build setting that cannot be set on the command line -### Attributes - -<table class="params-table"> - <colgroup> - <col class="col-param" /> - <col class="col-description" /> - </colgroup> - <tbody> - <tr id="int_setting-name"> - <td><code>name</code></td> - <td> - <a href="https://bazel.build/docs/build-ref.html#name">Name</a>; required - <p> - A unique name for this target. - </p> - </td> - </tr> - </tbody> -</table> - - -<a name="#string_flag"></a> +**ATTRIBUTES** + + +| Name | Description | Type | Mandatory | Default | +| :------------- | :------------- | :------------- | :------------- | :------------- | +| <a id="int_setting-name"></a>name | A unique name for this target. | <a href="https://bazel.build/docs/build-ref.html#name">Name</a> | required | | + + +<a id="#string_flag"></a> ## string_flag @@ -134,37 +91,16 @@ string_flag(<a href="#string_flag-name">name</a>, <a href="#string_flag-values"> A string-typed build setting that can be set on the command line -### Attributes - -<table class="params-table"> - <colgroup> - <col class="col-param" /> - <col class="col-description" /> - </colgroup> - <tbody> - <tr id="string_flag-name"> - <td><code>name</code></td> - <td> - <a href="https://bazel.build/docs/build-ref.html#name">Name</a>; required - <p> - A unique name for this target. - </p> - </td> - </tr> - <tr id="string_flag-values"> - <td><code>values</code></td> - <td> - List of strings; optional - <p> - The list of allowed values for this setting. An error is raised if any other value is given. - </p> - </td> - </tr> - </tbody> -</table> - - -<a name="#string_list_flag"></a> +**ATTRIBUTES** + + +| Name | Description | Type | Mandatory | Default | +| :------------- | :------------- | :------------- | :------------- | :------------- | +| <a id="string_flag-name"></a>name | A unique name for this target. | <a href="https://bazel.build/docs/build-ref.html#name">Name</a> | required | | +| <a id="string_flag-values"></a>values | The list of allowed values for this setting. An error is raised if any other value is given. | List of strings | optional | [] | + + +<a id="#string_list_flag"></a> ## string_list_flag @@ -174,28 +110,15 @@ string_list_flag(<a href="#string_list_flag-name">name</a>) A string list-typed build setting that can be set on the command line -### Attributes - -<table class="params-table"> - <colgroup> - <col class="col-param" /> - <col class="col-description" /> - </colgroup> - <tbody> - <tr id="string_list_flag-name"> - <td><code>name</code></td> - <td> - <a href="https://bazel.build/docs/build-ref.html#name">Name</a>; required - <p> - A unique name for this target. - </p> - </td> - </tr> - </tbody> -</table> - - -<a name="#string_list_setting"></a> +**ATTRIBUTES** + + +| Name | Description | Type | Mandatory | Default | +| :------------- | :------------- | :------------- | :------------- | :------------- | +| <a id="string_list_flag-name"></a>name | A unique name for this target. | <a href="https://bazel.build/docs/build-ref.html#name">Name</a> | required | | + + +<a id="#string_list_setting"></a> ## string_list_setting @@ -205,28 +128,15 @@ string_list_setting(<a href="#string_list_setting-name">name</a>) A string list-typed build setting that cannot be set on the command line -### Attributes - -<table class="params-table"> - <colgroup> - <col class="col-param" /> - <col class="col-description" /> - </colgroup> - <tbody> - <tr id="string_list_setting-name"> - <td><code>name</code></td> - <td> - <a href="https://bazel.build/docs/build-ref.html#name">Name</a>; required - <p> - A unique name for this target. - </p> - </td> - </tr> - </tbody> -</table> - - -<a name="#string_setting"></a> +**ATTRIBUTES** + + +| Name | Description | Type | Mandatory | Default | +| :------------- | :------------- | :------------- | :------------- | :------------- | +| <a id="string_list_setting-name"></a>name | A unique name for this target. | <a href="https://bazel.build/docs/build-ref.html#name">Name</a> | required | | + + +<a id="#string_setting"></a> ## string_setting @@ -236,37 +146,16 @@ string_setting(<a href="#string_setting-name">name</a>, <a href="#string_setting A string-typed build setting that cannot be set on the command line -### Attributes - -<table class="params-table"> - <colgroup> - <col class="col-param" /> - <col class="col-description" /> - </colgroup> - <tbody> - <tr id="string_setting-name"> - <td><code>name</code></td> - <td> - <a href="https://bazel.build/docs/build-ref.html#name">Name</a>; required - <p> - A unique name for this target. - </p> - </td> - </tr> - <tr id="string_setting-values"> - <td><code>values</code></td> - <td> - List of strings; optional - <p> - The list of allowed values for this setting. An error is raised if any other value is given. - </p> - </td> - </tr> - </tbody> -</table> - - -<a name="#BuildSettingInfo"></a> +**ATTRIBUTES** + + +| Name | Description | Type | Mandatory | Default | +| :------------- | :------------- | :------------- | :------------- | :------------- | +| <a id="string_setting-name"></a>name | A unique name for this target. | <a href="https://bazel.build/docs/build-ref.html#name">Name</a> | required | | +| <a id="string_setting-values"></a>values | The list of allowed values for this setting. An error is raised if any other value is given. | List of strings | optional | [] | + + +<a id="#BuildSettingInfo"></a> ## BuildSettingInfo @@ -276,21 +165,11 @@ BuildSettingInfo(<a href="#BuildSettingInfo-value">value</a>) A singleton provider that contains the raw value of a build setting -### Fields - -<table class="params-table"> - <colgroup> - <col class="col-param" /> - <col class="col-description" /> - </colgroup> - <tbody> - <tr id="BuildSettingInfo-value"> - <td><code>value</code></td> - <td> - <p>The value of the build setting in the current configuration. This value may come from the command line or an upstream transition, or else it will be the build setting's default.</p> - </td> - </tr> - </tbody> -</table> +**FIELDS** + + +| Name | Description | +| :------------- | :------------- | +| <a id="BuildSettingInfo-value"></a>value | The value of the build setting in the current configuration. This value may come from the command line or an upstream transition, or else it will be the build setting's default. | |