• Home
  • Line#
  • Scopes#
  • Navigate#
  • Raw
  • Download
1# Copyright 2024 The Bazel Authors. All rights reserved.
2#
3# Licensed under the Apache License, Version 2.0 (the "License");
4# you may not use this file except in compliance with the License.
5# You may obtain a copy of the License at
6#
7#     http://www.apache.org/licenses/LICENSE-2.0
8#
9# Unless required by applicable law or agreed to in writing, software
10# distributed under the License is distributed on an "AS IS" BASIS,
11# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
12# See the License for the specific language governing permissions and
13# limitations under the License.
14"""This is a list of rules/macros that should be exported as documentation."""
15
16load("//cc/toolchains:actions.bzl", _cc_action_type = "cc_action_type", _cc_action_type_set = "cc_action_type_set")
17load("//cc/toolchains:args.bzl", _cc_args = "cc_args")
18load("//cc/toolchains:args_list.bzl", _cc_args_list = "cc_args_list")
19load("//cc/toolchains:feature.bzl", _cc_feature = "cc_feature")
20load("//cc/toolchains:feature_constraint.bzl", _cc_feature_constraint = "cc_feature_constraint")
21load("//cc/toolchains:feature_set.bzl", _cc_feature_set = "cc_feature_set")
22load("//cc/toolchains:mutually_exclusive_category.bzl", _cc_mutually_exclusive_category = "cc_mutually_exclusive_category")
23load("//cc/toolchains:nested_args.bzl", _cc_nested_args = "cc_nested_args")
24load("//cc/toolchains:tool.bzl", _cc_tool = "cc_tool")
25load("//cc/toolchains:tool_capability.bzl", _cc_tool_capability = "cc_tool_capability")
26load("//cc/toolchains:tool_map.bzl", _cc_tool_map = "cc_tool_map")
27load("//cc/toolchains:toolchain.bzl", _cc_toolchain = "cc_toolchain")
28load("//cc/toolchains/impl:external_feature.bzl", _cc_external_feature = "cc_external_feature")
29load("//cc/toolchains/impl:variables.bzl", _cc_variable = "cc_variable")
30
31cc_tool_map = _cc_tool_map
32cc_tool = _cc_tool
33cc_tool_capability = _cc_tool_capability
34cc_args = _cc_args
35cc_nested_args = _cc_nested_args
36cc_args_list = _cc_args_list
37cc_action_type = _cc_action_type
38cc_action_type_set = _cc_action_type_set
39cc_variable = _cc_variable
40cc_feature = _cc_feature
41cc_feature_constraint = _cc_feature_constraint
42cc_feature_set = _cc_feature_set
43cc_mutually_exclusive_category = _cc_mutually_exclusive_category
44cc_external_feature = _cc_external_feature
45cc_toolchain = _cc_toolchain
46
47# This list is used to automatically remap instances of `foo` to [`foo`](#foo)
48# links in the generated documentation so that maintainers don't need to manually
49# ensure every reference to a rule is properly linked.
50DOCUMENTED_TOOLCHAIN_RULES = [
51    "cc_tool_map",
52    "cc_tool",
53    "cc_tool_capability",
54    "cc_args",
55    "cc_nested_args",
56    "cc_args_list",
57    "cc_action_type",
58    "cc_action_type_set",
59    "cc_variable",
60    "cc_feature",
61    "cc_feature_constraint",
62    "cc_feature_set",
63    "cc_mutually_exclusive_category",
64    "cc_external_feature",
65    "cc_toolchain",
66]
67