[PATCH v2 1/1] README: improve README formatting and clarity

[PATCH v2 1/1] README: improve README formatting and clarity

[Ravi Singh]

- Standardize shell command prompts with '#' for readability
- Correct minor typos
- Clarify instructions for running tests.

Signed-off-by: Ravi Singh <ravising@redhat.com>
---
 README | 70 +++++++++++++++++++++++++++++++---------------------------
 1 file changed, 37 insertions(+), 33 deletions(-)

diff --git a/README b/README
index 9e9afe3c..fd27812e 100644
--- a/README
+++ b/README
@@ -97,8 +97,8 @@ Ubuntu or Debian
 
 1. Make sure that package list is up-to-date and install all necessary packages:
 
-   $ sudo apt-get update
-   $ sudo apt-get install acl attr automake bc dbench dump e2fsprogs fio gawk \
+   # sudo apt-get update
+   # sudo apt-get install acl attr automake bc dbench dump e2fsprogs fio gawk \
         gcc git indent libacl1-dev libaio-dev libcap-dev libgdbm-dev libtool \
         libtool-bin liburing-dev libuuid1 lvm2 make psmisc python3 quota sed \
         uuid-dev uuid-runtime xfsprogs linux-headers-$(uname -r) sqlite3 \
@@ -106,7 +106,7 @@ Ubuntu or Debian
 
 2. Install packages for the filesystem(s) being tested:
 
-   $ sudo apt-get install exfatprogs f2fs-tools ocfs2-tools udftools xfsdump \
+   # sudo apt-get install exfatprogs f2fs-tools ocfs2-tools udftools xfsdump \
         xfslibs-dev
 
 Fedora
@@ -114,14 +114,14 @@ Fedora
 
 1. Install all necessary packages from standard repository:
 
-   $ sudo yum install acl attr automake bc dbench dump e2fsprogs fio gawk gcc \
+   # sudo yum install acl attr automake bc dbench dump e2fsprogs fio gawk gcc \
         gdbm-devel git indent kernel-devel libacl-devel libaio-devel \
         libcap-devel libtool liburing-devel libuuid-devel lvm2 make psmisc \
         python3 quota sed sqlite udftools  xfsprogs
 
 2. Install packages for the filesystem(s) being tested:
 
-    $ sudo yum install btrfs-progs exfatprogs f2fs-tools ocfs2-tools xfsdump \
+    # sudo yum install btrfs-progs exfatprogs f2fs-tools ocfs2-tools xfsdump \
         xfsprogs-devel
 
 RHEL or CentOS
@@ -133,7 +133,7 @@ RHEL or CentOS
 2. Install all necessary packages which are available from standard repository
    and EPEL:
 
-   $ sudo yum install acl attr automake bc dbench dump e2fsprogs fio gawk gcc \
+   # sudo yum install acl attr automake bc dbench dump e2fsprogs fio gawk gcc \
         gdbm-devel git indent kernel-devel libacl-devel libaio-devel \
         libcap-devel libtool libuuid-devel lvm2 make psmisc python3 quota sed \
         sqlite udftools xfsprogs
@@ -148,10 +148,10 @@ RHEL or CentOS
 4. Install packages for the filesystem(s) being tested:
 
     For XFS install:
-     $ sudo yum install xfsdump xfsprogs-devel
+     # sudo yum install xfsdump xfsprogs-devel
 
     For exfat install:
-     $ sudo yum install exfatprogs
+     # sudo yum install exfatprogs
 
     For f2fs build and install:
      - see https://git.kernel.org/pub/scm/linux/kernel/git/jaegeuk/f2fs-tools.git/about/
@@ -164,25 +164,25 @@ SUSE Linux Enterprise or openSUSE
 
 1. Install all necessary packages from standard repositories:
 
-   $ sudo zypper install acct automake bc dbench duperemove dump fio gcc git \
+   # sudo zypper install acct automake bc dbench duperemove dump fio gcc git \
         indent libacl-devel libaio-devel libattr-devel libcap libcap-devel \
         libtool liburing-devel libuuid-devel lvm2 make quota sqlite3 xfsprogs
 
 2. Install packages for the filesystem(s) being tested:
 
     For btrfs install:
-     $ sudo zypper install btrfsprogs libbtrfs-devel
+     # sudo zypper install btrfsprogs libbtrfs-devel
 
     For XFS install:
-     $ sudo zypper install xfsdump xfsprogs-devel
+     # sudo zypper install xfsdump xfsprogs-devel
 
 Build and install test, libs and utils
 --------------------------------------
 
-$ git clone git://git.kernel.org/pub/scm/fs/xfs/xfstests-dev.git
-$ cd xfstests-dev
-$ make
-$ sudo make install
+# git clone git://git.kernel.org/pub/scm/fs/xfs/xfstests-dev.git
+# cd xfstests-dev
+# make
+# sudo make install
 
 Setup Environment
 -----------------
