blob: a0a4873c2d2099277e48f6c6ecc7683e2f7c626a [file] [edit]
---
title: 'C++ and Bazel'
---
This page contains resources that help you use Bazel with C++ projects. It links
to a tutorial, build rules, and other information specific to building C++
projects with Bazel.
## Working with Bazel {:#working-with-bazel}
The following resources will help you work with Bazel on C++ projects:
* [Tutorial: Building a C++ project](/versions/6.3.0/tutorials/cpp)
* [C++ common use cases](/versions/6.3.0/tutorials/cpp-use-cases)
* [C/C++ rules](/versions/6.3.0/reference/be/c-cpp)
* [C++ toolchain configuration](/versions/6.3.0/docs/cc-toolchain-config-reference)
* [Tutorial: Configuring C++ toolchains](/versions/6.3.0/tutorials/cc-toolchain-config)
* [Integrating with C++ rules](/versions/6.3.0/docs/integrating-with-rules-cc)
## Best practices {:#best-practices}
In addition to [general Bazel best practices](/versions/6.3.0/docs/best-practices), below are
best practices specific to C++ projects.
### BUILD files {:#build-files}
Follow the guidelines below when creating your BUILD files:
* Each `BUILD` file should contain one [`cc_library`](/versions/6.3.0/reference/be/c-cpp#cc_library)
rule target per compilation unit in the directory.
* You should granularize your C++ libraries as much as
possible to maximize incrementality and parallelize the build.
* If there is a single source file in `srcs`, name the library the same as
that C++ file's name. This library should contain C++ file(s), any matching
header file(s), and the library's direct dependencies. For example:
```python
cc_library(
name = "mylib",
srcs = ["mylib.cc"],
hdrs = ["mylib.h"],
deps = [":lower-level-lib"]
)
```
* Use one `cc_test` rule target per `cc_library` target in the file. Name the
target `[library-name]_test` and the source file `[library-name]_test.cc`.
For example, a test target for the `mylib` library target shown above would
look like this:
```python
cc_test(
name = "mylib_test",
srcs = ["mylib_test.cc"],
deps = [":mylib"]
)
```
### Include paths {:#include-paths}
Follow these guidelines for include paths:
* Make all include paths relative to the workspace directory.
* Use quoted includes (`#include "foo/bar/baz.h"`) for non-system headers, not
angle-brackets (`#include <foo/bar/baz.h>`).
* Avoid using UNIX directory shortcuts, such as `.` (current directory) or `..`
(parent directory).
* For legacy or `third_party` code that requires includes pointing outside the
project repository, such as external repository includes requiring a prefix,
use the [`include_prefix`](/versions/6.3.0/reference/be/c-cpp#cc_library.include_prefix) and
[`strip_include_prefix`](/versions/6.3.0/reference/be/c-cpp#cc_library.strip_include_prefix)
arguments on the `cc_library` rule target.