Skip to content

Commit

Permalink
Apply suggestions from code review
Browse files Browse the repository at this point in the history
Co-authored-by: Johan Torin <jtorin@users.noreply.github.com>
  • Loading branch information
t2gran and jtorin authored Mar 12, 2024
1 parent 78a3e9c commit 50bd9db
Show file tree
Hide file tree
Showing 2 changed files with 6 additions and 3 deletions.
2 changes: 1 addition & 1 deletion script/Readme.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ This folder is intended for various scripts used during the OTP development. The

If you want to submit your own scripts, you need to include:
- A header at the beginning of the script stating who the owner is.
- The scrip should print some usage documentation if invoked with `--help` and `-h`.
- The script should print some usage documentation if invoked with `--help` and `-h`.

The regular pull-request approval process is required for submitting new scripts and changing
existing one. The reviewers are responsible for:
Expand Down
7 changes: 5 additions & 2 deletions script/run-and-test-otp
Original file line number Diff line number Diff line change
Expand Up @@ -36,10 +36,13 @@ if [ "$1" == "-h" ] || [ "$1" == "--help" ]; then
echo " 4. Test the response, search for a unexpected token. If the token is"
echo " NOT present the test is GOOD, if not it is BAD"
echo ""
echo "You need to edit the following variables in the beginning of the script:"
echo "Before using this script you should copy it to a folder which is NOT"
echo "under version control and then edit it. You must provide a query, a test and the"
echo "path to the otp data root directory with the OTP configuration files. You need to"
echo "edit the following variables in the beginning of the script:"
echo " - QUERY - the HTTP URL query to call using curl"
echo " - SEARCH_FOR - The string token to search for - if it is present the test FAILS!"
echo " - DATA_DIR - File catalog where the the OTP config files is (build-config.json & router-config.json)"
echo " - DATA_DIR - File catalog where the OTP config files is (build-config.json & router-config.json)"
echo ""
echo "This script is intended used together with 'git bisect' (binary search for good and bad"
echo "commits), but it works well with manual changes in the code as well. When you have found"
Expand Down

0 comments on commit 50bd9db

Please sign in to comment.