Skip to content

Commit e3412fd

Browse files
committed
docs: Recommend using --disk_cache in CONTRIBUTING.md
1 parent 230da60 commit e3412fd

File tree

1 file changed

+12
-0
lines changed

1 file changed

+12
-0
lines changed

CONTRIBUTING.md

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -14,6 +14,18 @@ It is recommended to use [Bazelisk](https://github.com/bazelbuild/bazelisk) to a
1414
Simply download the release binary for your OS and architecture and ensure that it is available in the `PATH`.
1515
The instructions below will assume that this binary is called `bazel` - Bazelisk is a thin wrapper around the actual Bazel binary and can be used interchangeably.
1616

17+
### Recommended settings
18+
19+
If you regularly run builds and tests in the Jazzer repository, it is recommended to use Bazel's disk cache.
20+
This will speed up incremental builds and tests, especially when switching branches.
21+
22+
Since a disk cache can be shared across Bazel projects, it is recommended to enable it by creating a file called `.bazelrc` in your home directory with the following contents:
23+
```
24+
common --disk_cache=$HOME/.cache/bazel-disk
25+
```
26+
27+
Bazel currently doesn't remove old entries from the disk cache automatically, so you may want to do this manually from time to time (see https://github.com/bazelbuild/bazel/issues/5139#issuecomment-943534948).
28+
1729
### Building
1830

1931
Assuming the dependencies are installed, build Jazzer from source and run it as follows:

0 commit comments

Comments
 (0)