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