aboutsummaryrefslogtreecommitdiff
path: root/docs/go/core
diff options
context:
space:
mode:
authorSiddhartha Bagaria <sbagaria@grailbio.com>2022-03-30 10:52:08 -0700
committerGitHub <noreply@github.com>2022-03-30 10:52:08 -0700
commit11d61001860fe803f380333b57e088a32003c3a4 (patch)
treeff36f22c07bba6b730dd614bee63336c0a1ea482 /docs/go/core
parent1691291918d81287edc477c0baa0f131cc7e49d0 (diff)
downloadbazelbuild-rules_go-11d61001860fe803f380333b57e088a32003c3a4.tar.gz
Consider volatile and stable status files separately (#3079)
Diffstat (limited to 'docs/go/core')
-rw-r--r--docs/go/core/defines_and_stamping.md7
1 files changed, 5 insertions, 2 deletions
diff --git a/docs/go/core/defines_and_stamping.md b/docs/go/core/defines_and_stamping.md
index 7527360f..f9fd98fd 100644
--- a/docs/go/core/defines_and_stamping.md
+++ b/docs/go/core/defines_and_stamping.md
@@ -65,8 +65,11 @@ by spaces, one per line. For example:
echo STABLE_GIT_COMMIT $(git rev-parse HEAD)
```
-***Note:*** keys that start with `STABLE_` will trigger a re-link when they change.
-Other keys will NOT trigger a re-link.
+***Note:*** stamping with keys that bazel designates as "stable" will trigger a
+re-link when any stable key changes. Currently, in bazel, stable keys are
+`BUILD_EMBED_LABEL`, `BUILD_USER`, `BUILD_HOST` and keys whose names start with
+`STABLE_`. Stamping only with keys that are not stable keys will not trigger a
+relink.
You can reference these in `x_defs` using curly braces.