C++ Rules for Bazel
Go to file
Googler d8dfa8b829 Introduce flag --@rules_cc//:link_extra_libs
Numerous tools override --custom_malloc to add debugging or monitoring runtimes
(see e.g. sanitizers). While this is fine for cases where the tool must also
override malloc to function, in other cases it's simply misuse of
--custom_malloc where no other mechanism exists to link an extra library.

This becomes especially problematic where a runtime library is supposed to be
added in certain configurations that should run in production or other
performance sensitive builds. In these cases, we should _not_ override malloc,
which may also be specified by a cc_binary target. Doing so would introduce
unwanted changes, potentially affecting performance negatively.

This is the @rules_cc counterpart to the equivalent Bazel tools flag
--@bazel_tools//tools/cpp:link_extra_libs. Users that use @rules_cc to build
their C++ projects may use both flags interchangably, however, the @rules_cc
flag should be preferred.

PiperOrigin-RevId: 510103352
Change-Id: Iafccd00ffdb65cb4f953d5acadc451cffc134533
2023-02-16 04:15:10 -08:00
.bazelci Copybara Merge: https://github.com/bazelbuild/rules_cc/pull/165 2023-01-11 04:33:23 -08: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 Introduce flag --@rules_cc//:link_extra_libs 2023-02-16 04:15:10 -08:00
examples Automatic code cleanup. 2022-06-22 06:02:29 -07:00
tests Introduce flag --@rules_cc//:link_extra_libs 2023-02-16 04:15:10 -08:00
third_party
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
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
ISSUE_TEMPLATE.md
LICENSE
MODULE.bazel Fix MODULE.bazel formatting 2023-01-18 10:28:06 +01:00
README.md Copybara Merge: https://github.com/bazelbuild/rules_cc/pull/165 2023-01-11 04:33:23 -08:00
WORKSPACE Merge pull request #177 from renovate-bot:renovate/bazel_skylib-1.x 2023-02-14 01:30:01 -08:00
renovate.json

README.md

C++ rules for Bazel

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

This repository contains 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

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: