From patchwork Sat Mar 29 17:47:06 2014 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: Colin Ian King X-Patchwork-Id: 334975 Return-Path: X-Original-To: incoming@patchwork.ozlabs.org Delivered-To: patchwork-incoming@bilbo.ozlabs.org Received: from huckleberry.canonical.com (huckleberry.canonical.com [91.189.94.19]) by ozlabs.org (Postfix) with ESMTP id B32321400B8 for ; Sun, 30 Mar 2014 04:47:13 +1100 (EST) Received: from localhost ([127.0.0.1] helo=huckleberry.canonical.com) by huckleberry.canonical.com with esmtp (Exim 4.76) (envelope-from ) id 1WTxLc-0001z8-L4; Sat, 29 Mar 2014 17:47:12 +0000 Received: from youngberry.canonical.com ([91.189.89.112]) by huckleberry.canonical.com with esmtp (Exim 4.76) (envelope-from ) id 1WTxLX-0001ye-9z for fwts-devel@lists.ubuntu.com; Sat, 29 Mar 2014 17:47:07 +0000 Received: from cpc3-craw6-2-0-cust180.croy.cable.virginm.net ([77.100.248.181] helo=localhost) by youngberry.canonical.com with esmtpsa (TLS1.0:DHE_RSA_AES_128_CBC_SHA1:16) (Exim 4.71) (envelope-from ) id 1WTxLX-0004xU-7M for fwts-devel@lists.ubuntu.com; Sat, 29 Mar 2014 17:47:07 +0000 From: Colin King To: fwts-devel@lists.ubuntu.com Subject: [PATCH] doc: fwts: use lower case for description Date: Sat, 29 Mar 2014 17:47:06 +0000 Message-Id: <1396115226-10523-1-git-send-email-colin.king@canonical.com> X-Mailer: git-send-email 1.9.1 X-BeenThere: fwts-devel@lists.ubuntu.com X-Mailman-Version: 2.1.14 Precedence: list List-Id: Firmware Test Suite Development List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , MIME-Version: 1.0 Errors-To: fwts-devel-bounces@lists.ubuntu.com Sender: fwts-devel-bounces@lists.ubuntu.com From: Colin Ian King In keeping with the current man page convention for fwts the first letter of the option description should be in lower case. Signed-off-by: Colin Ian King Acked-by: Alex Hung Acked-by: Ivan Hu --- doc/fwts.1 | 16 ++++++++-------- 1 file changed, 8 insertions(+), 8 deletions(-) diff --git a/doc/fwts.1 b/doc/fwts.1 index b048a76..4916f1b 100644 --- a/doc/fwts.1 +++ b/doc/fwts.1 @@ -82,7 +82,7 @@ run the non-interactive batch tests. Batch tests require no user interaction. run only batch experimental tests. .TP .B \-\-disassemble\-aml -Disassemble AML (ACPI machine language) byte code. This attempts to disassemble AML in DSDT and SSDT +disassemble AML (ACPI machine language) byte code. This attempts to disassemble AML in DSDT and SSDT tables and generates DSDT.dsl and SSDTx.dsl sources. .TP .B \-d, \-\-dump @@ -99,27 +99,27 @@ lspci.log \- containing the output from lspci \-vv \-nn README.txt \- containing a timestamp and kernel version information. .TP .B \-\-dumpfile=acpidump.log -Load ACPI tables from output generated from acpidump or from sudo fwts \-\-dump. The +load ACPI tables from output generated from acpidump or from sudo fwts \-\-dump. The latter is preferred as fwts \-\-dump is able to dump more tables than acpidump. This allows one to dump tables from one machine and processes them with fwts on another machine. .TP .B \-\-uefi\-get\-var\-multiple -Specifies the number of times to get a variable in the uefirtvariable get variable stress test. +specifies the number of times to get a variable in the uefirtvariable get variable stress test. .TP .B \-\-uefi\-set\-var\-multiple -Specifies the number of times to set a variable in the uefirtvariable set variable stress test. +specifies the number of times to set a variable in the uefirtvariable set variable stress test. .TP .B \-\-uefi\-query\-var\-multiple -Specifies the number of times to query a variable in the uefirtvariable query variable stress test. +specifies the number of times to query a variable in the uefirtvariable query variable stress test. .TP .B \-\-filter\-error\-discard -Specifies the errors that one wants to silently ignore. One supplies a comma sperated +specifies the errors that one wants to silently ignore. One supplies a comma sperated list of fwts error message labels that one wants fwts to not report as errors. fwts will run the test but if there is a test failure and the label matches the one supplied in this list fwts will then just ignore this error. This cannot be used with \-\-filter\-error\-keep. .TP .B \-\-filter\-error\-keep -Specifies the errors that one wants to keep, all other errors are silently ignored. +specifies the errors that one wants to keep, all other errors are silently ignored. One supplies a comma sperated list of fwts error message labels that one wants fwts report as errors, other test failures will be not reported and silently ignored. This cannot be used with \-\-filter\-error\-discard. @@ -209,7 +209,7 @@ before a device configuration check is run. The default is 15 seconds. If this device checking is assumed so one does not also need to use the \-\-s3\-device\-check flag. .TP .B \-\-s3\-hybrid -Enables fwts to run Hybrid Sleep. +enables fwts to run Hybrid Sleep. .TP .B \-\-s3\-min\-delay=N minimum time between S3 iterations.