bazel
/
bazel-lib
mirror of https://github.com/bazel-contrib/bazel-lib
2
0
Fork 0
Code Issues Releases Activity

chore: update generated docs

This commit is contained in:
Alex Eagle 2022-06-10 13:05:19 -07:00
parent fdbbc80fd7
commit d8ec2bc0db
17 changed files with 41 additions and 41 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

4
docs/copy_directory.md generated
View File

@ -6,7 +6,7 @@ The rule uses a Bash command on Linux/macOS/non-Windows, and a cmd.exe command
on Windows (no Bash is required). on Windows (no Bash is required).
<a id="#copy_directory"></a> <a id="copy_directory"></a>
## copy_directory ## copy_directory
@ -36,7 +36,7 @@ for more context.
| <a id="copy_directory-kwargs"></a>kwargs | further keyword arguments, e.g. <code>visibility</code> | none | | <a id="copy_directory-kwargs"></a>kwargs | further keyword arguments, e.g. <code>visibility</code> | none |
<a id="#copy_directory_action"></a> <a id="copy_directory_action"></a>
## copy_directory_action ## copy_directory_action

4
docs/copy_file.md generated
View File

@ -12,7 +12,7 @@ This fork of bazel-skylib's copy_file adds DirectoryPathInfo support and allows
copy_file in the same package. copy_file in the same package.
<a id="#copy_file"></a> <a id="copy_file"></a>
## copy_file ## copy_file
@ -46,7 +46,7 @@ for more context.
| <a id="copy_file-kwargs"></a>kwargs | further keyword arguments, e.g. <code>visibility</code> | none | | <a id="copy_file-kwargs"></a>kwargs | further keyword arguments, e.g. <code>visibility</code> | none |
<a id="#copy_file_action"></a> <a id="copy_file_action"></a>
## copy_file_action ## copy_file_action

6
docs/copy_to_bin.md generated
View File

@ -9,7 +9,7 @@ Originally authored in rules_nodejs
https://github.com/bazelbuild/rules_nodejs/blob/8b5d27400db51e7027fe95ae413eeabea4856f8e/internal/common/copy_to_bin.bzl https://github.com/bazelbuild/rules_nodejs/blob/8b5d27400db51e7027fe95ae413eeabea4856f8e/internal/common/copy_to_bin.bzl
<a id="#copy_file_to_bin_action"></a> <a id="copy_file_to_bin_action"></a>
## copy_file_to_bin_action ## copy_file_to_bin_action
@ -40,7 +40,7 @@ without a copy action.
A File in the output tree. A File in the output tree.
<a id="#copy_files_to_bin_actions"></a> <a id="copy_files_to_bin_actions"></a>
## copy_files_to_bin_actions ## copy_files_to_bin_actions
@ -71,7 +71,7 @@ directly to the result without a copy action.
List of File objects in the output tree. List of File objects in the output tree.
<a id="#copy_to_bin"></a> <a id="copy_to_bin"></a>
## copy_to_bin ## copy_to_bin

4
docs/copy_to_directory.md generated
View File

