opnsense-src/share/doc/pjdfstest
Warner Losh e9ac41698b Remove residual blank line at start of Makefile
This is a residual of the $FreeBSD$ removal.

MFC After: 3 days (though I'll just run the command on the branches)
Sponsored by: Netflix
2024-07-15 16:43:39 -06:00
..
Makefile Remove residual blank line at start of Makefile 2024-07-15 16:43:39 -06:00
Makefile.depend Remove $FreeBSD$: one-line sh pattern 2023-08-16 11:55:03 -06:00
README

The pjdfstest test suite is normally run by kyua.  It requires kyua 0.11 or
newer. This README describes how to use pjdfstest in the default configuration
(kyua work directory), with a specific filesystem path, and with prove(1).

Method 1. Executing with default configuration (kyua work directory)

    1. Elevate privileges:
       % su -
    2. cd to the tests directory:
       % cd /usr/tests/sys/pjdfstest
    3. Run kyua:
       % kyua test

   Executing the commands as shown above will run pjdfstest in the kyua work
   directory. The kyua work directory defaults to a random generated path under
   /tmp; please see TMPDIR in kyua(1) for more details on how the temporary path
   is chosen with kyua.

Method 2. Executing with a specific filesystem path (in this case /mnt)

    1. Elevate privileges:
       % su -
    2. cd to the tests directory:
       % cd /usr/tests/sys/pjdfstest
    3. Run kyua:
       % env TMPDIR=/mnt kyua test

   Note that if HOME is undefined, this will result in kyua's logfile being
   placed in TMPDIR, which may not be what you want.  You can always use
   --logfile to explicitly select the log location.

Method 3. Executing pjdfstest with prove

    1. Elevate privileges:
       % su -
    2. cd to the temporary directory of your choice
       % cd /mnt
    3. Invoke a specific test manually
       % prove -rv /usr/tests/sys/pjdfstest/chmod/00