diff --git a/CHANGES b/CHANGES index 66f5a0c293..da5d9d0b78 100644 --- a/CHANGES +++ b/CHANGES @@ -1,4 +1,12 @@ +2.6-127 | 2019-02-15 17:51:51 -0600 + + * Skip autogenerated doc coverage test for Travis pull requests (Jon Siwek, Corelight) + + * Add rstrip and lstrip BIFs (Zeke Medley) + + * Improve format of conn_state docs (Jon Siwek, Corelight) + 2.6-117 | 2019-02-13 16:14:50 -0800 * Improve format of conn_state docs (Jon Siwek, Corelight) diff --git a/VERSION b/VERSION index 5f12dc8c47..1f77b677b7 100644 --- a/VERSION +++ b/VERSION @@ -1 +1 @@ -2.6-117 +2.6-127 diff --git a/testing/btest/coverage/sphinx-broxygen-docs.sh b/testing/btest/coverage/sphinx-broxygen-docs.sh index 37a28403ad..ab194cb027 100644 --- a/testing/btest/coverage/sphinx-broxygen-docs.sh +++ b/testing/btest/coverage/sphinx-broxygen-docs.sh @@ -1,13 +1,21 @@ # This script checks whether the reST docs generated by broxygen are stale. -# If this test fails, then simply run: +# If this test fails when testing the master branch, then simply run: # # testing/scripts/gen-broxygen-docs.sh # -# and then include the changes in your commit. +# and then commit the changes. # # @TEST-EXEC: bash $SCRIPTS/gen-broxygen-docs.sh ./doc # @TEST-EXEC: bash %INPUT +if [ -n "$TRAVIS_PULL_REQUEST" ]; then + if [ "$TRAVIS_PULL_REQUEST" != "false" ]; then + # Don't run this test on Travis for pull-requests, just let someone + # manually update zeek-docs for things when merging to master. + exit 0 + fi +fi + function check_diff { local file=$1 @@ -16,12 +24,19 @@ function check_diff if [ $? -ne 0 ]; then echo "============================" 1>&2 + echo "" 1>&2 echo "$DIST/$file is outdated" 1>&2 - echo "Re-run the following command:" 1>&2 + echo "" 1>&2 + echo "You can ignore this failure if testing changes that you will" 1>&2 + echo "submit in a pull-request." 1>&2 + echo "" 1>&2 + echo "If this fails in the master branch or when merging to master," 1>&2 + echo "re-run the following command:" 1>&2 echo "" 1>&2 echo " $SCRIPTS/gen-broxygen-docs.sh" 1>&2 echo "" 1>&2 - echo "And then include the changes in your commit" 1>&2 + echo "Then commit/push the changes in the zeek-docs repo" 1>&2 + echo "(the doc/ directory in the zeek repo)." 1>&2 exit 1 fi }