|author||Dimitri John Ledkov <firstname.lastname@example.org>||2017-02-13 11:24:33 +0000|
|committer||Dimitri John Ledkov <email@example.com>||2017-02-13 11:24:33 +0000|
New upstream release Closes: #849353, #817806, #854915, #845473
Diffstat (limited to 'tests/README.md')
1 files changed, 17 insertions, 5 deletions
diff --git a/tests/README.md b/tests/README.md
index ca45cf6f..bb2846a1 100644
@@ -1,7 +1,8 @@
# Btrfs-progs tests
A testsuite covering functionality of btrfs-progs, ie. the checker, image, mkfs
-and similar tools. There are no special requirements on kernel features, the
+and similar tools. There are no additional requirements on kernel features
+(other than `CONFIG_BTRFS_FS` built-in or module), the
tests build on top of the core functionality like snapshots and device
management. In some cases optional features are turned on by mkfs and the
filesystem image could be mounted, such tests might fail if there's lack of
@@ -106,11 +107,22 @@ are possible.
Note: instrumentation is not applied to privileged commands (anything that uses
the root helper).
+### Verbosity, test tuning
-Setting the variable `TEST_LOG=tty` will print all commands executed by some of
-the wrappers (`run_check` etc), other commands are not printed to the terminal
-(but the full output is in the log).
+* `TEST_LOG=tty` -- setting the variable will print all commands executed by
+ some of the wrappers (`run_check` etc), other commands are not printed to the
+ terminal (but the full output is in the log)
+* `TEST_LOG=dump` -- dump the entire testing log when a test fails
+* `TEST_ENABLE_OVERRIDE` -- defined either as make arguments or via
+ `tests/common.local` to enable additional arguments to some commands, using
+ the variable(s) below (default: false, enable by setting to 'true')
+* `TEST_ARGS_CHECK` -- user-defined arguments to `btrfs check`, before the
+ test-specific arguments
+Multiple values can be separated by `,`.