C++ Rules for Bazel
Go to file
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
.bazelci Enable `//tests/...` in CI 2023-07-08 00:29:45 +02:00
.bcr The targets in the old package were either not publicly visible or testonly dependencies and had diverged heavily from @bazel_tools. 2023-01-10 02:00:52 -08:00
cc Add cc_action_type and cc_tool documentation 2024-09-30 09:15:19 -07:00
examples Automatic code cleanup. 2023-09-18 03:04:35 -07:00
tests Remove experimental_enable_rule_based_toolchains flag 2024-09-12 17:31:23 -07:00
third_party Add support for expand_if_available for env_entry 2023-07-17 08:12:34 -07:00
tools/migration Cleanup uses of ctoolchain migration 2024-02-12 03:16:53 -08:00
.gitignore
AUTHORS
BUILD Introduce flag --@rules_cc//:link_extra_libs 2023-02-16 04:15:10 -08:00
CODEOWNERS
CONTRIBUTING.md
ISSUE_TEMPLATE.md
LICENSE
MODULE.bazel Release rules_cc 0.0.10 2024-09-13 08:30:29 -07:00
README.md Update README.md 2023-07-19 15:32:02 -07:00
WORKSPACE Copybara Merge: https://github.com/bazelbuild/rules_cc/pull/238 2024-09-11 05:56:57 -07:00
renovate.json

README.md

C++ rules for Bazel

  • Postsubmit Build status
  • Postsubmit + Current Bazel Incompatible flags Build status

This repository contains a Starlark implementation of C++ rules in Bazel.

The rules are being incrementally converted from their native implementations in the Bazel source tree.

For the list of C++ rules, see the Bazel documentation.

Getting Started

There is no need to use rules from this repository just yet. If you want to use rules_cc anyway, add the following to your WORKSPACE file:

load("@bazel_tools//tools/build_defs/repo:http.bzl", "http_archive")

http_archive(
    name = "rules_cc",
    urls = ["https://github.com/bazelbuild/rules_cc/archive/refs/tags/<VERSION>.tar.gz"],
    sha256 = "...",
)

Then, in your BUILD files, import and use the rules:

load("@rules_cc//cc:defs.bzl", "cc_library")

cc_library(
    ...
)

Using the rules_cc toolchain

This repo contains an auto-detecting toolchain that expects to find tools installed on your host machine. This is non-hermetic, and may have varying behaviors depending on the versions of tools found.

There are third-party contributed hermetic toolchains you may want to investigate:

If you'd like to use the cc toolchain defined in this repo, add this to your WORKSPACE after you include rules_cc:

load("@rules_cc//cc:repositories.bzl", "rules_cc_dependencies", "rules_cc_toolchains")

rules_cc_dependencies()

rules_cc_toolchains()

Migration Tools

This repository also contains migration tools that can be used to migrate your project for Bazel incompatible changes.

Legacy fields migrator

Script that migrates legacy crosstool fields into features (incompatible flag, tracking issue).

TLDR:

bazel run @rules_cc//tools/migration:legacy_fields_migrator -- \
  --input=my_toolchain/CROSSTOOL \
  --inline

Contributing

Bazel and rules_cc are the work of many contributors. We appreciate your help!

To contribute, please read the contribution guidelines: CONTRIBUTING.md.

Note that the rules_cc use the GitHub issue tracker for bug reports and feature requests only. For asking questions see: