[PATCH] MdePkg: Correct comments of macros FixedPcdGetX/PatchPcdXXX in PcdLib.h

public inbox for devel@edk2.groups.io
 help / color / mirror / Atom feed

From: Star Zeng <star.zeng@intel.com>
To: edk2-devel@lists.01.org
Cc: Star Zeng <star.zeng@intel.com>,
	Liming Gao <liming.gao@intel.com>,
	Michael Kinney <michael.d.kinney@intel.com>
Subject: [PATCH] MdePkg: Correct comments of macros FixedPcdGetX/PatchPcdXXX in PcdLib.h
Date: Tue, 17 Jan 2017 11:44:21 +0800	[thread overview]
Message-ID: <1484624661-180620-1-git-send-email-star.zeng@intel.com> (raw)

The patch is also to refine comments of macros PcdToken and PcdTokenEx.

Cc: Liming Gao <liming.gao@intel.com>
Cc: Michael Kinney <michael.d.kinney@intel.com>
Contributed-under: TianoCore Contribution Agreement 1.0
Signed-off-by: Star Zeng <star.zeng@intel.com>
---
 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/PcdLib.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().
 
-Copyright (c) 2006 - 2016, Intel Corporation. All rights reserved.<BR>
+Copyright (c) 2006 - 2017, Intel Corporation. All rights reserved.<BR>
 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.
 
- Returns the token number associated with the PCD token specified by TokenName.
+  Returns the token number associated with the PCD token specified by TokenName.
   If TokenName is not a valid token in the token space, then the module will not build.
-  If TokenName is not a feature flag, then the module will not build.
 
   @param   TokenName  The name of the PCD token to retrieve the token number for.
 
@@ -49,7 +48,7 @@ WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
 
   Returns the Boolean value for the PCD feature flag specified by TokenName.
   If TokenName is not a valid token in the token space, then the module will 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.
 
   @param   TokenName  The name of the PCD token to retrieve a current value for.
 
@@ -64,7 +63,7 @@ WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
 
   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 will 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.
 
   @param   TokenName  The name of the PCD token to retrieve a current value for.
 
@@ -79,7 +78,7 @@ WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
 
   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 will 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.
 
   @param   TokenName  The name of the PCD token to retrieve a current value for.
 
@@ -94,7 +93,7 @@ WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
 
   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 will 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.
 
   @param   TokenName  The name of the PCD token to retrieve a current value for.
 
@@ -109,7 +108,7 @@ WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
 
   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 will 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.
 
   @param   TokenName  The name of the PCD token to retrieve a current value for.
 
@@ -124,7 +123,7 @@ WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
 
   Returns the Boolean value for the token specified by TokenName.
   If TokenName is not a valid token in the token space, then the module will 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.
 
   @param   TokenName  The name of the PCD token to retrieve a current value for.
 
@@ -139,7 +138,7 @@ WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
 
   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 will 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.
 
   @param   TokenName  The name of the PCD token to retrieve a current value for.
 
@@ -154,7 +153,7 @@ WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
 
   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 will 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.
 
   @param   TokenName  The name of the PCD token to retrieve a current value for.
 
@@ -168,7 +167,7 @@ WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
 
   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 will 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.
 
   @param   TokenName  The name of the PCD token to retrieve a current value for.
 
@@ -183,7 +182,7 @@ WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
 
   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 will 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.
 
   @param   TokenName  The name of the PCD token to retrieve a current value for.
 
@@ -198,7 +197,7 @@ WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
 
   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 will 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.
 
   @param   TokenName  The name of the PCD token to retrieve a current value for.
 
@@ -213,7 +212,7 @@ WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
 
   Returns the Boolean value for the token specified by TokenName.
   If TokenName is not a valid token in the token space, then the module will 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.
 
   @param   TokenName  The name of the PCD token to retrieve a current value for.
 
@@ -228,7 +227,7 @@ WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
 
   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 will 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.
 
   @param   TokenName  The name of the PCD token to retrieve a current value for.
 
@@ -243,7 +242,7 @@ WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
 
   Sets the 8-bit value for the token specified by TokenName. Value is returned.
   If TokenName is not a valid token in the token space, then the module will 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.
 
   @param   TokenName  The name of the binary patchable PCD token to set the current value for.
   @param   Value      The 8-bit value to set.
@@ -259,7 +258,7 @@ WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
 
   Sets the 16-bit value for the token specified by TokenName. Value is returned.
   If TokenName is not a valid token in the token space, then the module will 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.
 
   @param   TokenName  The name of the binary patchable PCD token to set the current value for.
   @param   Value      The 16-bit value to set.
@@ -275,7 +274,7 @@ WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
 
   Sets the 32-bit value for the token specified by TokenName. Value is returned.
   If TokenName is not a valid token in the token space, then the module will 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.
 
   @param   TokenName  The name of the binary patchable PCD token to set the current value for.
   @param   Value      The 32-bit value to set.
@@ -291,7 +290,7 @@ WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
 
   Sets the 64-bit value for the token specified by TokenName. Value is returned.
   If TokenName is not a valid token in the token space, then the module will 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.
 
   @param   TokenName  The name of the binary patchable PCD token to set the current value for.
   @param   Value      The 64-bit value to set.
@@ -307,7 +306,7 @@ WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
 
   Sets the Boolean value for the token specified by TokenName. Value is returned.
   If TokenName is not a valid token in the token space, then the module will 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.
 
   @param   TokenName  The name of the binary patchable PCD token to set the current value for.
   @param   Value      The boolean value to set.
@@ -327,7 +326,7 @@ WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
   was not actually performed.  If SizeOfBuffer is set to MAX_ADDRESS, then SizeOfBuffer must be 
   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 will 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.
   
   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, EITHER EXPRESS OR IMPLIED.
   Retrieves a token number based on a GUID and a token name.
 
   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 will not build.
 
   @param   Guid        Pointer to a 128-bit unique value that designates 
                        which namespace to retrieve a value from.
-- 
2.7.0.windows.1

next             reply	other threads:[~2017-01-17  3:44 UTC|newest]

Thread overview: 2+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2017-01-17  3:44 Star Zeng [this message]
2017-01-18  7:16 ` [PATCH] MdePkg: Correct comments of macros FixedPcdGetX/PatchPcdXXX in PcdLib.h Gao, Liming

find likely ancestor, descendant, or conflicting patches for this message:
( dfblob:4def3288629 dfblob:9e7e09f52cd )
 OR (
bs:"[PATCH] MdePkg: Correct comments of macros FixedPcdGetX/PatchPcdXXX in PcdLib.h" )
	(help)

Reply instructions:

You may reply publicly to this message via plain-text email
using any one of the following methods:

* Save the following mbox file, import it into your mail client,
  and reply-to-list from there: mbox

  Avoid top-posting and favor interleaved quoting:
  https://en.wikipedia.org/wiki/Posting_style#Interleaved_style

* Reply using the --to, --cc, and --in-reply-to
  switches of git-send-email(1):

  git send-email \
    --in-reply-to=1484624661-180620-1-git-send-email-star.zeng@intel.com \
    --to=devel@edk2.groups.io \
    /path/to/YOUR_REPLY

  https://kernel.org/pub/software/scm/git/docs/git-send-email.html

* If your mail client supports setting the In-Reply-To header
  via mailto: links, try the mailto: link

Be sure your reply has a Subject: header at the top and a blank line before the message body.

This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox