From mboxrd@z Thu Jan 1 00:00:00 1970 Return-Path: Received-SPF: Pass (sender SPF authorized) identity=mailfrom; client-ip=192.55.52.93; helo=mga11.intel.com; envelope-from=jaben.carsey@intel.com; receiver=edk2-devel@lists.01.org Received: from mga11.intel.com (mga11.intel.com [192.55.52.93]) (using TLSv1.2 with cipher ECDHE-RSA-AES256-GCM-SHA384 (256/256 bits)) (No client certificate requested) by ml01.01.org (Postfix) with ESMTPS id B15442194D3B3 for ; Tue, 2 Apr 2019 07:42:11 -0700 (PDT) X-Amp-Result: SKIPPED(no attachment in message) X-Amp-File-Uploaded: False Received: from fmsmga005.fm.intel.com ([10.253.24.32]) by fmsmga102.fm.intel.com with ESMTP/TLS/DHE-RSA-AES256-GCM-SHA384; 02 Apr 2019 07:42:10 -0700 X-ExtLoop1: 1 X-IronPort-AV: E=Sophos;i="5.60,301,1549958400"; d="scan'208";a="334290269" Received: from fmsmsx108.amr.corp.intel.com ([10.18.124.206]) by fmsmga005.fm.intel.com with ESMTP; 02 Apr 2019 07:42:10 -0700 Received: from fmsmsx162.amr.corp.intel.com (10.18.125.71) by FMSMSX108.amr.corp.intel.com (10.18.124.206) with Microsoft SMTP Server (TLS) id 14.3.408.0; Tue, 2 Apr 2019 07:42:10 -0700 Received: from fmsmsx103.amr.corp.intel.com ([169.254.2.108]) by fmsmsx162.amr.corp.intel.com ([169.254.5.72]) with mapi id 14.03.0415.000; Tue, 2 Apr 2019 07:42:10 -0700 From: "Carsey, Jaben" To: "Gao, Zhichao" , "edk2-devel@lists.01.org" CC: "Ni, Ray" , "Gao, Liming" Thread-Topic: [PATCH] ShellPkg: Clarify the description of acpiview option '-s' Thread-Index: AQHU6TicZ4fKMAj2pkqUGRiaZgsmJqYo8gtQ Date: Tue, 2 Apr 2019 14:42:10 +0000 Message-ID: References: <20190402094347.17140-1-zhichao.gao@intel.com> In-Reply-To: <20190402094347.17140-1-zhichao.gao@intel.com> Accept-Language: en-US X-MS-Has-Attach: X-MS-TNEF-Correlator: x-titus-metadata-40: eyJDYXRlZ29yeUxhYmVscyI6IiIsIk1ldGFkYXRhIjp7Im5zIjoiaHR0cDpcL1wvd3d3LnRpdHVzLmNvbVwvbnNcL0ludGVsMyIsImlkIjoiYzA5NTJkMGMtOTAyMS00NmI5LWEwMDctMTljNzA5MDRlYzBlIiwicHJvcHMiOlt7Im4iOiJDVFBDbGFzc2lmaWNhdGlvbiIsInZhbHMiOlt7InZhbHVlIjoiQ1RQX05UIn1dfV19LCJTdWJqZWN0TGFiZWxzIjpbXSwiVE1DVmVyc2lvbiI6IjE3LjEwLjE4MDQuNDkiLCJUcnVzdGVkTGFiZWxIYXNoIjoiY2JcL2liMmlWNjhzSU4xYU9xNlFNZjErZitaR1QyS3E5S2g0aFhKc3UyRG45NjNBUUhOZ1wveU02clVDRSt3UnZJIn0= x-ctpclassification: CTP_NT dlp-product: dlpe-windows dlp-version: 11.0.400.15 dlp-reaction: no-action x-originating-ip: [10.1.200.106] MIME-Version: 1.0 Subject: Re: [PATCH] ShellPkg: Clarify the description of acpiview option '-s' X-BeenThere: edk2-devel@lists.01.org X-Mailman-Version: 2.1.29 Precedence: list List-Id: EDK II Development List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , X-List-Received-Date: Tue, 02 Apr 2019 14:42:11 -0000 Content-Language: en-US Content-Type: text/plain; charset="us-ascii" Content-Transfer-Encoding: quoted-printable Reviewed-by: Jaben Carsey > -----Original Message----- > From: Gao, Zhichao > Sent: Tuesday, April 02, 2019 2:44 AM > To: edk2-devel@lists.01.org > Cc: Carsey, Jaben ; Ni, Ray ; > Gao, Liming > Subject: [PATCH] ShellPkg: Clarify the description of acpiview option '-s= ' > Importance: High >=20 > BZ: https://bugzilla.tianocore.org/show_bug.cgi?id=3D1153 >=20 > 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. >=20 > Cc: Jaben Carsey > Cc: Ray Ni > Cc: Liming Gao > Contributed-under: TianoCore Contribution Agreement 1.1 > Signed-off-by: Zhichao Gao > --- > .../UefiShellAcpiViewCommandLib.uni | 24 ++++++++++--------- > 1 file changed, 13 insertions(+), 11 deletions(-) >=20 > 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 singl= e\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 fr= om > the\r\n" > -" UEFI Shell. This can help with investigations, especially at that st= age > where\r\n" > -" the tables are not enabling an OS to boot.\r\n" > +" UEFI Shell. This can help with investigations, especially at that st= age\r\n" > +" where the tables are not enabling an OS to boot.\r\n" > " The program is not exhaustive, and only encapsulates detailed knowled= ge > 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 generat= e > 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 dat= a of > the\r\n" > " AcpiTable and AcpiTable header. The following type may contain hea= der > type\r\n" > -" other than AcpiTable header. The actual header can refer to the AC= PI > spec 6.2\r\n" > +" other than AcpiTable header. The actual header can refer to the AC= PI > 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 specificati= on 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 rep= orted\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