C++ Rules for Bazel
Go to file
Copybara-Service a5827bf372 Merge pull request #256 from fmeum:235-better-tool-map
PiperOrigin-RevId: 691529088
Change-Id: Idbda52a6b2eecbdefd83b2c89a0c7eb01dfee074
2024-10-30 13:15:53 -07:00
.bazelci Remove outdated toolchain README contents. 2024-10-24 07:02:04 -07:00
.bcr Add bazel version 2024-10-04 13:28:28 +02:00
cc Merge pull request #256 from fmeum:235-better-tool-map 2024-10-30 13:15:53 -07:00
docs Deduplicate tools for `cc_tool_map` 2024-10-15 14:30:10 +02:00
examples Deduplicate tools for `cc_tool_map` 2024-10-15 14:30:10 +02:00
tests Deduplicate tools for `cc_tool_map` 2024-10-15 14:30:10 +02:00
.bazelignore Rule-based toolchain example 2024-09-06 11:08:58 -07:00
.gitignore Update ignore all bazel-generated dirs 2024-10-03 10:10:35 -07: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 Update CODEOWNERS for rules_cc 2024-10-24 07:37:56 -07: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 Remove cc_proto_library from defs.bzl 2024-10-30 09:22:18 -07:00
README.md Update README.md 2024-08-14 14:57:09 -07:00
WORKSPACE Remove cc_proto_library from defs.bzl 2024-10-30 09:22:18 -07:00
WORKSPACE.bzlmod Remove cc_proto_library from defs.bzl 2024-10-30 09:22:18 -07: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: