From mboxrd@z Thu Jan 1 00:00:00 1970 Return-Path: Received: from mga05.intel.com (mga05.intel.com [192.55.52.43]) (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 43F4D81E10 for ; Tue, 17 Jan 2017 23:16:43 -0800 (PST) Received: from orsmga002.jf.intel.com ([10.7.209.21]) by fmsmga105.fm.intel.com with ESMTP; 17 Jan 2017 23:16:43 -0800 X-ExtLoop1: 1 X-IronPort-AV: E=Sophos;i="5.33,248,1477983600"; d="scan'208";a="32017737" Received: from fmsmsx103.amr.corp.intel.com ([10.18.124.201]) by orsmga002.jf.intel.com with ESMTP; 17 Jan 2017 23:16:43 -0800 Received: from fmsmsx118.amr.corp.intel.com (10.18.116.18) by FMSMSX103.amr.corp.intel.com (10.18.124.201) with Microsoft SMTP Server (TLS) id 14.3.248.2; Tue, 17 Jan 2017 23:16:42 -0800 Received: from shsmsx104.ccr.corp.intel.com (10.239.4.70) by fmsmsx118.amr.corp.intel.com (10.18.116.18) with Microsoft SMTP Server (TLS) id 14.3.248.2; Tue, 17 Jan 2017 23:16:42 -0800 Received: from shsmsx102.ccr.corp.intel.com ([169.254.2.88]) by SHSMSX104.ccr.corp.intel.com ([10.239.4.70]) with mapi id 14.03.0248.002; Wed, 18 Jan 2017 15:16:40 +0800 From: "Gao, Liming" To: "Zeng, Star" , "edk2-devel@lists.01.org" CC: "Kinney, Michael D" Thread-Topic: [PATCH] MdePkg: Correct comments of macros FixedPcdGetX/PatchPcdXXX in PcdLib.h Thread-Index: AQHScHQC21SegbFWlESBKB5KnhCDxqE91LNg Date: Wed, 18 Jan 2017 07:16:39 +0000 Message-ID: <4A89E2EF3DFEDB4C8BFDE51014F606A14D6D0C94@shsmsx102.ccr.corp.intel.com> References: <1484624661-180620-1-git-send-email-star.zeng@intel.com> In-Reply-To: <1484624661-180620-1-git-send-email-star.zeng@intel.com> Accept-Language: en-US X-MS-Has-Attach: X-MS-TNEF-Correlator: x-originating-ip: [10.239.127.40] MIME-Version: 1.0 Subject: Re: [PATCH] MdePkg: Correct comments of macros FixedPcdGetX/PatchPcdXXX in PcdLib.h X-BeenThere: edk2-devel@lists.01.org X-Mailman-Version: 2.1.21 Precedence: list List-Id: EDK II Development List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , X-List-Received-Date: Wed, 18 Jan 2017 07:16:43 -0000 Content-Language: en-US Content-Type: text/plain; charset="us-ascii" Content-Transfer-Encoding: quoted-printable Reviewed-by: Liming Gao -----Original Message----- From: Zeng, Star=20 Sent: Tuesday, January 17, 2017 11:44 AM To: edk2-devel@lists.01.org Cc: Zeng, Star ; Gao, Liming ; K= inney, Michael D Subject: [PATCH] MdePkg: Correct comments of macros FixedPcdGetX/PatchPcdXX= X in PcdLib.h The patch is also to refine comments of macros PcdToken and PcdTokenEx. Cc: Liming Gao Cc: Michael Kinney Contributed-under: TianoCore Contribution Agreement 1.0 Signed-off-by: Star Zeng --- MdePkg/Include/Library/PcdLib.h | 44 ++++++++++++++++++++-----------------= ---- 1 file changed, 22 insertions(+), 22 deletions(-) diff --git a/MdePkg/Include/Library/PcdLib.h b/MdePkg/Include/Library/PcdLi= b.h index 4def32886294..9e7e09f52cdc 100644 --- a/MdePkg/Include/Library/PcdLib.h +++ b/MdePkg/Include/Library/PcdLib.h @@ -14,7 +14,7 @@ There are no restrictions on the use of FeaturePcd(), FixedPcdGetXX(), PatchPcdGetXX(), and PatchPcdSetXX(). =20 -Copyright (c) 2006 - 2016, Intel Corporation. All rights reserved.
+Copyright (c) 2006 - 2017, Intel Corporation. All rights reserved.
This program and the accompanying materials are licensed and made available under the terms and conditions of the BSD = License which accompanies this distribution. The full text of the license may be = found at @@ -32,9 +32,8 @@ WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER= EXPRESS OR IMPLIED. /** Retrieves a token number based on a token name. =20 - Returns the token number associated with the PCD token specified by Token= Name. + Returns the token number associated with the PCD token specified by Toke= nName. If TokenName is not a valid token in the token space, then the module wi= ll not build. - If TokenName is not a feature flag, then the module will not build. =20 @param TokenName The name of the PCD token to retrieve the token numb= er for. =20 @@ -49,7 +48,7 @@ WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER= EXPRESS OR IMPLIED. =20 Returns the Boolean value for the PCD feature flag specified by TokenNam= e. If TokenName is not a valid token in the token space, then the module wi= ll not build. - If TokenName is not a feature flag, then the module will not build. + If TokenName is not a feature flag PCD, then the module will not build. =20 @param TokenName The name of the PCD token to retrieve a current valu= e for. =20 @@ -64,7 +63,7 @@ WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER= EXPRESS OR IMPLIED. =20 Returns the 8-bit value for the token specified by TokenName. If TokenName is not a valid token in the token space, then the module wi= ll not build. - If TokenName is not a feature flag, then the module will not build. + If TokenName is not a fixed at build PCD, then the module will not build= . =20 @param TokenName The name of the PCD token to retrieve a current valu= e for. =20 @@ -79,7 +78,7 @@ WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER= EXPRESS OR IMPLIED. =20 Returns the 16-bit value for the token specified by TokenName. If TokenName is not a valid token in the token space, then the module wi= ll not build. - If TokenName is not a feature flag, then the module will not build. + If TokenName is not a fixed at build PCD, then the module will not build= . =20 @param TokenName The name of the PCD token to retrieve a current valu= e for. =20 @@ -94,7 +93,7 @@ WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER= EXPRESS OR IMPLIED. =20 Returns the 32-bit value for the token specified by TokenName. If TokenName is not a valid token in the token space, then the module wi= ll not build. - If TokenName is not a feature flag, then the module will not build. + If TokenName is not a fixed at build PCD, then the module will not build= . =20 @param TokenName The name of the PCD token to retrieve a current valu= e for. =20 @@ -109,7 +108,7 @@ WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITH= ER EXPRESS OR IMPLIED. =20 Returns the 64-bit value for the token specified by TokenName. If TokenName is not a valid token in the token space, then the module wi= ll not build. - If TokenName is not a feature flag, then the module will not build. + If TokenName is not a fixed at build PCD, then the module will not build= . =20 @param TokenName The name of the PCD token to retrieve a current valu= e for. =20 @@ -124,7 +123,7 @@ WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITH= ER EXPRESS OR IMPLIED. =20 Returns the Boolean value for the token specified by TokenName. If TokenName is not a valid token in the token space, then the module wi= ll not build. - If TokenName is not a feature flag, then the module will not build. + If TokenName is not a fixed at build PCD, then the module will not build= . =20 @param TokenName The name of the PCD token to retrieve a current valu= e for. =20 @@ -139,7 +138,7 @@ WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITH= ER EXPRESS OR IMPLIED. =20 Returns a pointer to the buffer for the token specified by TokenName. If TokenName is not a valid token in the token space, then the module wi= ll not build. - If TokenName is not a feature flag, then the module will not build. + If TokenName is not a fixed at build PCD, then the module will not build= . =20 @param TokenName The name of the PCD token to retrieve a current valu= e for. =20 @@ -154,7 +153,7 @@ WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITH= ER EXPRESS OR IMPLIED. =20 Returns the 8-bit value for the token specified by TokenName. If TokenName is not a valid token in the token space, then the module wi= ll not build. - If TokenName is not a feature flag, then the module will not build. + If TokenName is not a patchable in module PCD, then the module will not = build. =20 @param TokenName The name of the PCD token to retrieve a current valu= e for. =20 @@ -168,7 +167,7 @@ WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITH= ER EXPRESS OR IMPLIED. =20 Returns the 16-bit value for the token specified by TokenName. If TokenName is not a valid token in the token space, then the module wi= ll not build. - If TokenName is not a feature flag, then the module will not build. + If TokenName is not a patchable in module PCD, then the module will not = build. =20 @param TokenName The name of the PCD token to retrieve a current valu= e for. =20 @@ -183,7 +182,7 @@ WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITH= ER EXPRESS OR IMPLIED. =20 Returns the 32-bit value for the token specified by TokenName. If TokenName is not a valid token in the token space, then the module wi= ll not build. - If TokenName is not a feature flag, then the module will not build. + If TokenName is not a patchable in module PCD, then the module will not = build. =20 @param TokenName The name of the PCD token to retrieve a current valu= e for. =20 @@ -198,7 +197,7 @@ WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITH= ER EXPRESS OR IMPLIED. =20 Returns the 64-bit value for the token specified by TokenName. If TokenName is not a valid token in the token space, then the module wi= ll not build. - If TokenName is not a feature flag, then the module will not build. + If TokenName is not a patchable in module PCD, then the module will not = build. =20 @param TokenName The name of the PCD token to retrieve a current valu= e for. =20 @@ -213,7 +212,7 @@ WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITH= ER EXPRESS OR IMPLIED. =20 Returns the Boolean value for the token specified by TokenName. If TokenName is not a valid token in the token space, then the module wi= ll not build. - If TokenName is not a feature flag, then the module will not build. + If TokenName is not a patchable in module PCD, then the module will not = build. =20 @param TokenName The name of the PCD token to retrieve a current valu= e for. =20 @@ -228,7 +227,7 @@ WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITH= ER EXPRESS OR IMPLIED. =20 Returns a pointer to the buffer for the token specified by TokenName. If TokenName is not a valid token in the token space, then the module wi= ll not build. - If TokenName is not a feature flag, then the module will not build. + If TokenName is not a patchable in module PCD, then the module will not = build. =20 @param TokenName The name of the PCD token to retrieve a current valu= e for. =20 @@ -243,7 +242,7 @@ WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITH= ER EXPRESS OR IMPLIED. =20 Sets the 8-bit value for the token specified by TokenName. Value is retu= rned. If TokenName is not a valid token in the token space, then the module wi= ll not build. - If TokenName is not a feature flag, then the module will not build. + If TokenName is not a patchable in module PCD, then the module will not = build. =20 @param TokenName The name of the binary patchable PCD token to set th= e current value for. @param Value The 8-bit value to set. @@ -259,7 +258,7 @@ WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITH= ER EXPRESS OR IMPLIED. =20 Sets the 16-bit value for the token specified by TokenName. Value is ret= urned. If TokenName is not a valid token in the token space, then the module wi= ll not build. - If TokenName is not a feature flag, then the module will not build. + If TokenName is not a patchable in module PCD, then the module will not = build. =20 @param TokenName The name of the binary patchable PCD token to set th= e current value for. @param Value The 16-bit value to set. @@ -275,7 +274,7 @@ WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITH= ER EXPRESS OR IMPLIED. =20 Sets the 32-bit value for the token specified by TokenName. Value is ret= urned. If TokenName is not a valid token in the token space, then the module wi= ll not build. - If TokenName is not a feature flag, then the module will not build. + If TokenName is not a patchable in module PCD, then the module will not = build. =20 @param TokenName The name of the binary patchable PCD token to set th= e current value for. @param Value The 32-bit value to set. @@ -291,7 +290,7 @@ WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITH= ER EXPRESS OR IMPLIED. =20 Sets the 64-bit value for the token specified by TokenName. Value is ret= urned. If TokenName is not a valid token in the token space, then the module wi= ll not build. - If TokenName is not a feature flag, then the module will not build. + If TokenName is not a patchable in module PCD, then the module will not = build. =20 @param TokenName The name of the binary patchable PCD token to set th= e current value for. @param Value The 64-bit value to set. @@ -307,7 +306,7 @@ WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITH= ER EXPRESS OR IMPLIED. =20 Sets the Boolean value for the token specified by TokenName. Value is re= turned. If TokenName is not a valid token in the token space, then the module wi= ll not build. - If TokenName is not a feature flag, then the module will not build. + If TokenName is not a patchable in module PCD, then the module will not = build. =20 @param TokenName The name of the binary patchable PCD token to set th= e current value for. @param Value The boolean value to set. @@ -327,7 +326,7 @@ WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITH= ER EXPRESS OR IMPLIED. was not actually performed. If SizeOfBuffer is set to MAX_ADDRESS, then= SizeOfBuffer must be=20 set to the maximum size supported by TokenName and NULL must be returned= . If TokenName is not a valid token in the token space, then the module wi= ll not build. - If TokenName is not a feature flag, then the module will not build. + If TokenName is not a patchable in module PCD, then the module will not = build. =20 If SizeOfBuffer is NULL, then ASSERT(). If SizeOfBuffer > 0 and Buffer is NULL, then ASSERT(). @@ -688,6 +687,7 @@ WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITH= ER EXPRESS OR IMPLIED. Retrieves a token number based on a GUID and a token name. =20 Returns the token number for the token specified by Guid and TokenName. + If TokenName is not a valid token in the token space, then the module wi= ll not build. =20 @param Guid Pointer to a 128-bit unique value that designates=20 which namespace to retrieve a value from. --=20 2.7.0.windows.1