C++ Rules for Bazel
Go to file
Alex Eagle f7aa3d5a2f
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
2023-07-19 15:32:02 -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 Fix licensing errors and add default condition for `local_defines`. 2023-07-18 07:27:57 -07:00
examples Remove redundant "# copybara-use-repo-external-label" 2023-02-16 04:17:58 -08:00
tests Fix licensing errors and add default condition for `local_defines`. 2023-07-18 07:27:57 -07:00
third_party Add support for expand_if_available for env_entry 2023-07-17 08:12:34 -07:00
tools/migration 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
.gitignore Add things needed for rules_cc to build & test in the open 2019-01-09 08:59:09 +01:00
AUTHORS Create AUTHORS 2021-03-25 11:49:43 -04:00
BUILD Introduce flag --@rules_cc//:link_extra_libs 2023-02-16 04:15:10 -08:00
CODEOWNERS Merge pull request #146 from bazelbuild:meteorcloudy-patch-1 2022-09-19 13:51:00 +00:00
CONTRIBUTING.md Add initial content of rules_cc repo 2019-01-09 08:58:14 +01:00
ISSUE_TEMPLATE.md Fix issue template 2019-02-27 01:37:03 -08:00
LICENSE Internal change 2019-01-09 08:56:00 +01:00
MODULE.bazel Fix MODULE.bazel formatting 2023-01-18 10:28:06 +01:00
README.md Update README.md 2023-07-19 15:32:02 -07:00
WORKSPACE Update rules_proto digest to e51f588 2023-02-28 15:13:12 +00:00
renovate.json Update renovate.json 2019-11-03 11:40:55 +01:00

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: