aboutsummaryrefslogtreecommitdiffhomepage
diff options
context:
space:
mode:
authorGravatar Klaus Aehlig <aehlig@google.com>2018-04-10 02:36:15 -0700
committerGravatar Copybara-Service <copybara-piper@google.com>2018-04-10 02:37:47 -0700
commitf1f5f99a98e65f43aab8c5dba6ed6f6871c479cd (patch)
tree55b89ca7fb1c967eda9a4f1f4613aeb99826c8a1
parentf7549a6c2484d314c10fe8fe52c2d24d2a7de19e (diff)
Update repository-rule documentation on restarts
Update documentation of repository rules to reflect the recent change that label arguments are prefetched. Related to #4533. Change-Id: I765b3d030ca3e6bf0cca7e18f4bfcc17d1d5aea3 PiperOrigin-RevId: 192258022
-rw-r--r--site/docs/skylark/repository_rules.md11
1 files changed, 6 insertions, 5 deletions
diff --git a/site/docs/skylark/repository_rules.md b/site/docs/skylark/repository_rules.md
index ef19eccbb9..8e492ac091 100644
--- a/site/docs/skylark/repository_rules.md
+++ b/site/docs/skylark/repository_rules.md
@@ -75,11 +75,12 @@ cause an execution of the implementation function.
The implementation function can be _restarted_ if a dependency it
request is _missing_. The beginning of the implementation function
-will be re-executed after the dependency has been resolved.
-
-File given as a label are declared as dependencies, so requesting it
-might interrupt the function and restart it later, re-executing the
-part up till there.
+will be re-executed after the dependency has been resolved. To avoid
+unnecessary restarts (which are expensive, as network access might
+have to be repeated), label arguments are prefetched, provided all
+label arguments can be resolved to an existing file. Note that resolving
+a path from a string or a label that was constructed only during execution
+of the function might still cause a restart.
Finally, for non-`local` repositories, only a change in the following
dependencies might cause a restart: