[PATCH] ShellPkg: Clarify the description of acpiview option '-s'

[PATCH] ShellPkg: Clarify the description of acpiview option '-s'

[Zhichao Gao]

BZ: https://bugzilla.tianocore.org/show_bug.cgi?id=1153

The '-s' option of 'acpiview' do not support multiply invcation options.
So clarify it for users.
Modify the help decription for UefiShellAcpiViewCommandLib which the
description is equal or over 80 column. If the line include equal or over
80 characters. The display engine would display a blank line for those
equal 80 characters or a extra line with few words for those over 80
character. So it is better to keep each line less than 80 characters.

Cc: Jaben Carsey <jaben.carsey@intel.com>
Cc: Ray Ni <ray.ni@intel.com>
Cc: Liming Gao <liming.gao@intel.com>
Contributed-under: TianoCore Contribution Agreement 1.1
Signed-off-by: Zhichao Gao <zhichao.gao@intel.com>
---
 .../UefiShellAcpiViewCommandLib.uni           | 24 ++++++++++---------
 1 file changed, 13 insertions(+), 11 deletions(-)

diff --git a/ShellPkg/Library/UefiShellAcpiViewCommandLib/UefiShellAcpiViewCommandLib.uni b/ShellPkg/Library/UefiShellAcpiViewCommandLib/UefiShellAcpiViewCommandLib.uni
index de2fb41067..775d7b1985 100644
--- a/ShellPkg/Library/UefiShellAcpiViewCommandLib/UefiShellAcpiViewCommandLib.uni
+++ b/ShellPkg/Library/UefiShellAcpiViewCommandLib/UefiShellAcpiViewCommandLib.uni
@@ -41,7 +41,8 @@
 ".SH OPTIONS\r\n"
 " \r\n"
 "  -l - Display list of installed ACPI Tables.\r\n"
-"  -s - Display only the specified AcpiTable type.\r\n"
+"  -s - Display only the specified AcpiTable type and only support single\r\n"
+"       invocation option.\r\n"
 "         AcpiTable    : The required ACPI Table type.\r\n"
 "  -d - Generate a binary file dump of the specified AcpiTable.\r\n"
 "  -c - Consistency checking (enabled by default).\r\n"
@@ -54,21 +55,21 @@
 ".SH DESCRIPTION\r\n"
 " \r\n"
 "  This program is provided to allow examination of ACPI table values from the\r\n"
-"  UEFI Shell.  This can help with investigations, especially at that stage where\r\n"
-"  the tables are not enabling an OS to boot.\r\n"
+"  UEFI Shell.  This can help with investigations, especially at that stage\r\n"
+"  where the tables are not enabling an OS to boot.\r\n"
 "  The program is not exhaustive, and only encapsulates detailed knowledge of a\r\n"
 "  limited number of table types.\r\n"
 " \r\n"
 "  Default behaviour is to display the content of all tables installed.\r\n"
 "  'Known' table types (listed in NOTES below) will be parsed and displayed\r\n"
-"  with descriptions and field values.  Where appropriate a degree of consistency\r\n"
-"  checking is done and errors may be reported in the output.\r\n"
+"  with descriptions and field values.  Where appropriate a degree of\r\n"
+"  consistency checking is done and errors may be reported in the output.\r\n"
 "  Other table types will be displayed as an array of Hexadecimal bytes.\r\n"
 " \r\n"
 "  To facilitate debugging, the -s and -d options can be used to generate a\r\n"
 "  binary file image of a table that can be copied elsewhere for investigation\r\n"
-"  using tools such as those provided by acpica.org.  This is especially relevant\r\n"
-"  for AML type tables like DSDT and SSDT.\r\n"
+"  using tools such as those provided by acpica.org.  This is especially\r\n"
+"  relevant for AML type tables like DSDT and SSDT.\r\n"
 " \r\n"
 "NOTES:\r\n"
 "  1. The AcpiTable parameter can match any installed table type.\r\n"
