aboutsummaryrefslogtreecommitdiffhomepage
path: root/site/docs/remote-caching.md
diff options
context:
space:
mode:
authorGravatar David Ostrovsky <david@ostrovsky.org>2018-05-02 03:30:11 -0700
committerGravatar Copybara-Service <copybara-piper@google.com>2018-05-02 03:31:48 -0700
commit4ee7f114387187c8b578b7f41674b9e68593d20e (patch)
tree45d8e6ab7ed80c093a6675c89bb0c1c22c74035f /site/docs/remote-caching.md
parent96c9a289dbfd2f7b107bb82b1353cb965393c584 (diff)
remote: introduce --disk_cache_flag
Consolidate the --experimental_local_disk_cache and --experimental_local_disk_cache_path flags into a single --disk_cache= flag. Also, create the cache directory if it doesn't exist. RELNOTES: We replaced the --experimental_local_disk_cache and --experimental_local_disk_cache_path flags into a single --disk_cache flag. Additionally, Bazel now tries to create the disk cache directory if it doesn't exist. Closes #5119. PiperOrigin-RevId: 195070550
Diffstat (limited to 'site/docs/remote-caching.md')
-rw-r--r--site/docs/remote-caching.md29
1 files changed, 26 insertions, 3 deletions
diff --git a/site/docs/remote-caching.md b/site/docs/remote-caching.md
index 163f1122f2..939edce6c4 100644
--- a/site/docs/remote-caching.md
+++ b/site/docs/remote-caching.md
@@ -28,6 +28,7 @@ make builds significantly faster.
* [Delete content from the remote cache](#delete-content-from-the-remote-cache)
* [Known Issues](#known-issues)
* [External Links](#external-links)
+* [Disk cache](#disk-cache)
* [Bazel remote execution (in development)](#bazel-remote-execution-in-development)
## Remote caching overview
@@ -306,14 +307,36 @@ You may want to delete content from the cache to:
* Create a clean cache after a cache was poisoned
* Reduce the amount of storage used by deleting old outputs
+## Disk cache
+
+Bazel can use a directory on the file system as a remote cache. This is
+useful for sharing build artifacts when switching branches and/or working
+on multiple workspaces of the same project, such as multiple checkouts. Since
+Bazel does not garbage-collect the directory, so you might want to automate a
+periodic cleanup of this directory. Enable disk cache as follows:
+
+```
+build --disk_cache=/path/to/build/cache
+```
+
+You can pass a user-specific path to the `--disk_cache` flag using the `~` alias
+(Bazel will substitute the current user's home directory). This comes in handy
+when enabling disk cache for all developers of a project via the project's
+checked in `.bazelrc` file.
+
+To enable cache hits across different workspaces, use the following flag:
+
+```
+build --experimental_strict_action_env
+```
+
## Known issues
-**Input file modification during a Build**
+**Input file modification during a build**
When an input file is modified during a build, Bazel might upload invalid
results to the remote cache. We are working on a solution for this problem.
-See [issue #3360] for updates. Avoid this problem by not editing source
-files during a build.
+See [issue #3360] for updates. Avoid modifying source files during a build.
**Environment variables leaking into an action**