Skip to content

Commit

Permalink
Mention build cache guide in user guide (#2288)
Browse files Browse the repository at this point in the history
  • Loading branch information
lptr authored and wolfs committed Jun 13, 2017
1 parent b231a36 commit fda8e5e
Showing 1 changed file with 6 additions and 4 deletions.
10 changes: 6 additions & 4 deletions subprojects/docs/src/docs/userguide/buildCache.adoc
Expand Up @@ -15,7 +15,7 @@
[[build_cache]]
== Build Cache

NOTE: The build cache feature is ready to be used for Java projects. However, there are some known issues (see <<sec:task_output_caching_known_issues>> and <<sec:build_cache_known_issues>>) that you should be aware of when using it. Work continues to make this feature safer to use in any project.
NOTE: The build cache feature is ready to be used for Java projects. However, there are some known issues that you should be aware of when using it (see <<sec:task_output_caching_known_issues>> and <<sec:build_cache_known_issues>>). Work continues to make this feature safer to use in any project.

NOTE: The build cache feature described here is different from the http://tools.android.com/tech-docs/build-cache[Android plugin build cache].

Expand All @@ -32,6 +32,8 @@ When using a shared build cache for task output caching this even works across d

Apart from task output caching, we expect other features to use the build cache in the future.

NOTE: A complete guide is available about https://guides.gradle.org/using-build-cache/[using the build cache]. It covers the different scenarios caching can improve, and detailed discussions of the different caveats you need to be aware of when enabling caching for a build.

[[sec:build_cache_enable]]
=== Enable the Build Cache

Expand Down Expand Up @@ -176,7 +178,7 @@ We suggest adding tests to ensure that the task inputs are relocatable, i.e. tha
In order to handle volatile inputs for your tasks consider <<sec:configure_input_normalization,configuring input normalization>>.

[[sec:task_output_caching_known_issues]]
==== Feedback and known issues
==== Known issues with task output caching

The task output caching feature has known issues that may impact the correctness of your build when using the build cache,
and there are some caveats to keep in mind which may reduce the number of cache hits you get between machines.
Expand Down Expand Up @@ -343,9 +345,9 @@ For an example of what this could look like see the https://github.com/gradle/gr
https://gradle.com/build-cache[Gradle Enterprise] includes a high-performance, easy to install and operate, shared build cache backend.

[[sec:build_cache_known_issues]]
=== Known issues with built-in Build Caches
=== Known issues with build caches backends

The built-in build caches have some known issues which will be addressed in future releases.
The build cache backends shipped with Gradle have some known issues that will be addressed in future releases.

.api:org.gradle.caching.http.HttpBuildCache[]
|===
Expand Down

0 comments on commit fda8e5e

Please sign in to comment.