fix: formatting for new docsite (#302)
This commit is contained in:
Greg Magolan
GitHub
parent
2689a48940
commit
0d456be3c6
|
|
@ -25,9 +25,9 @@ Handles variable substitutions for args.
|
|||
| :------------- | :------------- | :------------- |
|
||||
| <a id="params_file-name"></a>name | Name of the rule. | none |
|
||||
| <a id="params_file-out"></a>out | Path of the output file, relative to this package. | none |
|
||||
| <a id="params_file-args"></a>args | Arguments to concatenate into a params file. Subject to 'Make variable' substitution. See https://docs.bazel.build/versions/main/be/make-variables.html. <ol> <li> Subject to predefined source/output path variables substitutions. The predefined variables `execpath`, `execpaths`, `rootpath`, `rootpaths`, `location`, and `locations` take label parameters (e.g. `$(execpath //foo:bar)`) and substitute the file paths denoted by that label. See https://docs.bazel.build/versions/main/be/make-variables.html#predefined_label_variables for more info. NB: This $(location) substition returns the manifest file path which differs from the `*_binary` & `*_test` args and genrule bazel substitions. This will be fixed in a future major release. See docs string of `expand_location_into_runfiles` macro in `internal/common/expand_into_runfiles.bzl` for more info.</li> <li>Subject to predefined variables & custom variable substitutions. Predefined "Make" variables such as `$(COMPILATION_MODE)` and `$(TARGET_CPU)` are expanded. See https://docs.bazel.build/versions/main/be/make-variables.html#predefined_variables. Custom variables are also expanded including variables set through the Bazel CLI with `--define=SOME_VAR=SOME_VALUE`. See https://docs.bazel.build/versions/main/be/make-variables.html#custom_variables. Predefined genrule variables are not supported in this context.</li> </ol> | <code>[]</code> |
|
||||
| <a id="params_file-args"></a>args | Arguments to concatenate into a params file.<br><br>- Subject to 'Make variable' substitution. See https://docs.bazel.build/versions/main/be/make-variables.html.<br><br>- Subject to predefined source/output path variables substitutions.<br><br> The predefined variables <code>execpath</code>, <code>execpaths</code>, <code>rootpath</code>, <code>rootpaths</code>, <code>location</code>, and <code>locations</code> take label parameters (e.g. <code>$(execpath //foo:bar)</code>) and substitute the file paths denoted by that label.<br><br> See https://docs.bazel.build/versions/main/be/make-variables.html#predefined_label_variables for more info.<br><br> NB: This $(location) substition returns the manifest file path which differs from the <code>*_binary</code> & <code>*_test</code> args and genrule bazel substitions. This will be fixed in a future major release. See docs string of <code>expand_location_into_runfiles</code> macro in <code>internal/common/expand_into_runfiles.bzl</code> for more info.<br><br>- Subject to predefined variables & custom variable substitutions.<br><br> Predefined "Make" variables such as <code>$(COMPILATION_MODE)</code> and <code>$(TARGET_CPU)</code> are expanded. See https://docs.bazel.build/versions/main/be/make-variables.html#predefined_variables.<br><br> Custom variables are also expanded including variables set through the Bazel CLI with <code>--define=SOME_VAR=SOME_VALUE</code>. See https://docs.bazel.build/versions/main/be/make-variables.html#custom_variables.<br><br> Predefined genrule variables are not supported in this context. | <code>[]</code> |
|
||||
| <a id="params_file-data"></a>data | Data for <code>$(location)</code> expansions in args. | <code>[]</code> |
|
||||
| <a id="params_file-newline"></a>newline | Line endings to use. One of [`"auto"`, `"unix"`, `"windows"`]. <ul> <li>`"auto"` for platform-determined</li> <li>`"unix"` for LF</li> <li>`"windows"` for CRLF</li> </ul> | <code>"auto"</code> |
|
||||
| <a id="params_file-newline"></a>newline | Line endings to use. One of [<code>"auto"</code>, <code>"unix"</code>, <code>"windows"</code>].<br><br>- <code>"auto"</code> for platform-determined - <code>"unix"</code> for LF - <code>"windows"</code> for CRLF | <code>"auto"</code> |
|
||||
| <a id="params_file-kwargs"></a>kwargs | undocumented named arguments | none |
|
||||
|
||||
|
||||
|
|
|
|||
|
|
@ -18,40 +18,37 @@ def params_file(
|
|||
out: Path of the output file, relative to this package.
|
||||
args: Arguments to concatenate into a params file.
|
||||
|
||||
Subject to 'Make variable' substitution. See https://docs.bazel.build/versions/main/be/make-variables.html.
|
||||
- Subject to 'Make variable' substitution. See https://docs.bazel.build/versions/main/be/make-variables.html.
|
||||
|
||||
<ol>
|
||||
<li> Subject to predefined source/output path variables substitutions.
|
||||
- Subject to predefined source/output path variables substitutions.
|
||||
|
||||
The predefined variables `execpath`, `execpaths`, `rootpath`, `rootpaths`, `location`, and `locations` take
|
||||
label parameters (e.g. `$(execpath //foo:bar)`) and substitute the file paths denoted by that label.
|
||||
The predefined variables `execpath`, `execpaths`, `rootpath`, `rootpaths`, `location`, and `locations` take
|
||||
label parameters (e.g. `$(execpath //foo:bar)`) and substitute the file paths denoted by that label.
|
||||
|
||||
See https://docs.bazel.build/versions/main/be/make-variables.html#predefined_label_variables for more info.
|
||||
See https://docs.bazel.build/versions/main/be/make-variables.html#predefined_label_variables for more info.
|
||||
|
||||
NB: This $(location) substition returns the manifest file path which differs from the `*_binary` & `*_test`
|
||||
args and genrule bazel substitions. This will be fixed in a future major release.
|
||||
See docs string of `expand_location_into_runfiles` macro in `internal/common/expand_into_runfiles.bzl`
|
||||
for more info.</li>
|
||||
NB: This $(location) substition returns the manifest file path which differs from the `*_binary` & `*_test`
|
||||
args and genrule bazel substitions. This will be fixed in a future major release.
|
||||
See docs string of `expand_location_into_runfiles` macro in `internal/common/expand_into_runfiles.bzl`
|
||||
for more info.
|
||||
|
||||
<li>Subject to predefined variables & custom variable substitutions.
|
||||
- Subject to predefined variables & custom variable substitutions.
|
||||
|
||||
Predefined "Make" variables such as `$(COMPILATION_MODE)` and `$(TARGET_CPU)` are expanded.
|
||||
See https://docs.bazel.build/versions/main/be/make-variables.html#predefined_variables.
|
||||
Predefined "Make" variables such as `$(COMPILATION_MODE)` and `$(TARGET_CPU)` are expanded.
|
||||
See https://docs.bazel.build/versions/main/be/make-variables.html#predefined_variables.
|
||||
|
||||
Custom variables are also expanded including variables set through the Bazel CLI with `--define=SOME_VAR=SOME_VALUE`.
|
||||
See https://docs.bazel.build/versions/main/be/make-variables.html#custom_variables.
|
||||
Custom variables are also expanded including variables set through the Bazel CLI with `--define=SOME_VAR=SOME_VALUE`.
|
||||
See https://docs.bazel.build/versions/main/be/make-variables.html#custom_variables.
|
||||
|
||||
Predefined genrule variables are not supported in this context.</li>
|
||||
</ol>
|
||||
Predefined genrule variables are not supported in this context.
|
||||
|
||||
data: Data for `$(location)` expansions in args.
|
||||
newline: Line endings to use. One of [`"auto"`, `"unix"`, `"windows"`].
|
||||
|
||||
<ul>
|
||||
<li>`"auto"` for platform-determined</li>
|
||||
<li>`"unix"` for LF</li>
|
||||
<li>`"windows"` for CRLF</li>
|
||||
</ul>
|
||||
- `"auto"` for platform-determined
|
||||
- `"unix"` for LF
|
||||
- `"windows"` for CRLF
|
||||
|
||||
**kwargs: undocumented named arguments
|
||||
"""
|
||||
_params_file(
|
||||
|
|
|
|||
Loading…
Reference in New Issue