diff options
| author | Fabian Meumertzheim <meumertzheim@code-intelligence.com> | 2023-10-17 14:54:12 +0200 |
|---|---|---|
| committer | Fabian Meumertzheim <fabian@meumertzhe.im> | 2023-10-17 15:14:12 +0200 |
| commit | e3412fd60074e1f1eaa1a1330110f13f38fc93b8 (patch) | |
| tree | 07b906e00d78f3a92a7f158540b180360484864b | |
| parent | 230da6027ec9de163cc84f013b37c79d5257ab15 (diff) | |
| download | jazzer-api-e3412fd60074e1f1eaa1a1330110f13f38fc93b8.tar.gz | |
docs: Recommend using `--disk_cache` in `CONTRIBUTING.md`
| -rw-r--r-- | CONTRIBUTING.md | 12 |
1 files changed, 12 insertions, 0 deletions
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index b3a49487..a8c76d29 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -14,6 +14,18 @@ It is recommended to use [Bazelisk](https://github.com/bazelbuild/bazelisk) to a Simply download the release binary for your OS and architecture and ensure that it is available in the `PATH`. 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. +### Recommended settings + +If you regularly run builds and tests in the Jazzer repository, it is recommended to use Bazel's disk cache. +This will speed up incremental builds and tests, especially when switching branches. + +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: +``` +common --disk_cache=$HOME/.cache/bazel-disk +``` + +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). + ### Building Assuming the dependencies are installed, build Jazzer from source and run it as follows: |