Commit 6f0b71f0 authored by Tilman Kranz's avatar Tilman Kranz

markdown formatting error

parent 6f54122b
......@@ -25,16 +25,16 @@ ending with `.sh` or `.bash` is tested.
Testing an executable means
1. Running it through [Shellcheck.md](Shellcheck), and then
1. Running it through [Shellcheck](Shellcheck.md), and then
2. executing it.
Before executing the script, the [utils/test.sh](Test Utility) scans the
file for special comments containing `@Test [ARGUMENT ...]`, `@TestRv INT`
and `@TestInteractive true|false`, that, if present, indicate if and how the
test should be run.
Before executing the script, the [test utility](utils/test.sh) scans the file
for special comments containing `@Test [ARGUMENT ...]`, `@TestRv INT` and
`@TestInteractive true|false`, that, if present, indicate if and how the test
should be run.
Arguments for the test execution can be provided by including a line as
follows somewhere in the script:
Arguments for the test execution can be provided by including a line as follows
somewhere in the script:
```shell
# @Test --foo --bar
......@@ -47,13 +47,11 @@ if the script contains the following line:
# @TestInteractive true
```
Running the script should return exit code 0 by default for the test to
succeed. If a different value is expected, it can be provided using the
`@TestRv` comment. For example, to indicate that a script, when tested,
should return an exit code 1:
For the test to succeed, by default, the script is expected to exit wth code 0.
If a different exit code is expected, it can be provided using the `@TestRv`
comment as follows:
```shell
# @TestRv 1
```
Markdown is supported
0%
or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment