Close #1685 - Move developer documentation to a help file

This commit is contained in:
w0rp
2018-07-01 19:56:17 +01:00
parent d456ac19ca
commit 2a78401066
4 changed files with 197 additions and 176 deletions

View File

@@ -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