@@ -216,12 +216,14 @@ Setup Environment
 5. Copy local.config.example to local.config and edit as needed. The TEST_DEV
    and TEST_DIR are required.
 
+   # cp local.config.example local.config
+
 6. (optional) Create fsgqa test users and groups:
 
-   $ sudo useradd -m fsgqa
-   $ sudo useradd 123456-fsgqa
-   $ sudo useradd fsgqa2
-   $ sudo groupadd fsgqa
+   # sudo useradd -m fsgqa
+   # sudo useradd 123456-fsgqa
+   # sudo useradd fsgqa2
+   # sudo groupadd fsgqa
 
    The "123456-fsgqa" user creation step can be safely skipped if your system
    doesn't support names starting with digits, only a handful of tests require
@@ -251,7 +253,7 @@ For example, to run the tests with loopback partitions:
 
 The config for the setup above is:
 
-    $ cat local.config
+    # cat local.config
     export TEST_DEV=/dev/loop0
     export TEST_DIR=/mnt/test
     export SCRATCH_DEV=/dev/loop1
@@ -316,7 +318,7 @@ Tools specification:
       test, if the kernel supports kmemleak.
  - fsstress:
     - Set FSSTRESS_AVOID and/or FSX_AVOID, which contain options added to
-      the end of fsstresss and fsx invocations, respectively, in case you wish
+      the end of fsstress and fsx invocations, respectively, in case you wish
       to exclude certain operational modes from these tests.
  - core dumps:
     - Set COREDUMP_COMPRESSOR to a compression program to compress crash dumps.
@@ -378,25 +380,27 @@ ______________________
 
 Running tests:
 
-    - cd xfstests
+    - # cd xfstests-dev
     - By default the tests suite will run all the tests in the auto group. These
       are the tests that are expected to function correctly as regression tests,
       and it excludes tests that exercise conditions known to cause machine
       failures (i.e. the "dangerous" tests).
