diff --git a/README.md b/README.md index 4ebe4b1d..e0d1b8aa 100644 --- a/README.md +++ b/README.md @@ -73,20 +73,20 @@ run_tests.sh or manually in t/. The following variables are available: - * NAME (recommend): radare2 command being tested (e.g. px). - * FILE (optional): File argument for radare2 (defaults to '-') - * ARGS (optional): Additional arguments for radare2. If not present - no additional arguments are used. - * CMDS (required): Commands to run, one per line. Just like in - interactive mode. - * EXPECT (required): Expected stdout output. - * EXPECT_ERR (optional): Expected stderr output. - * FILTER (optional): Filter program (like grep or sed) to filter - radare2's output before comparing it with EXPECT. - Useful to fix random output to generate stable tests. - * BROKEN (optional): This tests documents a bug which is not yet fixed. - * EXITCODE (optional): Check the exit code of radare2 matches. Can be used - to check handling of invalid arguments. + * NAME (string)(recommend): radare2 command being tested (e.g. px). + * FILE (path)(optional): File argument for radare2 (defaults to '-') + * ARGS (string)(optional): Additional arguments for radare2. If not + present no additional arguments are used. + * CMDS (string)(required): Commands to run, one per line. Just like in + interactive mode. + * EXPECT (string)(required): Expected stdout output. + * EXPECT_ERR (string)(optional): Expected stderr output. + * FILTER (string)(optional): Filter program (like grep or sed) to filter + radare2's output before comparing it with EXPECT. + Useful to fix random output to generate stable tests. + * BROKEN (boolean)(optional): This tests documents a bug which is not yet fixed. + * EXITCODE (number)(optional): Check the exit code of radare2 matches. Can be used + to check handling of invalid arguments. All uppercase variable names are reserved for the test system.