@ -6,7 +6,7 @@ Files and directories can be arranged as needed in the output directory using
the `root_paths`, `exclude_prefixes` and `replace_prefixes` attributes. the `root_paths`, `exclude_prefixes` and `replace_prefixes` attributes.
<a id="#copy_to_directory"></a> <a id="copy_to_directory"></a>
## copy_to_directory ## copy_to_directory
@ -30,7 +30,7 @@ copy_to_directory(<a href="#copy_to_directory-name">name</a>, <a href="#copy_to_
| <a id="copy_to_directory-srcs"></a>srcs | Files and/or directories or targets that provide DirectoryPathInfo to copy into the output directory. | <a href="https://bazel.build/docs/build-ref.html#labels">List of labels</a> | optional | [] | | <a id="copy_to_directory-srcs"></a>srcs | Files and/or directories or targets that provide DirectoryPathInfo to copy into the output directory. | <a href="https://bazel.build/docs/build-ref.html#labels">List of labels</a> | optional | [] |
<a id="#copy_to_directory_lib.impl"></a> <a id="copy_to_directory_lib.impl"></a>
## copy_to_directory_lib.impl ## copy_to_directory_lib.impl

8
docs/directory_path.md generated
View File

@ -4,7 +4,7 @@ Rule and corresponding provider that joins a label pointing to a TreeArtifact
with a path nested within that directory with a path nested within that directory
<a id="#directory_path"></a> <a id="directory_path"></a>
## directory_path ## directory_path
@ -26,7 +26,7 @@ Otherwise there is no way to give a Bazel label for it.
| <a id="directory_path-path"></a>path | path relative to the directory | String | required | | | <a id="directory_path-path"></a>path | path relative to the directory | String | required | |
<a id="#DirectoryPathInfo"></a> <a id="DirectoryPathInfo"></a>
## DirectoryPathInfo ## DirectoryPathInfo
@ -45,7 +45,7 @@ Joins a label pointing to a TreeArtifact with a path nested within that director
| <a id="DirectoryPathInfo-path"></a>path | path relative to the directory | | <a id="DirectoryPathInfo-path"></a>path | path relative to the directory |
<a id="#make_directory_path"></a> <a id="make_directory_path"></a>
## make_directory_path ## make_directory_path
@ -70,7 +70,7 @@ Helper function to generate a directory_path target and return its label.
The label `name` The label `name`
<a id="#make_directory_paths"></a> <a id="make_directory_paths"></a>
## make_directory_paths ## make_directory_paths

4
docs/docs.md generated
View File

@ -2,7 +2,7 @@
Public API for docs helpers Public API for docs helpers
<a id="#stardoc_with_diff_test"></a> <a id="stardoc_with_diff_test"></a>
## stardoc_with_diff_test ## stardoc_with_diff_test
@ -25,7 +25,7 @@ This is helpful for minimizing boilerplate in repos wih lots of stardoc targets.
| <a id="stardoc_with_diff_test-kwargs"></a>kwargs | additional attributes passed to the stardoc() rule, such as for overriding the templates | none | | <a id="stardoc_with_diff_test-kwargs"></a>kwargs | additional attributes passed to the stardoc() rule, such as for overriding the templates | none |
<a id="#update_docs"></a> <a id="update_docs"></a>
## update_docs ## update_docs

6
docs/expand_make_vars.md generated
View File

@ -2,7 +2,7 @@
Public API for expanding variables Public API for expanding variables
<a id="#expand_template"></a> <a id="expand_template"></a>
## expand_template ## expand_template
@ -34,7 +34,7 @@ as well as [configuration variables] such as `$(BINDIR)`, `$(TARGET_CPU)`, and `
| <a id="expand_template-template"></a>template | The template file to expand. | <a href="https://bazel.build/docs/build-ref.html#labels">Label</a> | required | | | <a id="expand_template-template"></a>template | The template file to expand. | <a href="https://bazel.build/docs/build-ref.html#labels">Label</a> | required | |
<a id="#expand_locations"></a> <a id="expand_locations"></a>
## expand_locations ## expand_locations
@ -81,7 +81,7 @@ The deprecated `$(location)` and `$(locations)` expansions returns either the ex
The expanded path or the original path The expanded path or the original path
<a id="#expand_variables"></a> <a id="expand_variables"></a>
## expand_variables ## expand_variables

2
docs/host_repo.md generated
View File

@ -2,7 +2,7 @@
Public API Public API
<a id="#host_repo"></a> <a id="host_repo"></a>
## host_repo ## host_repo

2
docs/jq.md generated
View File

@ -2,7 +2,7 @@
Public API for jq Public API for jq
<a id="#jq"></a> <a id="jq"></a>
## jq ## jq

4
docs/output_files.md generated
View File

@ -3,7 +3,7 @@
A rule that provides file(s) specific via DefaultInfo from a given target's DefaultInfo or OutputGroupInfo A rule that provides file(s) specific via DefaultInfo from a given target's DefaultInfo or OutputGroupInfo
<a id="#output_files"></a> <a id="output_files"></a>
## output_files ## output_files
@ -24,7 +24,7 @@ A rule that provides file(s) specific via DefaultInfo from a given target's Defa
| <a id="output_files-target"></a>target | the target to look in for requested paths in its' DefaultInfo or OutputGroupInfo | <a href="https://bazel.build/docs/build-ref.html#labels">Label</a> | required | | | <a id="output_files-target"></a>target | the target to look in for requested paths in its' DefaultInfo or OutputGroupInfo | <a href="https://bazel.build/docs/build-ref.html#labels">Label</a> | required | |
<a id="#make_output_files"></a> <a id="make_output_files"></a>
## make_output_files ## make_output_files

6
docs/paths.md generated
View File

@ -2,7 +2,7 @@
Public API Public API
<a id="#relative_file"></a> <a id="relative_file"></a>
## relative_file ## relative_file
@ -25,7 +25,7 @@ Resolves a relative path between two files, "to_file" and "frm_file", they must
The relative path from frm_file to to_file, including the file name The relative path from frm_file to to_file, including the file name
<a id="#to_manifest_path"></a> <a id="to_manifest_path"></a>
## to_manifest_path ## to_manifest_path
@ -56,7 +56,7 @@ in order to locate entries by their key.
The runfiles manifest entry path for a file The runfiles manifest entry path for a file
<a id="#to_workspace_path"></a> <a id="to_workspace_path"></a>
## to_workspace_path ## to_workspace_path

14
docs/repo_utils.md generated
View File

@ -2,7 +2,7 @@
Public API Public API
<a id="#patch"></a> <a id="patch"></a>
## patch ## patch
@ -33,7 +33,7 @@ then they are taken from `ctx.attr`.
| <a id="patch-patch_directory"></a>patch_directory | Directory to apply the patches in | <code>None</code> | | <a id="patch-patch_directory"></a>patch_directory | Directory to apply the patches in | <code>None</code> |
<a id="#repo_utils.is_darwin"></a> <a id="repo_utils.is_darwin"></a>
## repo_utils.is_darwin ## repo_utils.is_darwin
@ -51,7 +51,7 @@ Returns true if the host operating system is Darwin
| <a id="repo_utils.is_darwin-rctx"></a>rctx | <p align="center"> - </p> | none | | <a id="repo_utils.is_darwin-rctx"></a>rctx | <p align="center"> - </p> | none |
<a id="#repo_utils.is_linux"></a> <a id="repo_utils.is_linux"></a>
## repo_utils.is_linux ## repo_utils.is_linux
@ -69,7 +69,7 @@ Returns true if the host operating system is Linux
| <a id="repo_utils.is_linux-rctx"></a>rctx | <p align="center"> - </p> | none | | <a id="repo_utils.is_linux-rctx"></a>rctx | <p align="center"> - </p> | none |
<a id="#repo_utils.is_windows"></a> <a id="repo_utils.is_windows"></a>
## repo_utils.is_windows ## repo_utils.is_windows
@ -87,7 +87,7 @@ Returns true if the host operating system is Windows
| <a id="repo_utils.is_windows-rctx"></a>rctx | <p align="center"> - </p> | none | | <a id="repo_utils.is_windows-rctx"></a>rctx | <p align="center"> - </p> | none |
<a id="#repo_utils.get_env_var"></a> <a id="repo_utils.get_env_var"></a>
## repo_utils.get_env_var ## repo_utils.get_env_var
@ -111,7 +111,7 @@ Find an environment variable in system. Doesn't %-escape the value!
The environment variable value or the default if it is not set The environment variable value or the default if it is not set
<a id="#repo_utils.os"></a> <a id="repo_utils.os"></a>
## repo_utils.os ## repo_utils.os
@ -133,7 +133,7 @@ Returns the name of the host operating system
The string "windows", "linux" or "darwin" that describes the host os The string "windows", "linux" or "darwin" that describes the host os
<a id="#repo_utils.platform"></a> <a id="repo_utils.platform"></a>
## repo_utils.platform ## repo_utils.platform

2
docs/run_binary.md generated
View File

@ -5,7 +5,7 @@ Runs a binary as a build action. This rule does not require Bash (unlike native.
This fork of bazel-skylib's run_binary adds directory output support and better makevar expansions. This fork of bazel-skylib's run_binary adds directory output support and better makevar expansions.
<a id="#run_binary"></a> <a id="run_binary"></a>
## run_binary ## run_binary

2
docs/transitions.md generated
View File

@ -2,7 +2,7 @@
Rules for working with transitions. Rules for working with transitions.
<a id="#platform_transition_filegroup"></a> <a id="platform_transition_filegroup"></a>
## platform_transition_filegroup ## platform_transition_filegroup

10
docs/utils.md generated
View File

@ -2,7 +2,7 @@
Public API Public API
<a id="#glob_directories"></a> <a id="glob_directories"></a>
## glob_directories ## glob_directories
@ -21,7 +21,7 @@ glob_directories(<a href="#glob_directories-include">include</a>, <a href="#glob
| <a id="glob_directories-kwargs"></a>kwargs | <p align="center"> - </p> | none | | <a id="glob_directories-kwargs"></a>kwargs | <p align="center"> - </p> | none |
<a id="#is_external_label"></a> <a id="is_external_label"></a>
## is_external_label ## is_external_label
@ -43,7 +43,7 @@ Returns True if the given Label (or stringy version of a label) represents a tar
a bool a bool
<a id="#path_to_workspace_root"></a> <a id="path_to_workspace_root"></a>
## path_to_workspace_root ## path_to_workspace_root
@ -59,7 +59,7 @@ path_to_workspace_root()
Path to the workspace root Path to the workspace root
<a id="#propagate_well_known_tags"></a> <a id="propagate_well_known_tags"></a>
## propagate_well_known_tags ## propagate_well_known_tags
@ -86,7 +86,7 @@ https://docs.bazel.build/versions/main/be/common-definitions.html#common-attribu
List of tags that only contains the well known set List of tags that only contains the well known set
<a id="#to_label"></a> <a id="to_label"></a>
## to_label ## to_label

2
docs/write_source_files.md generated
View File

@ -2,7 +2,7 @@
Public API for write_source_files Public API for write_source_files
<a id="#write_source_files"></a> <a id="write_source_files"></a>
## write_source_files ## write_source_files

2
docs/yq.md generated
View File

@ -2,7 +2,7 @@
Public API for yq Public API for yq
<a id="#yq"></a> <a id="yq"></a>
## yq ## yq