-    - ./check '*/001' '*/002' '*/003'
-    - ./check '*/06?'
-    - Groups of tests maybe ran by: ./check -g [group(s)]
+          # ./check
+    - Running specific tests:
+          # ./check '*/001' '*/002' '*/003'
+          # ./check '*/06?'
+    - Groups of tests maybe ran by: # ./check -g [group(s)]
       See the tests/*/group.list files after building xfstests to learn about
       each test's group memberships.
     - If you want to run all tests regardless of what group they are in
-      (including dangerous tests), use the "all" group: ./check -g all
-    - To randomize test order: ./check -r [test(s)]
+      (including dangerous tests), use the "all" group: # ./check -g all
+    - To randomize test order: # ./check -r [test(s)]
     - You can explicitly specify NFS/AFS/CIFS/OVERLAY, otherwise
       the filesystem type will be autodetected from $TEST_DEV:
-        - for running nfs tests: ./check -nfs [test(s)]
-        - for running afs tests: ./check -afs [test(s)]
-        - for running cifs/smb3 tests: ./check -cifs [test(s)]
-        - for overlay tests: ./check -overlay [test(s)]
+        - for running nfs tests: # ./check -nfs [test(s)]
+        - for running afs tests: # ./check -afs [test(s)]
+        - for running cifs/smb3 tests: # ./check -cifs [test(s)]
+        - for overlay tests: # ./check -overlay [test(s)]
           The TEST and SCRATCH partitions should be pre-formatted
           with another base fs, where the overlay dirs will be created
 
@@ -438,7 +442,7 @@ Test script environment:
 	    $TEST_DEV.
 
 	(b) mkfs a new XFS filesystem on $SCRATCH_DEV, and mount this
-	    on $SCRATCH_MNT. Call the the _require_scratch function
+	    on $SCRATCH_MNT. Call the _require_scratch function
             on startup if you require use of the scratch partition.
             _require_scratch does some checks on $SCRATCH_DEV &
             $SCRATCH_MNT and makes sure they're unmounted. You should
@@ -507,7 +511,7 @@ Test script environment:
 	initialise the test environment correctly, the the build infrastructure
 	also scans the test files for _begin_fstests invocations. It does this
 	to compile the group lists that are used to determine which tests to run
-	when `check` is executed. In other words, test files files must call
+	when `check` is executed. In other words, test files must call
 	_begin_fstest with their intended groups or they will not be run.
 
 	However, because the build infrastructure also uses _begin_fstests as
-- 
2.51.1

[PATCH v2 0/1] README: improve README formatting and clarity

[Ravi Singh]

Hi all,

This patch updates the README examples to use the root shell prompt '#'
instead of '$'. This aligns the documentation examples with typical
shell conventions and reviewer feedback.

Changes since v1:
 - Replaced '$' with '#' in example shell commands
 - Addressed reviewer feedback about correct prompt usage

Thanks for the review and feedback!

Ravi Singh (1):
  README: improve README formatting and clarity

 README | 70 +++++++++++++++++++++++++++++++---------------------------
 1 file changed, 37 insertions(+), 33 deletions(-)

-- 
2.51.1

[PATCH v2 1/1] README: improve README formatting and clarity

[Ravi Singh]

- Standardize shell command prompts with '#' for readability
- Correct minor typos
- Clarify instructions for running tests.

Signed-off-by: Ravi Singh <ravising@redhat.com>
---
 README | 70 +++++++++++++++++++++++++++++++---------------------------
 1 file changed, 37 insertions(+), 33 deletions(-)

diff --git a/README b/README
index 9e9afe3c..fd27812e 100644
--- a/README
+++ b/README
@@ -97,8 +97,8 @@ Ubuntu or Debian
 
 1. Make sure that package list is up-to-date and install all necessary packages:
 
-   $ sudo apt-get update
-   $ sudo apt-get install acl attr automake bc dbench dump e2fsprogs fio gawk \
+   # sudo apt-get update
+   # sudo apt-get install acl attr automake bc dbench dump e2fsprogs fio gawk \
         gcc git indent libacl1-dev libaio-dev libcap-dev libgdbm-dev libtool \
         libtool-bin liburing-dev libuuid1 lvm2 make psmisc python3 quota sed \
         uuid-dev uuid-runtime xfsprogs linux-headers-$(uname -r) sqlite3 \
@@ -106,7 +106,7 @@ Ubuntu or Debian
 
 2. Install packages for the filesystem(s) being tested:
 
-   $ sudo apt-get install exfatprogs f2fs-tools ocfs2-tools udftools xfsdump \
+   # sudo apt-get install exfatprogs f2fs-tools ocfs2-tools udftools xfsdump \
         xfslibs-dev
 
 Fedora
@@ -114,14 +114,14 @@ Fedora
 
 1. Install all necessary packages from standard repository:
 
-   $ sudo yum install acl attr automake bc dbench dump e2fsprogs fio gawk gcc \
+   # sudo yum install acl attr automake bc dbench dump e2fsprogs fio gawk gcc \
         gdbm-devel git indent kernel-devel libacl-devel libaio-devel \
         libcap-devel libtool liburing-devel libuuid-devel lvm2 make psmisc \
         python3 quota sed sqlite udftools  xfsprogs
 
 2. Install packages for the filesystem(s) being tested:
 
-    $ sudo yum install btrfs-progs exfatprogs f2fs-tools ocfs2-tools xfsdump \
+    # sudo yum install btrfs-progs exfatprogs f2fs-tools ocfs2-tools xfsdump \
         xfsprogs-devel
 
 RHEL or CentOS
@@ -133,7 +133,7 @@ RHEL or CentOS
 2. Install all necessary packages which are available from standard repository
    and EPEL:
 
-   $ sudo yum install acl attr automake bc dbench dump e2fsprogs fio gawk gcc \
+   # sudo yum install acl attr automake bc dbench dump e2fsprogs fio gawk gcc \
         gdbm-devel git indent kernel-devel libacl-devel libaio-devel \
         libcap-devel libtool libuuid-devel lvm2 make psmisc python3 quota sed \
         sqlite udftools xfsprogs
@@ -148,10 +148,10 @@ RHEL or CentOS
 4. Install packages for the filesystem(s) being tested:
 
     For XFS install:
-     $ sudo yum install xfsdump xfsprogs-devel
+     # sudo yum install xfsdump xfsprogs-devel
 
     For exfat install:
-     $ sudo yum install exfatprogs
+     # sudo yum install exfatprogs
 
     For f2fs build and install:
      - see https://git.kernel.org/pub/scm/linux/kernel/git/jaegeuk/f2fs-tools.git/about/
@@ -164,25 +164,25 @@ SUSE Linux Enterprise or openSUSE
 
 1. Install all necessary packages from standard repositories:
 
-   $ sudo zypper install acct automake bc dbench duperemove dump fio gcc git \
+   # sudo zypper install acct automake bc dbench duperemove dump fio gcc git \
         indent libacl-devel libaio-devel libattr-devel libcap libcap-devel \
         libtool liburing-devel libuuid-devel lvm2 make quota sqlite3 xfsprogs
 
 2. Install packages for the filesystem(s) being tested:
 
     For btrfs install:
-     $ sudo zypper install btrfsprogs libbtrfs-devel
+     # sudo zypper install btrfsprogs libbtrfs-devel
 
     For XFS install:
-     $ sudo zypper install xfsdump xfsprogs-devel
+     # sudo zypper install xfsdump xfsprogs-devel
 
 Build and install test, libs and utils
 --------------------------------------
 
-$ git clone git://git.kernel.org/pub/scm/fs/xfs/xfstests-dev.git
-$ cd xfstests-dev
-$ make
-$ sudo make install
+# git clone git://git.kernel.org/pub/scm/fs/xfs/xfstests-dev.git
+# cd xfstests-dev
+# make
+# sudo make install
 
 Setup Environment
 -----------------
@@ -216,12 +216,14 @@ Setup Environment
 5. Copy local.config.example to local.config and edit as needed. The TEST_DEV
    and TEST_DIR are required.
 
+   # cp local.config.example local.config
+
 6. (optional) Create fsgqa test users and groups:
 
-   $ sudo useradd -m fsgqa
-   $ sudo useradd 123456-fsgqa
-   $ sudo useradd fsgqa2
-   $ sudo groupadd fsgqa
+   # sudo useradd -m fsgqa
+   # sudo useradd 123456-fsgqa
+   # sudo useradd fsgqa2
+   # sudo groupadd fsgqa
 
    The "123456-fsgqa" user creation step can be safely skipped if your system
    doesn't support names starting with digits, only a handful of tests require
@@ -251,7 +253,7 @@ For example, to run the tests with loopback partitions:
 
 The config for the setup above is:
 
-    $ cat local.config
+    # cat local.config
     export TEST_DEV=/dev/loop0
     export TEST_DIR=/mnt/test
     export SCRATCH_DEV=/dev/loop1
@@ -316,7 +318,7 @@ Tools specification:
       test, if the kernel supports kmemleak.
  - fsstress:
     - Set FSSTRESS_AVOID and/or FSX_AVOID, which contain options added to
-      the end of fsstresss and fsx invocations, respectively, in case you wish
+      the end of fsstress and fsx invocations, respectively, in case you wish
       to exclude certain operational modes from these tests.
  - core dumps:
     - Set COREDUMP_COMPRESSOR to a compression program to compress crash dumps.
@@ -378,25 +380,27 @@ ______________________
 
 Running tests:
 
-    - cd xfstests
+    - # cd xfstests-dev
     - By default the tests suite will run all the tests in the auto group. These
       are the tests that are expected to function correctly as regression tests,
       and it excludes tests that exercise conditions known to cause machine
       failures (i.e. the "dangerous" tests).
-    - ./check '*/001' '*/002' '*/003'
-    - ./check '*/06?'
-    - Groups of tests maybe ran by: ./check -g [group(s)]
+          # ./check
+    - Running specific tests:
+          # ./check '*/001' '*/002' '*/003'
+          # ./check '*/06?'
+    - Groups of tests maybe ran by: # ./check -g [group(s)]
       See the tests/*/group.list files after building xfstests to learn about
       each test's group memberships.
     - If you want to run all tests regardless of what group they are in
-      (including dangerous tests), use the "all" group: ./check -g all
-    - To randomize test order: ./check -r [test(s)]
+      (including dangerous tests), use the "all" group: # ./check -g all
+    - To randomize test order: # ./check -r [test(s)]
     - You can explicitly specify NFS/AFS/CIFS/OVERLAY, otherwise
       the filesystem type will be autodetected from $TEST_DEV:
-        - for running nfs tests: ./check -nfs [test(s)]
-        - for running afs tests: ./check -afs [test(s)]
-        - for running cifs/smb3 tests: ./check -cifs [test(s)]
-        - for overlay tests: ./check -overlay [test(s)]
+        - for running nfs tests: # ./check -nfs [test(s)]
+        - for running afs tests: # ./check -afs [test(s)]
+        - for running cifs/smb3 tests: # ./check -cifs [test(s)]
+        - for overlay tests: # ./check -overlay [test(s)]
           The TEST and SCRATCH partitions should be pre-formatted
           with another base fs, where the overlay dirs will be created
 
@@ -438,7 +442,7 @@ Test script environment:
 	    $TEST_DEV.
 
 	(b) mkfs a new XFS filesystem on $SCRATCH_DEV, and mount this
-	    on $SCRATCH_MNT. Call the the _require_scratch function
+	    on $SCRATCH_MNT. Call the _require_scratch function
             on startup if you require use of the scratch partition.
             _require_scratch does some checks on $SCRATCH_DEV &
             $SCRATCH_MNT and makes sure they're unmounted. You should
@@ -507,7 +511,7 @@ Test script environment:
 	initialise the test environment correctly, the the build infrastructure
 	also scans the test files for _begin_fstests invocations. It does this
 	to compile the group lists that are used to determine which tests to run
-	when `check` is executed. In other words, test files files must call
+	when `check` is executed. In other words, test files must call
 	_begin_fstest with their intended groups or they will not be run.
 
 	However, because the build infrastructure also uses _begin_fstests as
-- 
2.51.1