Skip to content

Command Line Options

Jump to bottom
trentmeester edited this page Apr 18, 2012 · 37 revisions

tnvme’s command line options will most likely be forever growing. The most accurate place to gather details of those options are via the command line itself by requesting help: ./tnvme --help. However certain options are complex and so it warrants a more extensive background explanation as will be found herein.

The command line options implement short and long versions. The short versions work by specifying any associated parameters immediately after without any whitespace as follows: ./tnvme --t3:0.04. The long options work by specifying an equal sign after the option without any whitespace as follows: ./tnvme --test=3:0.0.4.

-v(--rev) <spec>

tnvme executes test cases based upon a targeted NVMe specification. As new revisions of the specification are released from the working group, changes must be made to the test cases to adapt. Programmatically tnvme solves this via C++ polymorphism. A developer will derive child classes from older base classes and modify/enhance the appropriate logic. A developer can specify which revision all tests will target via this command line option. For more details refer to Test Strategy.

-s(--summary)

Reports a summary of all tests cases which tnvme actively supports. The output from this option is filtered by command line option -v(--rev) .

-a(--detail) [<grp> | <grp>:<test>]

This option reports lengthy, highly detail, test documentation. The output of this option is filtered by command line option -v(--rev) . The intention of this option is meant to reasonably answer the question, “What does this test do?”. The optional parameter, if absent, instructs tnvme to report all details for all tests in all groups. If a single group number is supplied, then tnvme reports all details for all tests contained within that group only. If a single test is supplied by qualifying it with its associated group number, then the details for that test only is reported.

[username@server ~/tnvme]$ ./tnvme --detail=3:0.0.4
tnvme binary: v/2.4
tnvme compiled against dnvme API: v/1.4.0
dnvme API residing within kernel: v/1.4.0
3: Group:Basic Initialization
    0.0.7: Test:Create contiguous IOCQ(irq) and IOSQ's
      Compliance: revision 1.0b, section 7
         Issue the admin commands Create contiguous I/O SQ and Create I/Q
         CQ(irq) to the ASQ and reap the resulting CE's from the ACQ to certify
         those Q's have been created.

Clone this wiki locally