1*b0d29bc4SBrooks Davis.\" Copyright 2012 The Kyua Authors. 2*b0d29bc4SBrooks Davis.\" All rights reserved. 3*b0d29bc4SBrooks Davis.\" 4*b0d29bc4SBrooks Davis.\" Redistribution and use in source and binary forms, with or without 5*b0d29bc4SBrooks Davis.\" modification, are permitted provided that the following conditions are 6*b0d29bc4SBrooks Davis.\" met: 7*b0d29bc4SBrooks Davis.\" 8*b0d29bc4SBrooks Davis.\" * Redistributions of source code must retain the above copyright 9*b0d29bc4SBrooks Davis.\" notice, this list of conditions and the following disclaimer. 10*b0d29bc4SBrooks Davis.\" * Redistributions in binary form must reproduce the above copyright 11*b0d29bc4SBrooks Davis.\" notice, this list of conditions and the following disclaimer in the 12*b0d29bc4SBrooks Davis.\" documentation and/or other materials provided with the distribution. 13*b0d29bc4SBrooks Davis.\" * Neither the name of Google Inc. nor the names of its contributors 14*b0d29bc4SBrooks Davis.\" may be used to endorse or promote products derived from this software 15*b0d29bc4SBrooks Davis.\" without specific prior written permission. 16*b0d29bc4SBrooks Davis.\" 17*b0d29bc4SBrooks Davis.\" THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS 18*b0d29bc4SBrooks Davis.\" "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT 19*b0d29bc4SBrooks Davis.\" LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR 20*b0d29bc4SBrooks Davis.\" A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT 21*b0d29bc4SBrooks Davis.\" OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, 22*b0d29bc4SBrooks Davis.\" SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT 23*b0d29bc4SBrooks Davis.\" LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, 24*b0d29bc4SBrooks Davis.\" DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY 25*b0d29bc4SBrooks Davis.\" THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT 26*b0d29bc4SBrooks Davis.\" (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE 27*b0d29bc4SBrooks Davis.\" OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. 28*b0d29bc4SBrooks Davis.Dd October 13, 2014 29*b0d29bc4SBrooks Davis.Dt KYUA-LIST 1 30*b0d29bc4SBrooks Davis.Os 31*b0d29bc4SBrooks Davis.Sh NAME 32*b0d29bc4SBrooks Davis.Nm "kyua list" 33*b0d29bc4SBrooks Davis.Nd Lists test cases and their metadata 34*b0d29bc4SBrooks Davis.Sh SYNOPSIS 35*b0d29bc4SBrooks Davis.Nm 36*b0d29bc4SBrooks Davis.Op Fl -build-root Ar path 37*b0d29bc4SBrooks Davis.Op Fl -kyuafile Ar file 38*b0d29bc4SBrooks Davis.Op Fl -verbose 39*b0d29bc4SBrooks Davis.Ar test_case1 Op Ar .. test_caseN 40*b0d29bc4SBrooks Davis.Sh DESCRIPTION 41*b0d29bc4SBrooks DavisThe 42*b0d29bc4SBrooks Davis.Nm 43*b0d29bc4SBrooks Daviscommand scans all the test programs and test cases in a test suite (as 44*b0d29bc4SBrooks Davisdefined by a 45*b0d29bc4SBrooks Davis.Xr kyuafile 5 ) 46*b0d29bc4SBrooks Davisand prints a list of all their names, optionally accompanied by any metadata 47*b0d29bc4SBrooks Davisproperties they have. 48*b0d29bc4SBrooks Davis.Pp 49*b0d29bc4SBrooks DavisThe optional arguments to 50*b0d29bc4SBrooks Davis.Nm 51*b0d29bc4SBrooks Davisare used to select which test programs or test cases to run. 52*b0d29bc4SBrooks DavisThese are filters and are described below in 53*b0d29bc4SBrooks Davis.Sx Test filters . 54*b0d29bc4SBrooks Davis.Pp 55*b0d29bc4SBrooks DavisThis command must be run within a test suite or a test suite must be 56*b0d29bc4SBrooks Davisprovided with the 57*b0d29bc4SBrooks Davis.Fl -kyuafile 58*b0d29bc4SBrooks Davisflag. 59*b0d29bc4SBrooks Davis.Pp 60*b0d29bc4SBrooks DavisThe following subcommand options are recognized: 61*b0d29bc4SBrooks Davis.Bl -tag -width XX 62*b0d29bc4SBrooks Davis.It Fl -build-root Ar path 63*b0d29bc4SBrooks DavisSpecifies the build root in which to find the test programs referenced 64*b0d29bc4SBrooks Davisby the Kyuafile, if different from the Kyuafile's directory. 65*b0d29bc4SBrooks DavisSee 66*b0d29bc4SBrooks Davis.Sx Build directories 67*b0d29bc4SBrooks Davisbelow for more information. 68*b0d29bc4SBrooks Davis.It Fl -kyuafile Ar path , Fl k Ar path 69*b0d29bc4SBrooks DavisSpecifies the Kyuafile to process. 70*b0d29bc4SBrooks DavisDefaults to a 71*b0d29bc4SBrooks Davis.Pa Kyuafile 72*b0d29bc4SBrooks Davisfile in the current directory. 73*b0d29bc4SBrooks Davis.It Fl -verbose , Fl v 74*b0d29bc4SBrooks DavisPrints metadata properties for every test case. 75*b0d29bc4SBrooks Davis.El 76*b0d29bc4SBrooks Davis.Ss Build directories 77*b0d29bc4SBrooks Davis__include__ build-root.mdoc COMMAND=list 78*b0d29bc4SBrooks Davis.Ss Test filters 79*b0d29bc4SBrooks Davis__include__ test-filters.mdoc 80*b0d29bc4SBrooks Davis.Sh EXIT STATUS 81*b0d29bc4SBrooks DavisThe 82*b0d29bc4SBrooks Davis.Nm 83*b0d29bc4SBrooks Daviscommand returns 0 on success or 1 if any of the given test case filters 84*b0d29bc4SBrooks Davisdoes not match any test case. 85*b0d29bc4SBrooks Davis.Pp 86*b0d29bc4SBrooks DavisAdditional exit codes may be returned as described in 87*b0d29bc4SBrooks Davis.Xr kyua 1 . 88*b0d29bc4SBrooks Davis.Sh SEE ALSO 89*b0d29bc4SBrooks Davis.Xr kyua 1 , 90*b0d29bc4SBrooks Davis.Xr kyuafile 5 91