@@ -77,7 +78,8 @@
 "  2. -s option supports to display the specified AcpiTable type that is present\r\n"
 "     in the system. For normal type AcpiTable, it would display the data of the\r\n"
 "     AcpiTable and AcpiTable header. The following type may contain header type\r\n"
-"     other than AcpiTable header. The actual header can refer to the ACPI spec 6.2\r\n"
+"     other than AcpiTable header. The actual header can refer to the ACPI spec\r\n"
+"     6.2\r\n"
 "     Extra A. Particular types:\r\n"
 "       APIC  - Multiple APIC Description Table (MADT)\r\n"
 "       BGRT  - Boot Graphics Resource Table\r\n"
@@ -101,9 +103,9 @@
 "  Interface Specification' Version 6.2 Errata A, [September 2017]\r\n"
 "  (http://www.uefi.org/sites/default/files/resources/ACPI%206_2_A_Sept29.pdf)\r\n"
 " \r\n"
-"  NOTE: The nature of the ACPI standard means that almost all tables in 6.1 will\r\n"
-"        be 'backwards compatible' with prior version of the specification in\r\n"
-"        terms of structure, so formatted output should be correct.  The main\r\n"
+"  NOTE: The nature of the ACPI standard means that almost all tables in 6.1\r\n"
+"        will be 'backwards compatible' with prior version of the specification\r\n"
+"        in terms of structure, so formatted output should be correct.  The main\r\n"
 "        exception will be that previously 'reserved' fields will be reported\r\n"
 "        with new names, where they have been added in later versions of the\r\n"
 "        specification.\r\n"
-- 
2.21.0.windows.1

Re: [PATCH] ShellPkg: Clarify the description of acpiview option '-s'

[Carsey, Jaben]

Reviewed-by: Jaben Carsey <jaben.carsey@intel.com>

