[PATCH 0/4] README: Fix setup, btrfs and distro info

[PATCH 0/4] README: Fix setup, btrfs and distro info

[Gabriel Niebler]

The README had some incorrect environment setup information in the quick start
section and some outdated info related to btrfs testing.

This patchset fixes that, while also adding some more distro specfic setup info.

Gabriel Niebler (4):
  README: Fix environment setup quick start
  README: Adjust and add btrfs testing information
  README: Add command to install required packages on SUSE
  README: Fix indentation to be consistent

 README | 40 +++++++++++++++++++++++++---------------
 1 file changed, 25 insertions(+), 15 deletions(-)

[PATCH 1/4] README: Fix environment setup quick start

[Gabriel Niebler]

Following the old quick start information would not get a new user to run
tests with their configuration, because it was not accurate to how the check
script actually works.

By default, the script looks for *.config files in HOST_CONFIG_DIR, which
defaults to '.config' if unset. The README now reflects that.

Signed-off-by: Gabriel Niebler <gniebler@suse.com>
---
 README | 6 ++++--
 1 file changed, 4 insertions(+), 2 deletions(-)

diff --git a/README b/README
index 9f01aa10..7e36905e 100644
--- a/README
+++ b/README
@@ -61,8 +61,10 @@ Preparing system for tests:
 
     - setup your environment
 	Quick start:
-	- copy local.config.example to local.config and edit as needed
-	Or:
+        - set HOST_CONFIG_DIR to a path of your choice (ideally outside the git tree)
+        - copy configs/localhost.config there and edit as needed
+        - also consult local.config.example for inspiration
+	These are the most important environment variables you may want to set there:
         - setenv TEST_DEV "device containing TEST PARTITION"
         - setenv TEST_DIR "mount point of TEST PARTITION"
 	- optionally:
-- 
2.35.1

[PATCH 2/4] README: Adjust and add btrfs testing information

[Gabriel Niebler]

The system preparation info for btrfs specific tests was a little outdated,
as many tests require at least 5 indepedent scratch disks, which should be
of the same size and at least 10GB each. This patch fixes that.

There are also a few places in the README that assume the FS under test is XFS.
This changes these lines to extend to other filesystems,
to clarify this is an option.

Signed-off-by: Gabriel Niebler <gniebler@suse.com>
---
 README | 25 ++++++++++++++-----------
 1 file changed, 14 insertions(+), 11 deletions(-)

diff --git a/README b/README
index 7e36905e..65e7ed7b 100644
--- a/README
+++ b/README
@@ -34,7 +34,8 @@ ______________________
 
 Preparing system for tests:
 
-    - compile XFS into your kernel or load XFS modules
+    - If you wish to test XFS, compile XFS into your kernel or load XFS modules,
+      same for btrfs.
     - install administrative tools specific to the filesystem you wish to test
     - If you wish to run the udf components of the suite install
       mkudffs. Also download and build the Philips UDF Verification Software
@@ -42,9 +43,9 @@ Preparing system for tests:
       binary to xfstests/src/. If you wish to disable UDF verification test
       set the environment variable DISABLE_UDF_TEST to 1.
 
-    - create one or two partitions to use for testing
+    - create one or more partitions to use for testing
         - one TEST partition
-            - format as XFS, mount & optionally populate with
+            - format as XFS (or FS of choice), mount & optionally populate with
               NON-IMPORTANT stuff
         - one SCRATCH partition (optional)
             - leave empty and expect this partition to be clobbered
@@ -52,12 +53,13 @@ Preparing system for tests:
               not be run.
               (SCRATCH and TEST must be two DIFFERENT partitions)
               OR
-        - for btrfs only: some btrfs test cases will need 3 or more independent
-              SCRATCH disks which should be set using SCRATCH_DEV_POOL (for eg:
-              SCRATCH_DEV_POOL="/dev/sda /dev/sdb /dev/sdc") with which
-              SCRATCH_DEV should be unused by the tester, and for the legacy
-              support SCRATCH_DEV will be set to the first disk of the
-              SCRATCH_DEV_POOL by xfstests script.
+        - for btrfs only: some btrfs test cases will need up to 5 independent,
+              equally sized SCRATCH disks of at least 10GB each, which should be
+              set using SCRATCH_DEV_POOL
+              (e.g.: SCRATCH_DEV_POOL="/dev/sda /dev/sdb /dev/sdc …"),
+              in which case SCRATCH_DEV should be unset by the tester, and for
+              legacy support SCRATCH_DEV will be set to the first disk of the
+              SCRATCH_DEV_POOL by the xfstests scripts.
 
     - setup your environment
 	Quick start:
@@ -69,7 +71,8 @@ Preparing system for tests:
         - setenv TEST_DIR "mount point of TEST PARTITION"
 	- optionally:
              - setenv SCRATCH_DEV "device containing SCRATCH PARTITION" OR
-               (btrfs only) setenv SCRATCH_DEV_POOL "to 3 or more SCRATCH disks for
+               (btrfs only) setenv SCRATCH_DEV_POOL "3 or more (ideally 5)
+               SCRATCH disks (ideally of equal size and at least 10GB each) for
                testing btrfs raid concepts"
              - setenv SCRATCH_MNT "mount point for SCRATCH PARTITION"
              - setenv TAPE_DEV "tape device for testing xfsdump"
@@ -143,7 +146,7 @@ Preparing system for tests:
     - if testing xfsdump, make sure the tape devices have a
       tape which can be overwritten.
 
-    - make sure $TEST_DEV is a mounted XFS partition
+    - make sure $TEST_DEV is a mounted XFS (or FS of choice) partition
     - make sure that $SCRATCH_DEV or $SCRATCH_DEV_POOL contains nothing useful
 
 Running tests:
-- 
2.35.1

[PATCH 3/4] README: Add command to install required packages on SUSE

[Gabriel Niebler]

The README already listed how to install the required packages on other popular
distributions. Since a lot of filesystem development happens on SUSE systems and
both the command as well as the list of packages are slightly different, it only
made sense to include these.

Signed-off-by: Gabriel Niebler <gniebler@suse.com>
---
 README | 5 +++++
 1 file changed, 5 insertions(+)

diff --git a/README b/README
index 65e7ed7b..657fb2f6 100644
--- a/README
+++ b/README
@@ -18,6 +18,11 @@ _______________________
 	libcap-devel
 	(Older distributions may require xfsprogs-qa-devel as well.)
 	(Note that for RHEL and CentOS, you may need the EPEL repo.)
+  For openSUSE or SUSE Linux Enterprise:
+	sudo zypper install acct automake bc dbench duperemove dump fio \
+	gcc indent libacl-devel libaio-devel libattr-devel libbtrfs-devel \
+	libcap libcap-devel libtool liburing-devel libuuid-devel lvm2 make \
+	quota sqlite3 xfsdump xfsprogs xfsprogs-devel
 - run make
 - run make install
 - create fsgqa test user ("sudo useradd -m fsgqa")
-- 
2.35.1

[PATCH 4/4] README: Fix indentation to be consistent

[Gabriel Niebler]

Fix two lines that were indented with TABS when everything around them uses spaces

Signed-off-by: Gabriel Niebler <gniebler@suse.com>
---
 README | 4 ++--
 1 file changed, 2 insertions(+), 2 deletions(-)

diff --git a/README b/README
index 657fb2f6..f43a5a8c 100644
--- a/README
+++ b/README
@@ -83,9 +83,9 @@ Preparing system for tests:
              - setenv TAPE_DEV "tape device for testing xfsdump"
              - setenv RMT_TAPE_DEV "remote tape device for testing xfsdump"
              - setenv RMT_IRIXTAPE_DEV "remote IRIX tape device for testing xfsdump"
-	     - setenv SCRATCH_LOGDEV "device for scratch-fs external log"
+             - setenv SCRATCH_LOGDEV "device for scratch-fs external log"
              - setenv SCRATCH_RTDEV "device for scratch-fs realtime data"
-	     - setenv TEST_LOGDEV "device for test-fs external log"
+             - setenv TEST_LOGDEV "device for test-fs external log"
              - setenv TEST_RTDEV "device for test-fs realtime data"
              - if TEST_LOGDEV and/or TEST_RTDEV, these will always be used.
              - if SCRATCH_LOGDEV and/or SCRATCH_RTDEV, the USE_EXTERNAL
-- 
2.35.1

Re: [PATCH 0/4] README: Fix setup, btrfs and distro info

[Dave Chinner]

On Thu, Mar 03, 2022 at 02:28:00PM +0100, Gabriel Niebler wrote:
> The README had some incorrect environment setup information in the quick start
> section and some outdated info related to btrfs testing.
> 
> This patchset fixes that, while also adding some more distro specfic setup info.
> 
> Gabriel Niebler (4):
>   README: Fix environment setup quick start
>   README: Adjust and add btrfs testing information
>   README: Add command to install required packages on SUSE
>   README: Fix indentation to be consistent

This document is in the process of a major update:

https://lore.kernel.org/fstests/20220228202849.183568-1-aalbersh@redhat.com/T/#m257b55c7ee6a2fb3de17df5ea2c575e2541e01f6

It would be best to check whether these issues still need fixing
after the above patch is applied and then rebase the changes on top
of that to be consistent with the new structure and layout.

Cheers,

Dave.
-- 
Dave Chinner
david@fromorbit.com