Attachment 627544 Details for Bug 866534 – man page page for all but --udi issue

[patch] man page page for all but --udi issue

v7.8.in.patch (text/plain), 3.94 KB, created by Greg Nichols on 2012-10-15 15:48:27 UTC

(hide)

Description:

Filename:

MIME Type:

Creator: Greg Nichols

Created: 2012-10-15 15:48:27 UTC

Size: 3.94 KB

patch

obsolete

>diff --git a/docs/man/v7.8.in b/docs/man/v7.8.in
>index 7a96b9d..49a2e9f 100644
>--- a/docs/man/v7.8.in
>+++ b/docs/man/v7.8.in
>@@ -19,8 +19,7 @@ v7 is comprised of a suite of tests intended to verify compatibility of the
> hardware devices and functions.
> 
> Each v7 test run builds a test results database that is submitted
>-to Red Hat in the form of an RPM package uploaded to Red Hat's 
>-hardware catalog.
>+to Red Hat by uploading to a certification request in Red Hat's Hardware Catalog.
> 
> .SS General Options
> 
>@@ -38,7 +37,8 @@ Prints a list of available commands and options.
> In 
> .I auto
> mode, v7 runs non-interactively to the extent possible.   Some user confirmations and prompts will be skipped and reasonable options assumed.  The default mode is 
>-.I normal.
>+.I normal,
>+which will prompt the user for test options and confirm significant actions taken.
> 
> .SH v7 COMMANDS
> 
>@@ -70,6 +70,15 @@ The
> .I clean 
> command deletes the test results database.
> 
>+
>+.IP Options
>+
>+.B all
>+
>+.B v7 clean all
>+also prompts for removal of certification data from the test results database,
>+such as vendor, make and model, and any linked certification request in the Hardware Catalog.
>+
> .SS continue
> .B v7 continue
> .P
>@@ -79,12 +88,18 @@ command will continue a test run that has been interrupted.
> 
> .SS plan
> .P
>-.B v7 plan [ ( --disable | --enable | --add) (--test <testname> | --udi <udi> | --device <device>) [--server <v7 server host>] [--model] [--kudzu]
>+.B v7 plan [ ( --disable | --enable | --add) (--test <testname> | --udi <udi> | --device <device>) [--server <v7 server host>] [--model] 
> 
> .P
> The plan command analyzes the hardware devices and system configuration
> to determine which tests from the suite are applicable to certification.
> 
>+v7 will prompt for certification information, such as the hardware vendor, make and model, as well
>+as a product URL and category.   If the Hardware Catalog is reachable, v7 will prompt for or create 
>+a new certification request on the Hardware Catalog and link it to the test results.
>+
>+Depending on tests planned, v7 may also prompt for the installation of additional RPM packages required for testing.
>+
> .IP Options
> 
> .B --disable
>@@ -120,13 +135,11 @@ A logical device name indicating the device to be tested. Logical device names a
> 
> Specifies the v7 Server host name to be used for the specific test identified using the --test, --udi and --device parameters. This setting overrides the v7 server setting for the test plan.
> 
>-.B --kudzu
>-
>-Enables Kudzu-based hardware detection during test planning.   Normally, v7 uses HAL for device detection.
>-
> .B --model
> 
>-Prompts the user to edit vendor, make and model information in the test plan.
>+Prompts the user to edit vendor, make and model information in the test plan.  It also allows the 
>+link to the Hardware Catalog 
>+certification request to be changed, or a new request created.
> 
> .SS print
> .P
>@@ -229,11 +242,13 @@ host name of the server running the v7 test server, required for some tests, suc
> 
> .SS save
> .P 
>-.B v7 save
>+.B v7 save [--server <v7 server host>]
> .P
> The
> .I save
>-command copies the test results to /var/v7/store for later reference.
>+command copies the test results to /var/v7/store for later reference.  If 
>+.I --server
>+is set, it will also prompt to upload a copy of the test results to the v7-server.
> 
> 
> .SS server
>@@ -256,8 +271,11 @@ process is used for tests such as the fencing test where server-side tests must
> .B v7 submit
> .P
> .I Submit
>-packages the test results into an RPM package for submission to the 
>-Red Hat Hardware Catalog.
>+uploads the test results to the Hardware Catalog.  If
>+.I --mode 
>+is set to 
>+.I auto
>+v7 will package the test results into an RPM.
> 
> .SS verify
> .P
>@@ -285,7 +303,10 @@ Prints the version and release of v7.
> - v7 harness and test source files
> 
> .B /var/v7 
>-- v7 data files, and web/NFS root for server
>+- v7 data files and test results for v7-client on the SUT
>+
>+.B /var/www/v7
>+- The and web/NFS root for v7-server
> 
> 
>

Actions: View | Diff

Attachments on bug 866534: 627544