> -----Original Message-----
> From: Gao, Zhichao
> Sent: Tuesday, April 02, 2019 2:44 AM
> To: edk2-devel@lists.01.org
> Cc: Carsey, Jaben <jaben.carsey@intel.com>; Ni, Ray <ray.ni@intel.com>;
> Gao, Liming <liming.gao@intel.com>
> Subject: [PATCH] ShellPkg: Clarify the description of acpiview option '-s'
> Importance: High
> 
> BZ: https://bugzilla.tianocore.org/show_bug.cgi?id=1153
> 
> The '-s' option of 'acpiview' do not support multiply invcation options.
> So clarify it for users.
> Modify the help decription for UefiShellAcpiViewCommandLib which the
> description is equal or over 80 column. If the line include equal or over
> 80 characters. The display engine would display a blank line for those
> equal 80 characters or a extra line with few words for those over 80
> character. So it is better to keep each line less than 80 characters.
> 
> Cc: Jaben Carsey <jaben.carsey@intel.com>
> Cc: Ray Ni <ray.ni@intel.com>
> Cc: Liming Gao <liming.gao@intel.com>
> Contributed-under: TianoCore Contribution Agreement 1.1
> Signed-off-by: Zhichao Gao <zhichao.gao@intel.com>
> ---
>  .../UefiShellAcpiViewCommandLib.uni           | 24 ++++++++++---------
>  1 file changed, 13 insertions(+), 11 deletions(-)
> 
> diff --git
> a/ShellPkg/Library/UefiShellAcpiViewCommandLib/UefiShellAcpiViewComm
> andLib.uni
> b/ShellPkg/Library/UefiShellAcpiViewCommandLib/UefiShellAcpiViewComm
> andLib.uni
> index de2fb41067..775d7b1985 100644
> ---
> a/ShellPkg/Library/UefiShellAcpiViewCommandLib/UefiShellAcpiViewComm
> andLib.uni
> +++
> b/ShellPkg/Library/UefiShellAcpiViewCommandLib/UefiShellAcpiViewComm
> andLib.uni
> @@ -41,7 +41,8 @@
>  ".SH OPTIONS\r\n"
>  " \r\n"
>  "  -l - Display list of installed ACPI Tables.\r\n"
> -"  -s - Display only the specified AcpiTable type.\r\n"
> +"  -s - Display only the specified AcpiTable type and only support single\r\n"
> +"       invocation option.\r\n"
>  "         AcpiTable    : The required ACPI Table type.\r\n"
>  "  -d - Generate a binary file dump of the specified AcpiTable.\r\n"
>  "  -c - Consistency checking (enabled by default).\r\n"
> @@ -54,21 +55,21 @@
>  ".SH DESCRIPTION\r\n"
>  " \r\n"
>  "  This program is provided to allow examination of ACPI table values from
> the\r\n"
> -"  UEFI Shell.  This can help with investigations, especially at that stage
> where\r\n"
> -"  the tables are not enabling an OS to boot.\r\n"
> +"  UEFI Shell.  This can help with investigations, especially at that stage\r\n"
> +"  where the tables are not enabling an OS to boot.\r\n"
>  "  The program is not exhaustive, and only encapsulates detailed knowledge
> of a\r\n"
>  "  limited number of table types.\r\n"
>  " \r\n"
>  "  Default behaviour is to display the content of all tables installed.\r\n"
>  "  'Known' table types (listed in NOTES below) will be parsed and
> displayed\r\n"
> -"  with descriptions and field values.  Where appropriate a degree of
> consistency\r\n"
> -"  checking is done and errors may be reported in the output.\r\n"
> +"  with descriptions and field values.  Where appropriate a degree of\r\n"
> +"  consistency checking is done and errors may be reported in the
> output.\r\n"
>  "  Other table types will be displayed as an array of Hexadecimal bytes.\r\n"
>  " \r\n"
>  "  To facilitate debugging, the -s and -d options can be used to generate
> a\r\n"
>  "  binary file image of a table that can be copied elsewhere for
> investigation\r\n"
> -"  using tools such as those provided by acpica.org.  This is especially
> relevant\r\n"
> -"  for AML type tables like DSDT and SSDT.\r\n"
> +"  using tools such as those provided by acpica.org.  This is especially\r\n"
> +"  relevant for AML type tables like DSDT and SSDT.\r\n"
>  " \r\n"
>  "NOTES:\r\n"
>  "  1. The AcpiTable parameter can match any installed table type.\r\n"
> @@ -77,7 +78,8 @@
>  "  2. -s option supports to display the specified AcpiTable type that is
> present\r\n"
>  "     in the system. For normal type AcpiTable, it would display the data of
> the\r\n"
>  "     AcpiTable and AcpiTable header. The following type may contain header
> type\r\n"
> -"     other than AcpiTable header. The actual header can refer to the ACPI
> spec 6.2\r\n"
> +"     other than AcpiTable header. The actual header can refer to the ACPI
> spec\r\n"
> +"     6.2\r\n"
>  "     Extra A. Particular types:\r\n"
>  "       APIC  - Multiple APIC Description Table (MADT)\r\n"
>  "       BGRT  - Boot Graphics Resource Table\r\n"
> @@ -101,9 +103,9 @@
>  "  Interface Specification' Version 6.2 Errata A, [September 2017]\r\n"
>  "
> (http://www.uefi.org/sites/default/files/resources/ACPI%206_2_A_Sept29.
> pdf)\r\n"
>  " \r\n"
> -"  NOTE: The nature of the ACPI standard means that almost all tables in 6.1
> will\r\n"
> -"        be 'backwards compatible' with prior version of the specification in\r\n"
> -"        terms of structure, so formatted output should be correct.  The
> main\r\n"
> +"  NOTE: The nature of the ACPI standard means that almost all tables in
> 6.1\r\n"
> +"        will be 'backwards compatible' with prior version of the
> specification\r\n"
> +"        in terms of structure, so formatted output should be correct.  The
> main\r\n"
>  "        exception will be that previously 'reserved' fields will be reported\r\n"
>  "        with new names, where they have been added in later versions of
> the\r\n"
>  "        specification.\r\n"
> --
> 2.21.0.windows.1