Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Update selects documentation. #170

Merged
merged 3 commits into from
Aug 23, 2019
Merged

Update selects documentation. #170

Changes from 1 commit
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
72c2d39
Update selects documentation.
gregestren Jul 16, 2019
5f90f0b
Merge branch 'master' into master
c-parsons Jul 16, 2019
d91cb21
Merge branch 'master' into master
aiuto Aug 23, 2019
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
107 changes: 94 additions & 13 deletions docs/selects_doc.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,3 +1,7 @@
<!-- Generated with Stardoc: http://skydoc.bazel.build -->

<a name="#selects.with_or"></a>

## selects.with_or

<pre>
Expand All @@ -6,6 +10,20 @@ selects.with_or(<a href="#selects.with_or-input_dict">input_dict</a>, <a href="#

Drop-in replacement for `select()` that supports ORed keys.

Example:

```build
deps = selects.with_or({
"//configs:one": [":dep1"],
("//configs:two", "//configs:three"): [":dep2or3"],
"//configs:four": [":dep4"],
"//conditions:default": [":default"]
})
```

Key labels may appear at most once anywhere in the input.


### Parameters

<table class="params-table">
Expand All @@ -32,26 +50,15 @@ Drop-in replacement for `select()` that supports ORed keys.
optional. default is <code>""</code>
<p>
Optional custom error to report if no condition matches.

Example:

```build
deps = selects.with_or({
"//configs:one": [":dep1"],
("//configs:two", "//configs:three"): [":dep2or3"],
"//configs:four": [":dep4"],
"//conditions:default": [":default"]
})
```

Key labels may appear at most once anywhere in the input.
</p>
</td>
</tr>
</tbody>
</table>


<a name="#selects.with_or_dict"></a>

## selects.with_or_dict

<pre>
Expand Down Expand Up @@ -85,3 +92,77 @@ macros.
</table>


<a name="#selects.config_setting_group"></a>

## selects.config_setting_group

<pre>
selects.config_setting_group(<a href="#selects.config_setting_group-name">name</a>, <a href="#selects.config_setting_group-match_any">match_any</a>, <a href="#selects.config_setting_group-match_all">match_all</a>)
</pre>

Matches if all or any of its member `config_setting`s match.

Example:

```build
config_setting(name = "one", define_values = {"foo": "true"})
config_setting(name = "two", define_values = {"bar": "false"})
config_setting(name = "three", define_values = {"baz": "more_false"})

config_setting_group(
name = "one_two_three",
match_all = [":one", ":two", ":three"]
)

cc_binary(
name = "myapp",
srcs = ["myapp.cc"],
deps = select({
":one_two_three": [":special_deps"],
"//conditions:default": [":default_deps"]
})
```


### Parameters

<table class="params-table">
<colgroup>
<col class="col-param" />
<col class="col-description" />
</colgroup>
<tbody>
<tr id="selects.config_setting_group-name">
<td><code>name</code></td>
<td>
required.
<p>
The group's name. This is how `select()`s reference it.
</p>
</td>
</tr>
<tr id="selects.config_setting_group-match_any">
<td><code>match_any</code></td>
<td>
optional. default is <code>[]</code>
<p>
A list of `config_settings`. This group matches if *any* member
in the list matches. If this is set, `match_all` must not be set.
</p>
</td>
</tr>
<tr id="selects.config_setting_group-match_all">
<td><code>match_all</code></td>
<td>
optional. default is <code>[]</code>
<p>
A list of `config_settings`. This group matches if *every*
member in the list matches. If this is set, `match_any` must be not
set.
</p>
</td>
</tr>
</tbody>
</table>