diff options
Diffstat (limited to 'docs')
| -rw-r--r-- | docs/index.rst | 6 | ||||
| -rw-r--r-- | docs/options.rst | 69 |
2 files changed, 73 insertions, 2 deletions
diff --git a/docs/index.rst b/docs/index.rst index 109963f..7726f0a 100644 --- a/docs/index.rst +++ b/docs/index.rst @@ -1,3 +1,5 @@ +.. program:: minishell_test + minishell_test ============== @@ -72,10 +74,10 @@ Environement variables This test only gives the ``PATH`` and ``TERM`` environment variables to your minishell by default (see :ref:`config env`). -You can test this quickly with the `-t` option (See :ref:`options try`). +You can test this quickly with :option:`--try`. .. warning:: - Please check that your project still work with those settings before creating an issue or messaging me on. + Please check that your project still work with this environment before creating an issue or messaging me on Slack. Bonus ----- diff --git a/docs/options.rst b/docs/options.rst index 56a8c55..7c29529 100644 --- a/docs/options.rst +++ b/docs/options.rst @@ -1,2 +1,71 @@ Command line Options ==================== + +.. code-block:: txt + + usage: minishell_test [-h] [-p PATH] [-l] [-t COMMAND] [-k] [-r BEGIN END] + [--show-range] [-x] [-v] [-b] [-n] [-m] [-g] + [suite ...] + +.. program:: minishell_test + +.. option:: suite + + Test suites/group to run. + It tries to be smart and autocomplete the suite name + (e.g ./run int -> ./run preprocess/interpolation) + + +.. option:: -h, --help + + show this help message and exit + +.. option:: -p <PATH>, --path <PATH> + + Path to minishell directory + +.. option:: -l, --list + + Print available test suites + +.. option:: -t <COMMAND>, --try <COMMAND> + + Run a custom command like this test would + (the only environment variable passed to your executable are TERM and PATH) + +.. option:: -k, --check-leaks + + Run valgrind on tests (disable usual comparison with bash) + +.. option:: -r <BEGIN> <END>, --range <BEGIN> <END> + + Range of test index to run (imply --show-index) + +.. option:: --show-range + + Show test index (useful with --range) + +.. option:: -x, --exit-first + + Exit on first fail + +.. option:: -v, --verbose + + Increase verbosity level (e.g -vv == 2) + +.. option:: -b, --bonus + + Enable bonus tests + +.. option:: -n, --no-bonus + + Disable bonus tests + +.. option:: -m, --make + + Make minishell and exit + +.. option:: -g, --pager + + After running the test, display the result in a pager of your choice + |
