84 lines
3 KiB
Groff
84 lines
3 KiB
Groff
|
.\" Copyright 2012 Google Inc.
|
||
|
|
.\" All rights reserved.
|
||
|
|
.\"
|
||
|
|
.\" Redistribution and use in source and binary forms, with or without
|
||
|
|
.\" modification, are permitted provided that the following conditions are
|
||
|
|
.\" met:
|
||
|
|
.\"
|
||
|
|
.\" * Redistributions of source code must retain the above copyright
|
||
|
|
.\" notice, this list of conditions and the following disclaimer.
|
||
|
|
.\" * Redistributions in binary form must reproduce the above copyright
|
||
|
|
.\" notice, this list of conditions and the following disclaimer in the
|
||
|
|
.\" documentation and/or other materials provided with the distribution.
|
||
|
|
.\" * Neither the name of Google Inc. nor the names of its contributors
|
||
|
|
.\" may be used to endorse or promote products derived from this software
|
||
|
|
.\" without specific prior written permission.
|
||
|
|
.\"
|
||
|
|
.\" THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
|
||
|
|
.\" "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
|
||
|
|
.\" LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
|
||
|
|
.\" A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
|
||
|
|
.\" OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
|
||
|
|
.\" SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
|
||
|
|
.\" LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
|
||
|
|
.\" DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
|
||
|
|
.\" THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
|
||
|
|
.\" (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
|
||
|
|
.\" OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
|
||
|
|
.Dd September 9, 2012
|
||
|
|
.Dt KYUA-LIST 1
|
||
|
|
.Os
|
||
|
|
.Sh NAME
|
||
|
|
.Nm list
|
||
|
|
.Nd Lists test cases and their metadata
|
||
|
|
.Sh SYNOPSIS
|
||
|
|
.Nm
|
||
|
|
.Op Fl -build-root Ar path
|
||
|
|
.Op Fl -kyuafile Ar file
|
||
|
|
.Op Fl -verbose
|
||
|
|
.Ar test_case1 Op Ar .. test_caseN
|
||
|
|
.Sh DESCRIPTION
|
||
|
|
The
|
||
|
|
.Nm
|
||
|
|
command scans all the test programs and test cases in a test suite and
|
||
|
|
prints a list of all their names, optionally accompanied by any metadata
|
||
|
|
properties they have.
|
||
|
|
.Pp
|
||
|
|
The optional arguments to
|
||
|
|
.Nm
|
||
|
|
are used to select which test programs or test cases to run. These are
|
||
|
|
filters and are explained in more detail in
|
||
|
|
.Xr kyua-test-filters 7 .
|
||
|
|
.Pp
|
||
|
|
This command must be run within a test suite or a test suite must be
|
||
|
|
provided with the
|
||
|
|
.Fl -kyuafile
|
||
|
|
flag.
|
||
|
|
.Pp
|
||
|
|
The following subcommand options are recognized:
|
||
|
|
.Bl -tag -width XX
|
||
|
|
.It Fl -build-root Ar path
|
||
|
|
Specifies the build root in which to find the test programs referenced
|
||
|
|
by the Kyuafile, if different from the Kyuafile's directory. See
|
||
|
|
.Xr kyua-build-root 7
|
||
|
|
for more information.
|
||
|
|
.It Fl -kyuafile Ar path , Fl k Ar path
|
||
|
|
Specifies the Kyuafile to process. Defaults to a
|
||
|
|
.Pa Kyuafile
|
||
|
|
file in the current directory.
|
||
|
|
.It Fl -verbose , Fl v
|
||
|
|
Prints metadata properties for every test case.
|
||
|
|
.El
|
||
|
|
.Sh EXIT STATUS
|
||
|
|
The
|
||
|
|
.Nm
|
||
|
|
command returns 0 on success or 1 if any of the given test case filters
|
||
|
|
does not match any test case.
|
||
|
|
.Pp
|
||
|
|
Additional exit codes may be returned as described in
|
||
|
|
.Xr kyua 1 .
|
||
|
|
.Sh SEE ALSO
|
||
|
|
.Xr kyua 1 ,
|
||
|
|
.Xr kyua-build-root 7 ,
|
||
|
|
.Xr kyua-test-filters 7
|