Create common build settings #154
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Create common simple build settings for people to use so they don't recreate these rules over and over again. This fulfills part of the SBC design doc: https://docs.google.com/document/d/1vc8v-kXjvgZOdQdnxPTaV0rrLxtP2XwnD2tAZlYJOqw/edit#bookmark=id.iiumwic0jphr
|
Part of work for bazelbuild/bazel#5577 |
allevato
reviewed
May 14, 2019
rules/common_settings.bzl
Outdated
| build_setting = config.bool(), | ||
| ) | ||
|
|
||
| string_flag = rule( |
There was a problem hiding this comment.
Really excited to see this landing!
Drive-by comment (possibly for a future PR): it would be nice if the string_* flags took a list of acceptable values as an attribute, like attr.string does, where the implementation function would verify that the value is permitted. This would handle a common case without forcing rule authors who want this logic to write their own rule/validation.
thomasvl
reviewed
May 17, 2019
c-parsons
reviewed
May 28, 2019
+ link to full documentation + docstrings for rules/provider + "values" allowed values attr added to the string typed settings
fix missing :
c-parsons
reviewed
May 29, 2019
rules/common_settings.bzl
Outdated
| """ | ||
|
|
||
| BuildSettingInfo = provider( | ||
| doc = """A singleton provider that contains the raw value of a build setting""", |
There was a problem hiding this comment.
nit: Triple quotes unnecessary if it's only a single line :)
(there are multiple such instances in this file)
rules/common_settings.bzl
Outdated
|
|
||
| def _impl(ctx): | ||
| return BuildSettingInfo(value = ctx.build_setting_value) | ||
|
|
||
| int_flag = rule( | ||
| implementation = _impl, | ||
| build_setting = config.int(flag = True), | ||
| doc = """An int-typed build setting that is user settable""", |
There was a problem hiding this comment.
"user-settable" is a bit confusing, how about "{may, may not} be set on the command line" ?
This reverts commit 4345517.
c-parsons
approved these changes
Jun 11, 2019
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Create common simple build settings for people to use so they don't recreate these rules over and over again.
This fulfills part of the SBC design doc: https://docs.google.com/document/d/1vc8v-kXjvgZOdQdnxPTaV0rrLxtP2XwnD2tAZlYJOqw/edit#bookmark=id.iiumwic0jphr