bazel
/
bazel-skylib
mirror of https://github.com/bazelbuild/bazel-skylib
2
0
Fork 0
Code Issues Releases Activity

Update common_settings.bzl (#552) 

add scope attr to string_setting
This commit is contained in:
Ara Nguyen 2024-11-06 17:52:21 -05:00 committed by GitHub
parent e853fd4ed6
commit 505e1bc3aa
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194
2 changed files with 6 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

3
docs/common_settings_doc.md
View File

@ -150,7 +150,7 @@ A string list-typed build setting that cannot be set on the command line
## string_setting ## string_setting
<pre> <pre>
string_setting(<a href="#string_setting-name">name</a>, <a href="#string_setting-make_variable">make_variable</a>, <a href="#string_setting-values">values</a>) string_setting(<a href="#string_setting-name">name</a>, <a href="#string_setting-make_variable">make_variable</a>, <a href="#string_setting-scope">scope</a>, <a href="#string_setting-values">values</a>)
</pre> </pre>
A string-typed build setting that cannot be set on the command line A string-typed build setting that cannot be set on the command line
@ -162,6 +162,7 @@ A string-typed build setting that cannot be set on the command line
| :------------- | :------------- | :------------- | :------------- | :------------- | | :------------- | :------------- | :------------- | :------------- | :------------- |
| <a id="string_setting-name"></a>name | A unique name for this target. | <a href="https://bazel.build/concepts/labels#target-names">Name</a> | required | | | <a id="string_setting-name"></a>name | A unique name for this target. | <a href="https://bazel.build/concepts/labels#target-names">Name</a> | required | |
| <a id="string_setting-make_variable"></a>make_variable | If set, the build setting's value will be available as a Make variable with this name in the attributes of rules that list this build setting in their 'toolchains' attribute. | String | optional | `""` | | <a id="string_setting-make_variable"></a>make_variable | If set, the build setting's value will be available as a Make variable with this name in the attributes of rules that list this build setting in their 'toolchains' attribute. | String | optional | `""` |
| <a id="string_setting-scope"></a>scope | The scope indicates where a flag can propagate to | String | optional | `"universal"` |
| <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="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 | `[]` |

4
rules/common_settings.bzl
View File

@ -176,6 +176,10 @@ string_setting = rule(
doc = "The list of allowed values for this setting. An error is raised if any other value is given.", doc = "The list of allowed values for this setting. An error is raised if any other value is given.",
), ),
"make_variable": _MAKE_VARIABLE_ATTR, "make_variable": _MAKE_VARIABLE_ATTR,
"scope": attr.string(
doc = "The scope indicates where a flag can propagate to",
default = "universal",
),
}, },
doc = "A string-typed build setting that cannot be set on the command line", doc = "A string-typed build setting that cannot be set on the command line",
) )