diff options
author | w0rp <devw0rp@gmail.com> | 2018-07-01 19:56:17 +0100 |
---|---|---|
committer | w0rp <devw0rp@gmail.com> | 2018-07-01 19:56:24 +0100 |
commit | 2a784010668950ecc6bd8d504b966e94b91db49b (patch) | |
tree | b9194c88c9e3e43d02e62ac90b7d63a8ccc20c5a /run-tests | |
parent | d456ac19ca9e000cf7f73da9856611a69704d089 (diff) | |
download | ale-2a784010668950ecc6bd8d504b966e94b91db49b.zip |
Close #1685 - Move developer documentation to a help file
Diffstat (limited to 'run-tests')
-rwxr-xr-x | run-tests | 25 |
1 files changed, 20 insertions, 5 deletions
@@ -5,12 +5,9 @@ set -u # Author: w0rp <devw0rp@gmail.com> # -# This script runs tests for the ALE project. The following options are -# accepted: +# This script runs tests for the ALE project. Run `./run-tests --help` for +# options, or read the output below. # -# -v Enable verbose output -# --neovim-only Run tests only for NeoVim -# --vim-only Run tests only for Vim image=w0rp/ale current_image_id=13b990377be9 @@ -68,6 +65,24 @@ while [ $# -ne 0 ]; do run_neovim_03_tests=0 shift ;; + --help) + echo 'Usage: ./run-tests [OPTION]... [FILE]...' + echo + echo 'Filenames can be given as arguments to run a subset of tests.' + echo 'For example: ./run-tests test/test_ale_var.vader' + echo + echo 'Options:' + echo ' -v Enable verbose output' + echo ' -q Hide output for successful tests' + echo ' --neovim-only Run tests only for NeoVim 0.2 and 0.3' + echo ' --neovim-02-only Run tests only for NeoVim 0.2' + echo ' --neovim-03-only Run tests only for NeoVim 0.3' + echo ' --vim-only Run tests only for Vim' + echo ' --linters-only Run only Vint and custom checks' + echo ' --help Show this help text' + echo ' -- Stop parsing options after this' + exit 0 + ;; --) shift break |