[PATCH] MdeModulePkg/DxeCapsuleLibFmp: Add missing description for parameter

[PATCH] MdeModulePkg/DxeCapsuleLibFmp: Add missing description for parameter

[Zhang, Shenglei]

The description of parameter CapFileName is missing in comments.
So add the description.

Cc: Jian J Wang <jian.j.wang@intel.com>
Cc: Hao A Wu <hao.a.wu@intel.com>
Signed-off-by: Shenglei Zhang <shenglei.zhang@intel.com>
---
 MdeModulePkg/Library/DxeCapsuleLibFmp/DxeCapsuleProcessLib.c | 1 +
 1 file changed, 1 insertion(+)

diff --git a/MdeModulePkg/Library/DxeCapsuleLibFmp/DxeCapsuleProcessLib.c b/MdeModulePkg/Library/DxeCapsuleLibFmp/DxeCapsuleProcessLib.c
index 2cecc87385b3..f2cd0ad3e816 100644
--- a/MdeModulePkg/Library/DxeCapsuleLibFmp/DxeCapsuleProcessLib.c
+++ b/MdeModulePkg/Library/DxeCapsuleLibFmp/DxeCapsuleProcessLib.c
@@ -136,6 +136,7 @@ UINT32                      mCapsuleTotalNumber;
   Caution: This function may receive untrusted input.
 
   @param[in]  CapsuleHeader         Points to a capsule header.
+  @param[in]  CapFileName           Capsule file name.
   @param[out] ResetRequired         Indicates whether reset is required or not.
 
   @retval EFI_SUCESS            Process Capsule Image successfully.
-- 
2.18.0.windows.1

Re: [PATCH] MdeModulePkg/DxeCapsuleLibFmp: Add missing description for parameter

[Wu, Hao A]

> -----Original Message-----
> From: Zhang, Shenglei
> Sent: Tuesday, August 06, 2019 10:18 AM
> To: devel@edk2.groups.io
> Cc: Wang, Jian J; Wu, Hao A
> Subject: [PATCH] MdeModulePkg/DxeCapsuleLibFmp: Add missing
> description for parameter
> 
> The description of parameter CapFileName is missing in comments.
> So add the description.
> 
> Cc: Jian J Wang <jian.j.wang@intel.com>
> Cc: Hao A Wu <hao.a.wu@intel.com>


Hello,

One comment that is not related with the patch itself.

In the future, please help to run the 'GetMaintainer.py' script under
BaseTools/Scripts/ to get the CC list when proposing a patch in the
MdeModulePkg.

For the patch:
Reviewed-by: Hao A Wu <hao.a.wu@intel.com>
And the pushed via commit 111bbcf876.

Best Regards,
Hao Wu


> Signed-off-by: Shenglei Zhang <shenglei.zhang@intel.com>
> ---
>  MdeModulePkg/Library/DxeCapsuleLibFmp/DxeCapsuleProcessLib.c | 1 +
>  1 file changed, 1 insertion(+)
> 
> diff --git
> a/MdeModulePkg/Library/DxeCapsuleLibFmp/DxeCapsuleProcessLib.c
> b/MdeModulePkg/Library/DxeCapsuleLibFmp/DxeCapsuleProcessLib.c
> index 2cecc87385b3..f2cd0ad3e816 100644
> --- a/MdeModulePkg/Library/DxeCapsuleLibFmp/DxeCapsuleProcessLib.c
> +++ b/MdeModulePkg/Library/DxeCapsuleLibFmp/DxeCapsuleProcessLib.c
> @@ -136,6 +136,7 @@ UINT32                      mCapsuleTotalNumber;
>    Caution: This function may receive untrusted input.
> 
>    @param[in]  CapsuleHeader         Points to a capsule header.
> +  @param[in]  CapFileName           Capsule file name.
>    @param[out] ResetRequired         Indicates whether reset is required or not.
> 
>    @retval EFI_SUCESS            Process Capsule Image successfully.
> --
> 2.18.0.windows.1