diff options
| author | Richard Levasseur <rlevasseur@google.com> | 2023-05-02 11:12:39 -0700 |
|---|---|---|
| committer | Blaze Rules Copybara <blaze-rules@google.com> | 2023-05-02 11:13:13 -0700 |
| commit | 4cae26c61e090e099ba942d2159009a7592dd7d1 (patch) | |
| tree | b0047577da082a35d2401f2023fe5d502572c4e7 | |
| parent | 92e5641c6a7c8fad53ce42c9e2620e524a91964c (diff) | |
| download | bazelbuild-rules_testing-4cae26c61e090e099ba942d2159009a7592dd7d1.tar.gz | |
docs: mention that Label() should be used for config_setting labels
This is to help users understand why they might get hard to understand errors
when they pass labels in, and how they can fix it.
PiperOrigin-RevId: 528836275
| -rw-r--r-- | lib/analysis_test.bzl | 5 |
1 files changed, 4 insertions, 1 deletions
diff --git a/lib/analysis_test.bzl b/lib/analysis_test.bzl index a0605e0..02164a4 100644 --- a/lib/analysis_test.bzl +++ b/lib/analysis_test.bzl @@ -165,7 +165,10 @@ def analysis_test( config_settings: A dictionary of configuration settings to change for the target under test and its dependencies. This may be used to essentially change 'build flags' for the target under test, and may thus be utilized to test multiple targets with different - flags in a single build + flags in a single build. NOTE: When values that are labels (e.g. for the + --platforms flag), it's suggested to always explicitly call `Label()` + on the value before passing it in. This ensures the label is resolved + in your repository's context, not rule_testing's. extra_target_under_test_aspects: An optional list of aspects to apply to the target_under_test in addition to those set up by default for the test harness itself. collect_actions_recursively: If true, runs testing_aspect over all attributes, otherwise |