Patchwork doc: fwts: use lower case for description

login
register
mail settings
Submitter Colin King
Date March 29, 2014, 5:47 p.m.
Message ID <1396115226-10523-1-git-send-email-colin.king@canonical.com>
Download mbox | patch
Permalink /patch/334975/
State Accepted
Headers show

Comments

Colin King - March 29, 2014, 5:47 p.m.
From: Colin Ian King <colin.king@canonical.com>

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 <colin.king@canonical.com>
---
 doc/fwts.1 | 16 ++++++++--------
 1 file changed, 8 insertions(+), 8 deletions(-)
Alex Hung - March 31, 2014, 6:07 a.m.
On 03/30/2014 01:47 AM, Colin King wrote:
> From: Colin Ian King <colin.king@canonical.com>
>
> 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 <colin.king@canonical.com>
> ---
>   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.
>

Acked-by: Alex Hung <alex.hung@canonical.com>
Ivan Hu - April 17, 2014, 3:51 a.m.
On 03/30/2014 01:47 AM, Colin King wrote:
> From: Colin Ian King <colin.king@canonical.com>
>
> 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 <colin.king@canonical.com>
> ---
>   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.
>

Acked-by: Ivan Hu <ivan.hu@canonical.com>

Patch

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.