Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/bazelbuild/rules_cc
C++ Rules for Bazel
https://github.com/bazelbuild/rules_cc
bazel bazel-rules c cpp rules-cc
Last synced: 1 day ago
JSON representation
C++ Rules for Bazel
- Host: GitHub
- URL: https://github.com/bazelbuild/rules_cc
- Owner: bazelbuild
- License: apache-2.0
- Created: 2018-12-14T11:38:13.000Z (almost 6 years ago)
- Default Branch: main
- Last Pushed: 2024-11-06T16:05:41.000Z (8 days ago)
- Last Synced: 2024-11-06T16:46:50.949Z (8 days ago)
- Topics: bazel, bazel-rules, c, cpp, rules-cc
- Language: Starlark
- Homepage: https://bazel.build
- Size: 1.06 MB
- Stars: 186
- Watchers: 26
- Forks: 93
- Open Issues: 39
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
- Codeowners: CODEOWNERS
- Authors: AUTHORS
Awesome Lists containing this project
README
# C++ rules for Bazel
* Postsubmit [](https://buildkite.com/bazel/rules-cc)
* Postsubmit + Current Bazel Incompatible flags [](https://buildkite.com/bazel/rules-cc-plus-bazelisk-migrate)
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](https://source.bazel.build/bazel/+/master:src/main/java/com/google/devtools/build/lib/rules/cpp/).
For the list of C++ rules, see the Bazel
[documentation](https://docs.bazel.build/versions/main/be/overview.html).
# 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:
```starlark
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/.tar.gz"],
sha256 = "...",
)
```
Then, in your `BUILD` files, import and use the rules:
```starlark
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:
- LLVM:
- GCC (Linux only):
- zig cc:
If you'd like to use the cc toolchain defined in this repo, add this to
your WORKSPACE after you include rules_cc:
```bzl
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](https://github.com/bazelbuild/bazel/issues/6861),
[tracking issue](https://github.com/bazelbuild/bazel/issues/5883)).
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](https://github.com/bazelbuild/rules_cc/blob/main/CONTRIBUTING.md).
Note that the `rules_cc` use the GitHub issue tracker for bug reports and feature requests only.
For asking questions see:
* [Stack Overflow](https://stackoverflow.com/questions/tagged/bazel)
* [`rules_cc` mailing list](https://groups.google.com/forum/#!forum/cc-bazel-discuss)
* Slack channel `#cc` on [slack.bazel.build](https://slack.bazel.build)