Create new stardoc target for common_settings.bzl (#166)
This commit is contained in:
Julie
aiuto
parent
c102f5d414
commit
21ee269a55
|
|
@ -128,3 +128,11 @@ stardoc(
|
|||
input = "//rules:run_binary.bzl",
|
||||
deps = ["//rules:run_binary"],
|
||||
)
|
||||
|
||||
stardoc(
|
||||
name = "common_settings_docs",
|
||||
out = "common_settings_doc_gen.md",
|
||||
input = "//rules:common_settings.bzl",
|
||||
deps = ["//rules:common_settings"],
|
||||
semantic_flags = ["--experimental_build_setting_api=True"],
|
||||
)
|
||||
|
|
|
|||
|
|
@ -0,0 +1,296 @@
|
|||
<!-- Generated with Stardoc: http://skydoc.bazel.build -->
|
||||
|
||||
<a name="#bool_flag"></a>
|
||||
|
||||
## bool_flag
|
||||
|
||||
<pre>
|
||||
bool_flag(<a href="#bool_flag-name">name</a>)
|
||||
</pre>
|
||||
|
||||
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>
|
||||
|
||||
## bool_setting
|
||||
|
||||
<pre>
|
||||
bool_setting(<a href="#bool_setting-name">name</a>)
|
||||
</pre>
|
||||
|
||||
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>
|
||||
|
||||
## int_flag
|
||||
|
||||
<pre>
|
||||
int_flag(<a href="#int_flag-name">name</a>)
|
||||
</pre>
|
||||
|
||||
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>
|
||||
|
||||
## int_setting
|
||||
|
||||
<pre>
|
||||
int_setting(<a href="#int_setting-name">name</a>)
|
||||
</pre>
|
||||
|
||||
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>
|
||||
|
||||
## string_flag
|
||||
|
||||
<pre>
|
||||
string_flag(<a href="#string_flag-name">name</a>, <a href="#string_flag-values">values</a>)
|
||||
</pre>
|
||||
|
||||
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>
|
||||
|
||||
## string_list_flag
|
||||
|
||||
<pre>
|
||||
string_list_flag(<a href="#string_list_flag-name">name</a>)
|
||||
</pre>
|
||||
|
||||
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>
|
||||
|
||||
## string_list_setting
|
||||
|
||||
<pre>
|
||||
string_list_setting(<a href="#string_list_setting-name">name</a>)
|
||||
</pre>
|
||||
|
||||
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>
|
||||
|
||||
## string_setting
|
||||
|
||||
<pre>
|
||||
string_setting(<a href="#string_setting-name">name</a>, <a href="#string_setting-values">values</a>)
|
||||
</pre>
|
||||
|
||||
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>
|
||||
|
||||
## BuildSettingInfo
|
||||
|
||||
<pre>
|
||||
BuildSettingInfo(<a href="#BuildSettingInfo-value">value</a>)
|
||||
</pre>
|
||||
|
||||
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>(Undocumented)</p>
|
||||
</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
|
||||
|
||||
|
|
@ -39,6 +39,11 @@ bzl_library(
|
|||
deps = ["//lib:dicts"],
|
||||
)
|
||||
|
||||
bzl_library(
|
||||
name = "common_settings",
|
||||
srcs = ["common_settings.bzl"],
|
||||
)
|
||||
|
||||
# Exported for build_test.bzl to make sure of, it is an implementation detail
|
||||
# of the rule and should not be directly used by anything else.
|
||||
exports_files(["empty_test.sh"])
|
||||
|
|
|
|||
Loading…
Reference in New Issue