2
0
Fork 0
mirror of https://github.com/bazelbuild/rules_cc synced 2024-11-27 20:43:26 +00:00
rules_cc/cc/toolchains/args_list.bzl
Googler b06d2f7d53 Add cc_action_type and cc_tool documentation
BEGIN_PUBLIC

Add cc_action_type and cc_tool documentation

Extends the toolchain API documentation to include docs for cc_action_type, cc_action_type_set, cc_variable, and cc_tool.

Also improves cross-reference links and copybara behavior for docs.

END_PUBLIC

PiperOrigin-RevId: 680601617
Change-Id: Idbbdfbcb2c5a1c3598b6a7e7ba985ed14f871099
2024-09-30 09:15:19 -07:00

74 lines
2.1 KiB
Python

# Copyright 2024 The Bazel Authors. All rights reserved.
#
# Licensed under the Apache License, Version 2.0 (the "License");
# you may not use this file except in compliance with the License.
# You may obtain a copy of the License at
#
# http://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing, software
# distributed under the License is distributed on an "AS IS" BASIS,
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
# See the License for the specific language governing permissions and
# limitations under the License.
"""All providers for rule-based bazel toolchain config."""
load(
"//cc/toolchains/impl:collect.bzl",
"collect_args_lists",
)
load(":cc_toolchain_info.bzl", "ArgsListInfo")
def _cc_args_list_impl(ctx):
return [collect_args_lists(ctx.attr.args, ctx.label)]
cc_args_list = rule(
implementation = _cc_args_list_impl,
doc = """An ordered list of cc_args.
This is a convenience rule to allow you to group a set of multiple `cc_args` into a
single list. This particularly useful for toolchain behaviors that require different flags for
different actions.
Note: The order of the arguments in `args` is preserved to support order-sensitive flags.
Example usage:
```
load("//cc/toolchains:cc_args.bzl", "cc_args")
load("//cc/toolchains:args_list.bzl", "cc_args_list")
cc_args(
name = "gc_sections",
actions = [
"//cc/toolchains/actions:link_actions",
],
args = ["-Wl,--gc-sections"],
)
cc_args(
name = "function_sections",
actions = [
"//cc/toolchains/actions:compile_actions",
"//cc/toolchains/actions:link_actions",
],
args = ["-ffunction-sections"],
)
cc_args_list(
name = "gc_functions",
args = [
":function_sections",
":gc_sections",
],
)
```
""",
attrs = {
"args": attr.label_list(
providers = [ArgsListInfo],
doc = "(ordered) cc_args to include in this list.",
),
},
provides = [ArgsListInfo],
)