MdeModulePkg Variable: Add/Correct GetHobVariableStore para description

[edk2] [PATCH] MdeModulePkg Variable: Add/Correct GetHobVariableStore para description

Posted by Star Zeng 5 years, 9 months ago

It is caused by 09808bd39b0c76559354253639766458ec24da79.

Cc: Liming Gao <liming.gao@intel.com>
Cc: Dandan Bi <dandan.bi@intel.com>
Contributed-under: TianoCore Contribution Agreement 1.1
Signed-off-by: Star Zeng <star.zeng@intel.com>
---
 MdeModulePkg/Universal/Variable/Pei/Variable.c        | 3 +++
 MdeModulePkg/Universal/Variable/RuntimeDxe/Variable.c | 2 +-
 2 files changed, 4 insertions(+), 1 deletion(-)

diff --git a/MdeModulePkg/Universal/Variable/Pei/Variable.c b/MdeModulePkg/Universal/Variable/Pei/Variable.c
index d75a13e2b079..96a52f23d1c1 100644
--- a/MdeModulePkg/Universal/Variable/Pei/Variable.c
+++ b/MdeModulePkg/Universal/Variable/Pei/Variable.c
@@ -498,6 +498,9 @@ CompareWithValidVariable (
 /**
   Get HOB variable store.
 
+  @param[out] StoreInfo             Return the store info.
+  @param[out] VariableStoreHeader   Return variable store header.
+
 **/
 VOID
 GetHobVariableStore (
diff --git a/MdeModulePkg/Universal/Variable/RuntimeDxe/Variable.c b/MdeModulePkg/Universal/Variable/RuntimeDxe/Variable.c
index 42b0bfda570d..1ea2f84dda68 100644
--- a/MdeModulePkg/Universal/Variable/RuntimeDxe/Variable.c
+++ b/MdeModulePkg/Universal/Variable/RuntimeDxe/Variable.c
@@ -4173,7 +4173,7 @@ ConvertNormalVarStorageToAuthVarStorage (
 /**
   Get HOB variable store.
 
-  @param[out] VariableGuid      NV variable store signature.
+  @param[in] VariableGuid       NV variable store signature.
 
   @retval EFI_SUCCESS           Function successfully executed.
   @retval EFI_OUT_OF_RESOURCES  Fail to allocate enough memory resource.
-- 
2.7.0.windows.1

_______________________________________________
edk2-devel mailing list
edk2-devel@lists.01.org
https://lists.01.org/mailman/listinfo/edk2-devel

Re: [edk2] [PATCH] MdeModulePkg Variable: Add/Correct GetHobVariableStore para description

Posted by Gao, Liming 5 years, 9 months ago

Reviewed-by: Liming Gao <liming.gao@intel.com>

>-----Original Message-----
>From: edk2-devel [mailto:edk2-devel-bounces@lists.01.org] On Behalf Of Star
>Zeng
>Sent: Monday, July 02, 2018 4:57 PM
>To: edk2-devel@lists.01.org
>Cc: Bi, Dandan <dandan.bi@intel.com>; Gao, Liming <liming.gao@intel.com>;
>Zeng, Star <star.zeng@intel.com>
>Subject: [edk2] [PATCH] MdeModulePkg Variable: Add/Correct
>GetHobVariableStore para description
>
>It is caused by 09808bd39b0c76559354253639766458ec24da79.
>
>Cc: Liming Gao <liming.gao@intel.com>
>Cc: Dandan Bi <dandan.bi@intel.com>
>Contributed-under: TianoCore Contribution Agreement 1.1
>Signed-off-by: Star Zeng <star.zeng@intel.com>
>---
> MdeModulePkg/Universal/Variable/Pei/Variable.c        | 3 +++
> MdeModulePkg/Universal/Variable/RuntimeDxe/Variable.c | 2 +-
> 2 files changed, 4 insertions(+), 1 deletion(-)
>
>diff --git a/MdeModulePkg/Universal/Variable/Pei/Variable.c
>b/MdeModulePkg/Universal/Variable/Pei/Variable.c
>index d75a13e2b079..96a52f23d1c1 100644
>--- a/MdeModulePkg/Universal/Variable/Pei/Variable.c
>+++ b/MdeModulePkg/Universal/Variable/Pei/Variable.c
>@@ -498,6 +498,9 @@ CompareWithValidVariable (
> /**
>   Get HOB variable store.
>
>+  @param[out] StoreInfo             Return the store info.
>+  @param[out] VariableStoreHeader   Return variable store header.
>+
> **/
> VOID
> GetHobVariableStore (
>diff --git a/MdeModulePkg/Universal/Variable/RuntimeDxe/Variable.c
>b/MdeModulePkg/Universal/Variable/RuntimeDxe/Variable.c
>index 42b0bfda570d..1ea2f84dda68 100644
>--- a/MdeModulePkg/Universal/Variable/RuntimeDxe/Variable.c
>+++ b/MdeModulePkg/Universal/Variable/RuntimeDxe/Variable.c
>@@ -4173,7 +4173,7 @@ ConvertNormalVarStorageToAuthVarStorage (
> /**
>   Get HOB variable store.
>
>-  @param[out] VariableGuid      NV variable store signature.
>+  @param[in] VariableGuid       NV variable store signature.
>
>   @retval EFI_SUCCESS           Function successfully executed.
>   @retval EFI_OUT_OF_RESOURCES  Fail to allocate enough memory resource.
>--
>2.7.0.windows.1
>
>_______________________________________________
>edk2-devel mailing list
>edk2-devel@lists.01.org
>https://lists.01.org/mailman/listinfo/edk2-devel
_______________________________________________
edk2-devel mailing list
edk2-devel@lists.01.org
https://lists.01.org/mailman/listinfo/edk2-devel

Re: [edk2] [PATCH] MdeModulePkg Variable: Add/Correct GetHobVariableStore para description

Posted by Bi, Dandan 5 years, 9 months ago

Reviewed-by:  Dandan Bi <dandan.bi@intel.com>

Thanks,
Dandan

-----Original Message-----
From: edk2-devel [mailto:edk2-devel-bounces@lists.01.org] On Behalf Of Star Zeng
Sent: Monday, July 2, 2018 4:57 PM
To: edk2-devel@lists.01.org
Cc: Bi, Dandan <dandan.bi@intel.com>; Gao, Liming <liming.gao@intel.com>; Zeng, Star <star.zeng@intel.com>
Subject: [edk2] [PATCH] MdeModulePkg Variable: Add/Correct GetHobVariableStore para description

It is caused by 09808bd39b0c76559354253639766458ec24da79.

Cc: Liming Gao <liming.gao@intel.com>
Cc: Dandan Bi <dandan.bi@intel.com>
Contributed-under: TianoCore Contribution Agreement 1.1
Signed-off-by: Star Zeng <star.zeng@intel.com>
---
 MdeModulePkg/Universal/Variable/Pei/Variable.c        | 3 +++
 MdeModulePkg/Universal/Variable/RuntimeDxe/Variable.c | 2 +-
 2 files changed, 4 insertions(+), 1 deletion(-)

diff --git a/MdeModulePkg/Universal/Variable/Pei/Variable.c b/MdeModulePkg/Universal/Variable/Pei/Variable.c
index d75a13e2b079..96a52f23d1c1 100644
--- a/MdeModulePkg/Universal/Variable/Pei/Variable.c
+++ b/MdeModulePkg/Universal/Variable/Pei/Variable.c
@@ -498,6 +498,9 @@ CompareWithValidVariable (
 /**
   Get HOB variable store.
 
+  @param[out] StoreInfo             Return the store info.
+  @param[out] VariableStoreHeader   Return variable store header.
+
 **/
 VOID
 GetHobVariableStore (
diff --git a/MdeModulePkg/Universal/Variable/RuntimeDxe/Variable.c b/MdeModulePkg/Universal/Variable/RuntimeDxe/Variable.c
index 42b0bfda570d..1ea2f84dda68 100644
--- a/MdeModulePkg/Universal/Variable/RuntimeDxe/Variable.c
+++ b/MdeModulePkg/Universal/Variable/RuntimeDxe/Variable.c
@@ -4173,7 +4173,7 @@ ConvertNormalVarStorageToAuthVarStorage (
 /**
   Get HOB variable store.
 
-  @param[out] VariableGuid      NV variable store signature.
+  @param[in] VariableGuid       NV variable store signature.
 
   @retval EFI_SUCCESS           Function successfully executed.
   @retval EFI_OUT_OF_RESOURCES  Fail to allocate enough memory resource.
-- 
2.7.0.windows.1

_______________________________________________
edk2-devel mailing list
edk2-devel@lists.01.org
https://lists.01.org/mailman/listinfo/edk2-devel
_______________________________________________
edk2-devel mailing list
edk2-devel@lists.01.org
https://lists.01.org/mailman/listinfo/edk2-devel