Google Git
Sign in
bazel / rules_cc / f7aa3d5a2f10ec623a5d2aa26570aef7b009835c
commitf7aa3d5a2f10ec623a5d2aa26570aef7b009835c[log] [tgz]
authorAlex Eagle <alex@aspect.dev>Wed Jul 19 15:32:02 2023 -0700
committerGitHub <noreply@github.com>Wed Jul 19 15:32:02 2023 -0700
tree2d60261b2631cfb29731f132236a165898c0cf8b
parent1583313f410c9d54ae32d687703a5df3b2470c7d [diff]
Update README.md

Explain that the provided toolchain is not hermetic, and point to some options which are.

This was a topic at the Rules Authors SIG meeting on 27 June 2023: https://docs.google.com/document/d/1YGCYAGLzTfqSOgRFVsB8hDz-kEoTgTEKKp9Jd07TJ5c/edit#heading=h.twkfyk2n9ye9
1 file changed
tree: 2d60261b2631cfb29731f132236a165898c0cf8b
  1. .bazelci/
  2. .bcr/
  3. cc/
  4. examples/
  5. tests/
  6. third_party/
  7. tools/
  8. .gitignore
  9. AUTHORS
  10. BUILD
  11. CODEOWNERS
  12. CONTRIBUTING.md
  13. ISSUE_TEMPLATE.md
  14. LICENSE
  15. MODULE.bazel
  16. README.md
  17. renovate.json
  18. WORKSPACE
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: