diff options
| author | Tim Pepper <tpepper@vmware.com> | 2018-06-05 16:48:49 -0700 |
|---|---|---|
| committer | Tim Pepper <tpepper@vmware.com> | 2018-06-28 11:07:09 -0700 |
| commit | f527442d8b17eff2bc807c980db2f2339e3f891c (patch) | |
| tree | d20dd5964007d653d4410dbaeb5d3d7f864ed67d /hack | |
| parent | a7777c563b3cfc1e4b703d296ecefbcef446a9e0 (diff) | |
hack/verify-generated-docs.sh: clarify error output
When the hack/verify-generated-docs.sh job fails because a generated
file was edited instead of the sigs.yaml file, it is less than clear
from the error message that the user still needs to manually commit the
generated docs in addition to changing the sigs.yaml and validating that
the docs do build. A small additional bit of guidance is appended to
the existing hint in the test error output.
Signed-off-by: Tim Pepper <tpepper@vmware.com>
Diffstat (limited to 'hack')
| -rwxr-xr-x | hack/verify-generated-docs.sh | 3 |
1 files changed, 2 insertions, 1 deletions
diff --git a/hack/verify-generated-docs.sh b/hack/verify-generated-docs.sh index 6c05a1f4..843541ba 100755 --- a/hack/verify-generated-docs.sh +++ b/hack/verify-generated-docs.sh @@ -54,7 +54,8 @@ if [[ ${mismatches} -gt "0" ]]; then fi echo "${mismatches} ${noun} detected." echo "Do not manually edit sig-list.md or README.md files inside the sig folders." - echo "Instead make your changes to sigs.yaml and then run \`make\`."; + echo "Instead make your changes to sigs.yaml, then run \`make\`, and then" + echo "commit your changes to sigs.yaml and any generated docs."; echo "${break}" exit 1; fi |