diff options
| author |  cparsons <cparsons@google.com> | 2018-06-27 13:55:53 -0700 |
|---|---|---|
| committer |  Copybara-Service <copybara-piper@google.com> | 2018-06-27 13:57:18 -0700 |
| commit | 57974d489d613f452d4bc9f4324262479e13400d (patch) | |
| tree | 8b5b6c86c106f57b040a1aec3c6a308d1294d796 /src/test/java | |
| parent | f095fe0229600d5e63405595022a4751421e3189 (diff) | |
Clarify purpose of golden-file-regeneration targets
RELNOTES: None.
PiperOrigin-RevId: 202364245
Diffstat (limited to 'src/test/java')
| -rw-r--r-- | src/test/java/com/google/devtools/build/skydoc/skydoc_test.bzl | 7 |
1 files changed, 5 insertions, 2 deletions
diff --git a/src/test/java/com/google/devtools/build/skydoc/skydoc_test.bzl b/src/test/java/com/google/devtools/build/skydoc/skydoc_test.bzl index f36e87744f..776eb39fa4 100644 --- a/src/test/java/com/google/devtools/build/skydoc/skydoc_test.bzl +++ b/src/test/java/com/google/devtools/build/skydoc/skydoc_test.bzl @@ -13,8 +13,11 @@ # limitations under the License. # # Convenience macro for skydoc tests. Each target represents two targets: -# a shell test verifying the contents of the golden file, and a genrule -# which will regenerate the golden file. +# 1. A sh_test target which verifies that skydoc, when run on an input file, +# creates output matching the contents of a golden file. +# 2. A genrule target which will generate a new golden file given an input file +# and the current version of skydoc. This target should be used to regenerate +# the golden file if changes are made to skydoc. """Convenience macro for skydoc tests.""" def skydoc_test(name, input_file, golden_file, skydoc): |