summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorStar Zeng <star.zeng@intel.com>2018-09-27 09:46:17 +0800
committerStar Zeng <star.zeng@intel.com>2018-09-28 11:13:34 +0800
commit4063d37c6a96f534abb0d2861776648fb453ca4d (patch)
treee6c8e0eb7bae4eddbfe987147b130e32cd746ed0
parent631db6b24d84c12c8710ee8b01cc095937c35e10 (diff)
downloadedk2-4063d37c6a96f534abb0d2861776648fb453ca4d.zip
edk2-4063d37c6a96f534abb0d2861776648fb453ca4d.tar.gz
edk2-4063d37c6a96f534abb0d2861776648fb453ca4d.tar.bz2
MdeModulePkg Variable: Fix comment typo 'end' to 'start'
REF: https://bugzilla.tianocore.org/show_bug.cgi?id=1214 This patch only updates comment and function description, so has no functionality impact. This patch fixes comment typo 'end' to 'start' in GetStartPointer. GetStartPointer for PEI and DXE has aligned function description, but GetEndPointer does not. This patch also aligns GetEndPointer's function description for PEI and DXE. Cc: Liming Gao <liming.gao@intel.com> Cc: Ruiyu Ni <ruiyu.ni@intel.com> Cc: Jian J Wang <jian.j.wang@intel.com> Contributed-under: TianoCore Contribution Agreement 1.1 Signed-off-by: Star Zeng <star.zeng@intel.com> Reviewed-by: Ruiyu Ni <ruiyu.ni@intel.com>
-rw-r--r--MdeModulePkg/Universal/Variable/Pei/Variable.c14
-rw-r--r--MdeModulePkg/Universal/Variable/RuntimeDxe/Variable.c2
2 files changed, 10 insertions, 6 deletions
diff --git a/MdeModulePkg/Universal/Variable/Pei/Variable.c b/MdeModulePkg/Universal/Variable/Pei/Variable.c
index 96a52f2..77b3eae 100644
--- a/MdeModulePkg/Universal/Variable/Pei/Variable.c
+++ b/MdeModulePkg/Universal/Variable/Pei/Variable.c
@@ -57,7 +57,7 @@ PeimInitializeVariableServices (
@param VarStoreHeader Pointer to the Variable Store Header.
- @return Pointer to the first variable header
+ @return Pointer to the first variable header.
**/
VARIABLE_HEADER *
@@ -66,18 +66,22 @@ GetStartPointer (
)
{
//
- // The end of variable store
+ // The start of variable store
//
return (VARIABLE_HEADER *) HEADER_ALIGN (VarStoreHeader + 1);
}
/**
- This code gets the pointer to the last variable memory pointer byte.
- @param VarStoreHeader Pointer to the Variable Store Header.
+ Gets the pointer to the end of the variable storage area.
+
+ This function gets pointer to the end of the variable storage
+ area, according to the input variable store header.
+
+ @param VarStoreHeader Pointer to the Variable Store Header.
- @return VARIABLE_HEADER* pointer to last unavailable Variable Header.
+ @return Pointer to the end of the variable storage area.
**/
VARIABLE_HEADER *
diff --git a/MdeModulePkg/Universal/Variable/RuntimeDxe/Variable.c b/MdeModulePkg/Universal/Variable/RuntimeDxe/Variable.c
index 1ea2f84..dc8622d 100644
--- a/MdeModulePkg/Universal/Variable/RuntimeDxe/Variable.c
+++ b/MdeModulePkg/Universal/Variable/RuntimeDxe/Variable.c
@@ -681,7 +681,7 @@ GetStartPointer (
)
{
//
- // The end of variable store.
+ // The start of variable store.
//
return (VARIABLE_HEADER *) HEADER_ALIGN (VarStoreHeader + 1);
}