From 9aa0c422b82c15fee1ac5cd3b0fae2ebe358d64a Mon Sep 17 00:00:00 2001 From: David Sterba Date: Thu, 8 Feb 2018 18:44:41 +0100 Subject: btrfs-progs: tests: document exported testsuite Signed-off-by: David Sterba --- tests/README.md | 25 +++++++++++++++++++++++++ 1 file changed, 25 insertions(+) diff --git a/tests/README.md b/tests/README.md index c6d89a5c..d4b80da1 100644 --- a/tests/README.md +++ b/tests/README.md @@ -201,6 +201,31 @@ the fuzz tests always succeed when run on random checked out. This helps bisectability. +# Exported testsuite + +The tests are typically run from git on binaries built from the git sources. It +is possible to extract only the testsuite files and run it independently. Use + +```shell +$ make testsuite +``` + +This will gather scripts and generate `tests/btrfs-progs-tests.tar.gz`. The +files inside the tar are in the top level directory, make sure you extract +the contents to an empty directory. From there you can start the tests as +described above (the non-make variant). + +By default the binaries found in `$PATH` are used, this will normally mean the +system binaries. You can also override the `$TOP` shell variable and this +path will be used as prefix for all btrfs binaries inside the tests. + +There are some utilities that are not distributed but are necessary for the +tests. They are in the top level directory of the testsuite and their path +cannot be set. + +The tests assume write acesss to their directories. + + # Coding style, best practices ## do -- cgit v1.2.3