| onqtam | 7630535 | 2017-05-01 20:25:09 +0300 | [diff] [blame] | 1 | [doctest] |
| 2 | [doctest] boolean values: "1/on/yes/true" or "0/off/no/false" |
| 3 | [doctest] filter values: "str1,str2,str3" (comma separated strings) |
| 4 | [doctest] |
| 5 | [doctest] filters use wildcards for matching strings |
| 6 | [doctest] something passes a filter if any of the strings in a filter matches |
| 7 | [doctest] |
| 8 | [doctest] ALL FLAGS, OPTIONS AND FILTERS ALSO AVAILABLE WITH A "dt-" PREFIX!!! |
| 9 | [doctest] |
| 10 | [doctest] Query flags - the program quits after them. Available: |
| 11 | |
| 12 | -?, --help, -h prints this message |
| 13 | -v, --version prints the version |
| 14 | -c, --count prints the number of matching tests |
| 15 | -ltc, --list-test-cases lists all matching tests by name |
| 16 | -lts, --list-test-suites lists all matching test suites |
| 17 | |
| 18 | [doctest] The available <int>/<string> options/filters are: |
| 19 | |
| 20 | -tc, --test-case=<filters> filters tests by their name |
| 21 | -tce, --test-case-exclude=<filters> filters OUT tests by their name |
| 22 | -sf, --source-file=<filters> filters tests by their file |
| 23 | -sfe, --source-file-exclude=<filters> filters OUT tests by their file |
| 24 | -ts, --test-suite=<filters> filters tests by their test suite |
| 25 | -tse, --test-suite-exclude=<filters> filters OUT tests by their test suite |
| 26 | -sc, --subcase=<filters> filters subcases by their name |
| 27 | -sce, --subcase-exclude=<filters> filters OUT subcases by their name |
| 28 | -ob, --order-by=<string> how the tests should be ordered |
| 29 | <string> - by [file/suite/name/rand] |
| 30 | -rs, --rand-seed=<int> seed for random ordering |
| 31 | -f, --first=<int> the first test passing the filters to |
| 32 | execute - for range-based execution |
| 33 | -l, --last=<int> the last test passing the filters to |
| 34 | execute - for range-based execution |
| 35 | -aa, --abort-after=<int> stop after <int> failed assertions |
| 36 | -scfl,--subcase-filter-levels=<int> apply filters for the first <int> levels |
| 37 | |
| 38 | [doctest] Bool options - can be used like flags and true is assumed. Available: |
| 39 | |
| 40 | -s, --success=<bool> include successful assertions in output |
| 41 | -cs, --case-sensitive=<bool> filters being treated as case sensitive |
| 42 | -e, --exit=<bool> exits after the tests finish |
| onqtam | 68d0f1d | 2017-05-07 20:45:09 +0300 | [diff] [blame] | 43 | -d, --duration=<bool> prints the time duration of each test |
| onqtam | 7630535 | 2017-05-01 20:25:09 +0300 | [diff] [blame] | 44 | -nt, --no-throw=<bool> skips exceptions-related assert checks |
| 45 | -ne, --no-exitcode=<bool> returns (or exits) always with success |
| 46 | -nr, --no-run=<bool> skips all runtime doctest operations |
| 47 | -nv, --no-version=<bool> omit the framework version in the output |
| 48 | -nc, --no-colors=<bool> disables colors in output |
| 49 | -fc, --force-colors=<bool> use colors even when not in a tty |
| 50 | -nb, --no-breaks=<bool> disables breakpoints in debuggers |
| onqtam | 6c7369e | 2017-05-05 11:51:10 +0300 | [diff] [blame] | 51 | -ns, --no-skip=<bool> don't skip test cases marked as skip |
| onqtam | 1655b24 | 2018-05-10 15:29:21 +0300 | [diff] [blame^] | 52 | -gfl, --gnu-file-line=<bool> :n: vs (n): for line numbers in output |
| onqtam | 7630535 | 2017-05-01 20:25:09 +0300 | [diff] [blame] | 53 | -npf, --no-path-filenames=<bool> only filenames and no paths in output |
| 54 | -nln, --no-line-numbers=<bool> 0 instead of real line numbers in output |
| 55 | |
| 56 | [doctest] for more information visit the project documentation |
| 57 | |