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>

diff --git a/MdeModulePkg/Universal/Variable/Pei/Variable.c b/MdeModulePkg/Universal/Variable/Pei/Variable.c
index 96a52f23d1c1ecbfc8ea05e66d478e1fed3ad895..77b3eaeb210ddfcf91e249d6ce1304f0638098be 100644 (file)
--- a/MdeModulePkg/Universal/Variable/Pei/Variable.c
+++ b/MdeModulePkg/Universal/Variable/Pei/Variable.c
@@ -57,7 +57,7 @@ PeimInitializeVariableServices (
 \r
   @param VarStoreHeader  Pointer to the Variable Store Header.\r
 \r
 \r
   @param VarStoreHeader  Pointer to the Variable Store Header.\r
 \r

-  @return Pointer to the first variable header\r
+  @return Pointer to the first variable header.\r

 \r
 **/\r
 VARIABLE_HEADER *\r
 \r
 **/\r
 VARIABLE_HEADER *\r


@@ -66,18 +66,22 @@ GetStartPointer (
   )\r
 {\r
   //\r
   )\r
 {\r
   //\r

-  // The end of variable store\r
+  // The start of variable store\r

   //\r
   return (VARIABLE_HEADER *) HEADER_ALIGN (VarStoreHeader + 1);\r
 }\r
 \r
 \r
 /**\r
   //\r
   return (VARIABLE_HEADER *) HEADER_ALIGN (VarStoreHeader + 1);\r
 }\r
 \r
 \r
 /**\r

-  This code gets the pointer to the last variable memory pointer byte.\r

 \r
 \r

-  @param  VarStoreHeader  Pointer to the Variable Store Header.\r
+  Gets the pointer to the end of the variable storage area.\r
+\r
+  This function gets pointer to the end of the variable storage\r
+  area, according to the input variable store header.\r
+\r
+  @param VarStoreHeader  Pointer to the Variable Store Header.\r

 \r
 \r

-  @return VARIABLE_HEADER* pointer to last unavailable Variable Header.\r
+  @return Pointer to the end of the variable storage area.\r

 \r
 **/\r
 VARIABLE_HEADER *\r
 \r
 **/\r
 VARIABLE_HEADER *\r

diff --git a/MdeModulePkg/Universal/Variable/RuntimeDxe/Variable.c b/MdeModulePkg/Universal/Variable/RuntimeDxe/Variable.c
index 1ea2f84dda68ee700d2d9317cc3c98d2630a7272..dc8622db8138f237d60e7908a8e674a1e5680dfd 100644 (file)
--- a/MdeModulePkg/Universal/Variable/RuntimeDxe/Variable.c
+++ b/MdeModulePkg/Universal/Variable/RuntimeDxe/Variable.c
@@ -681,7 +681,7 @@ GetStartPointer (
   )\r
 {\r
   //\r
   )\r
 {\r
   //\r

-  // The end of variable store.\r
+  // The start of variable store.\r

   //\r
   return (VARIABLE_HEADER *) HEADER_ALIGN (VarStoreHeader + 1);\r
 }\r
   //\r
   return (VARIABLE_HEADER *) HEADER_ALIGN (VarStoreHeader + 1);\r
 }\r