2
0
Fork 0
mirror of https://github.com/bazel-contrib/bazel-lib synced 2024-11-30 01:41:21 +00:00
bazel-lib/docs/output_files.md
Alex Eagle 0f5e1dcafd
chore(deps): upgrade stardoc (#894)
* chore(deps): upgrade stardoc

This uses the Bazel 7 'starlark_doc_extract' rule which our docsite expects for slurping data.

* chore: stardoc setup in WORKSPACE too

* chore: skip stardoc on bazel 6 in cases where the legacy extractor produces different docstrings
2024-08-08 12:56:11 -07:00

2.4 KiB
Generated

A rule that provides file(s) specific via DefaultInfo from a given target's DefaultInfo or OutputGroupInfo.

See also select_file from bazel-skylib.

output_files

output_files(name, output_group, paths, target)

A rule that provides file(s) specific via DefaultInfo from a given target's DefaultInfo or OutputGroupInfo

ATTRIBUTES

Name Description Type Mandatory Default
name A unique name for this target. Name required
output_group if set, we look in the specified output group for paths instead of DefaultInfo String optional ""
paths the paths of the file(s), relative to their roots, to provide via DefaultInfo from the given target's DefaultInfo or OutputGroupInfo List of strings required
target the target to look in for requested paths in its' DefaultInfo or OutputGroupInfo Label required

make_output_files

make_output_files(name, target, paths, kwargs)

Helper function to generate a output_files target and return its label.

PARAMETERS

Name Description Default Value
name unique name for the generated output_files target none
target target attribute passed to generated output_files target none
paths paths attribute passed to generated output_files target none
kwargs parameters to pass to generated output_files target none

RETURNS

The label name