Blame doc/results-file-flag-read.mdoc

Packit 209faa
.\" Copyright 2014 The Kyua Authors.
Packit 209faa
.\" All rights reserved.
Packit 209faa
.\"
Packit 209faa
.\" Redistribution and use in source and binary forms, with or without
Packit 209faa
.\" modification, are permitted provided that the following conditions are
Packit 209faa
.\" met:
Packit 209faa
.\"
Packit 209faa
.\" * Redistributions of source code must retain the above copyright
Packit 209faa
.\"   notice, this list of conditions and the following disclaimer.
Packit 209faa
.\" * Redistributions in binary form must reproduce the above copyright
Packit 209faa
.\"   notice, this list of conditions and the following disclaimer in the
Packit 209faa
.\"   documentation and/or other materials provided with the distribution.
Packit 209faa
.\" * Neither the name of Google Inc. nor the names of its contributors
Packit 209faa
.\"   may be used to endorse or promote products derived from this software
Packit 209faa
.\"   without specific prior written permission.
Packit 209faa
.\"
Packit 209faa
.\" THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
Packit 209faa
.\" "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
Packit 209faa
.\" LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
Packit 209faa
.\" A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
Packit 209faa
.\" OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
Packit 209faa
.\" SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
Packit 209faa
.\" LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
Packit 209faa
.\" DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
Packit 209faa
.\" THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
Packit 209faa
.\" (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
Packit 209faa
.\" OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
Packit 209faa
Specifies the results file to operate on.
Packit 209faa
Defaults to
Packit 209faa
.Sq LATEST ,
Packit 209faa
which causes
Packit 209faa
.Nm
Packit 209faa
to automatically load the latest results file from the current test suite.
Packit 209faa
.Pp
Packit 209faa
The following values are accepted:
Packit 209faa
.Bl -tag -width XX
Packit 209faa
.It Sq LATEST
Packit 209faa
Requests the load of the latest results file available for the test suite rooted
Packit 209faa
at the current directory.
Packit 209faa
.It Directory
Packit 209faa
Requests the load of the latest results file available for the test suite rooted
Packit 209faa
at the given directory.
Packit 209faa
.It Test suite name
Packit 209faa
Requests the load of the latest results file available for the given test suite.
Packit 209faa
.It Results identifier
Packit 209faa
Requests the load of a specific results file.
Packit 209faa
.It Explicit file name (aka everything else)
Packit 209faa
Load the specified results file.
Packit 209faa
.El
Packit 209faa
.Pp
Packit 209faa
See
Packit 209faa
.Sx Results files
Packit 209faa
for more details.