[patch] CryptoPkg/BaseCryptLib: Make comments consistent with the function

[patch] CryptoPkg/BaseCryptLib: Make comments consistent with the function

[Dandan Bi]

Cc: Qin Long <qin.long@intel.com>
Contributed-under: TianoCore Contribution Agreement 1.0
Signed-off-by: Dandan Bi <dandan.bi@intel.com>
---
 CryptoPkg/Library/BaseCryptLib/Hmac/CryptHmacSha256.c     | 2 +-
 CryptoPkg/Library/BaseCryptLib/Hmac/CryptHmacSha256Null.c | 2 +-
 2 files changed, 2 insertions(+), 2 deletions(-)

diff --git a/CryptoPkg/Library/BaseCryptLib/Hmac/CryptHmacSha256.c b/CryptoPkg/Library/BaseCryptLib/Hmac/CryptHmacSha256.c
index 5d349dc..e17ef29 100644
--- a/CryptoPkg/Library/BaseCryptLib/Hmac/CryptHmacSha256.c
+++ b/CryptoPkg/Library/BaseCryptLib/Hmac/CryptHmacSha256.c
@@ -162,11 +162,11 @@ HmacSha256Update (
 
   If HmacSha256Context is NULL, then return FALSE.
   If HashValue is NULL, then return FALSE.
 
   @param[in, out]  HmacSha256Context  Pointer to the HMAC-SHA256 context.
-  @param[out]      HashValue          Pointer to a buffer that receives the HMAC-SHA256 digest
+  @param[out]      HmacValue          Pointer to a buffer that receives the HMAC-SHA256 digest
                                       value (32 bytes).
 
   @retval TRUE   HMAC-SHA256 digest computation succeeded.
   @retval FALSE  HMAC-SHA256 digest computation failed.
 
diff --git a/CryptoPkg/Library/BaseCryptLib/Hmac/CryptHmacSha256Null.c b/CryptoPkg/Library/BaseCryptLib/Hmac/CryptHmacSha256Null.c
index 48704e1..35abdda 100644
--- a/CryptoPkg/Library/BaseCryptLib/Hmac/CryptHmacSha256Null.c
+++ b/CryptoPkg/Library/BaseCryptLib/Hmac/CryptHmacSha256Null.c
@@ -107,11 +107,11 @@ HmacSha256Update (
   Completes computation of the HMAC-SHA256 digest value.
 
   Return FALSE to indicate this interface is not supported.
 
   @param[in, out]  HmacSha256Context  Pointer to the HMAC-SHA256 context.
-  @param[out]      HashValue          Pointer to a buffer that receives the HMAC-SHA256 digest
+  @param[out]      HmacValue          Pointer to a buffer that receives the HMAC-SHA256 digest
                                       value (32 bytes).
 
   @retval FALSE  This interface is not supported.
 
 **/
-- 
1.9.5.msysgit.1

[patch] MdeModulePkg/BMMUI: add comments for function parameter

[Dandan Bi]

Cc: Eric Dong <eric.dong@intel.com>
Contributed-under: TianoCore Contribution Agreement 1.0
Signed-off-by: Dandan Bi <dandan.bi@intel.com>
---
 MdeModulePkg/Library/BootMaintenanceManagerUiLib/BootMaintenance.c | 1 +
 1 file changed, 1 insertion(+)

diff --git a/MdeModulePkg/Library/BootMaintenanceManagerUiLib/BootMaintenance.c b/MdeModulePkg/Library/BootMaintenanceManagerUiLib/BootMaintenance.c
index f40c61a..e49ab98 100644
--- a/MdeModulePkg/Library/BootMaintenanceManagerUiLib/BootMaintenance.c
+++ b/MdeModulePkg/Library/BootMaintenanceManagerUiLib/BootMaintenance.c
@@ -569,10 +569,11 @@ UpdateTerminalContent (
 }
 
 /**
   Update the console content in ConsoleMenu.
 
+  @param ConsoleName       The name for the console device type.
   @param BmmData           The BMM fake NV data.
 
 **/
 VOID
 UpdateConsoleContent(
-- 
1.9.5.msysgit.1

[patch] ShellPkg: Fix the coding style issue

[Dandan Bi]

Cc: Ruiyu Ni <ruiyu.ni@intel.com>
Contributed-under: TianoCore Contribution Agreement 1.0
Signed-off-by: Dandan Bi <dandan.bi@intel.com>
---
 ShellPkg/Application/Shell/FileHandleWrappers.c | 4 ++--
 1 file changed, 2 insertions(+), 2 deletions(-)

diff --git a/ShellPkg/Application/Shell/FileHandleWrappers.c b/ShellPkg/Application/Shell/FileHandleWrappers.c
index 9a75a68..18f4169 100644
--- a/ShellPkg/Application/Shell/FileHandleWrappers.c
+++ b/ShellPkg/Application/Shell/FileHandleWrappers.c
@@ -296,12 +296,12 @@ FileInterfaceNulWrite(
   Create the TAB completion list.
 
   @param[in]  InputString       The command line to expand.
   @param[in]  StringLen         Length of the command line.
   @param[in]  BufferSize        Buffer size.
-  @param[out] TabCompletionList Return the TAB completion list.
-  @param[out] TabUpdatePos      Return the TAB update position.
+  @param[in, out] TabCompletionList Return the TAB completion list.
+  @param[in, out] TabUpdatePos      Return the TAB update position.
 **/
 EFI_STATUS
 CreateTabCompletionList (
   IN CONST CHAR16             *InputString,
   IN CONST UINTN              StringLen, 
-- 
1.9.5.msysgit.1

Re: [patch] ShellPkg: Fix the coding style issue

[Ni, Ruiyu]

Reviewed-by: Ruiyu Ni <ruiyu.ni@intel.com>

Thanks/Ray

> -----Original Message-----
> From: Bi, Dandan
> Sent: Thursday, November 10, 2016 3:40 PM
> To: edk2-devel@lists.01.org
> Cc: Ni, Ruiyu <ruiyu.ni@intel.com>
> Subject: [patch] ShellPkg: Fix the coding style issue
> 
> Cc: Ruiyu Ni <ruiyu.ni@intel.com>
> Contributed-under: TianoCore Contribution Agreement 1.0
> Signed-off-by: Dandan Bi <dandan.bi@intel.com>
> ---
>  ShellPkg/Application/Shell/FileHandleWrappers.c | 4 ++--
>  1 file changed, 2 insertions(+), 2 deletions(-)
> 
> diff --git a/ShellPkg/Application/Shell/FileHandleWrappers.c
> b/ShellPkg/Application/Shell/FileHandleWrappers.c
> index 9a75a68..18f4169 100644
> --- a/ShellPkg/Application/Shell/FileHandleWrappers.c
> +++ b/ShellPkg/Application/Shell/FileHandleWrappers.c
> @@ -296,12 +296,12 @@ FileInterfaceNulWrite(
>    Create the TAB completion list.
> 
>    @param[in]  InputString       The command line to expand.
>    @param[in]  StringLen         Length of the command line.
>    @param[in]  BufferSize        Buffer size.
> -  @param[out] TabCompletionList Return the TAB completion list.
> -  @param[out] TabUpdatePos      Return the TAB update position.
> +  @param[in, out] TabCompletionList Return the TAB completion list.
> +  @param[in, out] TabUpdatePos      Return the TAB update position.
>  **/
>  EFI_STATUS
>  CreateTabCompletionList (
>    IN CONST CHAR16             *InputString,
>    IN CONST UINTN              StringLen,
> --
> 1.9.5.msysgit.1

Re: [patch] MdeModulePkg/BMMUI: add comments for function parameter

[Dong, Eric]

Reviewed-by: Eric Dong <eric.dong@intel.com>

> -----Original Message-----
> From: Bi, Dandan
> Sent: Thursday, November 10, 2016 3:40 PM
> To: edk2-devel@lists.01.org
> Cc: Dong, Eric
> Subject: [patch] MdeModulePkg/BMMUI: add comments for function parameter
> 
> Cc: Eric Dong <eric.dong@intel.com>
> Contributed-under: TianoCore Contribution Agreement 1.0
> Signed-off-by: Dandan Bi <dandan.bi@intel.com>
> ---
>  MdeModulePkg/Library/BootMaintenanceManagerUiLib/BootMaintenance.c | 1 +
>  1 file changed, 1 insertion(+)
> 
> diff --git a/MdeModulePkg/Library/BootMaintenanceManagerUiLib/BootMaintenance.c
> b/MdeModulePkg/Library/BootMaintenanceManagerUiLib/BootMaintenance.c
> index f40c61a..e49ab98 100644
> --- a/MdeModulePkg/Library/BootMaintenanceManagerUiLib/BootMaintenance.c
> +++ b/MdeModulePkg/Library/BootMaintenanceManagerUiLib/BootMaintenance.c
> @@ -569,10 +569,11 @@ UpdateTerminalContent (
>  }
> 
>  /**
>    Update the console content in ConsoleMenu.
> 
> +  @param ConsoleName       The name for the console device type.
>    @param BmmData           The BMM fake NV data.
> 
>  **/
>  VOID
>  UpdateConsoleContent(
> --
> 1.9.5.msysgit.1

Re: [patch] CryptoPkg/BaseCryptLib: Make comments consistent with the function

[Long, Qin]

Dandan,

Could you help to correct the comments in BaseCryptLib.h, which also used the unaligned parameter name? 


Best Regards & Thanks,
LONG, Qin

> -----Original Message-----
> From: Bi, Dandan
> Sent: Thursday, November 10, 2016 3:40 PM
> To: edk2-devel@lists.01.org
> Cc: Long, Qin
> Subject: [patch] CryptoPkg/BaseCryptLib: Make comments consistent with
> the function
> 
> Cc: Qin Long <qin.long@intel.com>
> Contributed-under: TianoCore Contribution Agreement 1.0
> Signed-off-by: Dandan Bi <dandan.bi@intel.com>
> ---
>  CryptoPkg/Library/BaseCryptLib/Hmac/CryptHmacSha256.c     | 2 +-
>  CryptoPkg/Library/BaseCryptLib/Hmac/CryptHmacSha256Null.c | 2 +-
>  2 files changed, 2 insertions(+), 2 deletions(-)
> 
> diff --git a/CryptoPkg/Library/BaseCryptLib/Hmac/CryptHmacSha256.c
> b/CryptoPkg/Library/BaseCryptLib/Hmac/CryptHmacSha256.c
> index 5d349dc..e17ef29 100644
> --- a/CryptoPkg/Library/BaseCryptLib/Hmac/CryptHmacSha256.c
> +++ b/CryptoPkg/Library/BaseCryptLib/Hmac/CryptHmacSha256.c
> @@ -162,11 +162,11 @@ HmacSha256Update (
> 
>    If HmacSha256Context is NULL, then return FALSE.
>    If HashValue is NULL, then return FALSE.
> 
>    @param[in, out]  HmacSha256Context  Pointer to the HMAC-SHA256
> context.
> -  @param[out]      HashValue          Pointer to a buffer that receives the
> HMAC-SHA256 digest
> +  @param[out]      HmacValue          Pointer to a buffer that receives the
> HMAC-SHA256 digest
>                                        value (32 bytes).
> 
>    @retval TRUE   HMAC-SHA256 digest computation succeeded.
>    @retval FALSE  HMAC-SHA256 digest computation failed.
> 
> diff --git a/CryptoPkg/Library/BaseCryptLib/Hmac/CryptHmacSha256Null.c
> b/CryptoPkg/Library/BaseCryptLib/Hmac/CryptHmacSha256Null.c
> index 48704e1..35abdda 100644
> --- a/CryptoPkg/Library/BaseCryptLib/Hmac/CryptHmacSha256Null.c
> +++ b/CryptoPkg/Library/BaseCryptLib/Hmac/CryptHmacSha256Null.c
> @@ -107,11 +107,11 @@ HmacSha256Update (
>    Completes computation of the HMAC-SHA256 digest value.
> 
>    Return FALSE to indicate this interface is not supported.
> 
>    @param[in, out]  HmacSha256Context  Pointer to the HMAC-SHA256
> context.
> -  @param[out]      HashValue          Pointer to a buffer that receives the
> HMAC-SHA256 digest
> +  @param[out]      HmacValue          Pointer to a buffer that receives the
> HMAC-SHA256 digest
>                                        value (32 bytes).
> 
>    @retval FALSE  This interface is not supported.
> 
>  **/
> --
> 1.9.5.msysgit.1

Re: [patch] CryptoPkg/BaseCryptLib: Make comments consistent with the function

[Bi, Dandan]

Yes! I will correct them and send a V2 patch.

Thanks,
Dandan

-----Original Message-----
From: Long, Qin 
Sent: Thursday, November 10, 2016 4:25 PM
To: Bi, Dandan <dandan.bi@intel.com>; edk2-devel@lists.01.org
Subject: RE: [patch] CryptoPkg/BaseCryptLib: Make comments consistent with the function

Dandan,

Could you help to correct the comments in BaseCryptLib.h, which also used the unaligned parameter name? 


Best Regards & Thanks,
LONG, Qin

> -----Original Message-----
> From: Bi, Dandan
> Sent: Thursday, November 10, 2016 3:40 PM
> To: edk2-devel@lists.01.org
> Cc: Long, Qin
> Subject: [patch] CryptoPkg/BaseCryptLib: Make comments consistent with 
> the function
> 
> Cc: Qin Long <qin.long@intel.com>
> Contributed-under: TianoCore Contribution Agreement 1.0
> Signed-off-by: Dandan Bi <dandan.bi@intel.com>
> ---
>  CryptoPkg/Library/BaseCryptLib/Hmac/CryptHmacSha256.c     | 2 +-
>  CryptoPkg/Library/BaseCryptLib/Hmac/CryptHmacSha256Null.c | 2 +-
>  2 files changed, 2 insertions(+), 2 deletions(-)
> 
> diff --git a/CryptoPkg/Library/BaseCryptLib/Hmac/CryptHmacSha256.c
> b/CryptoPkg/Library/BaseCryptLib/Hmac/CryptHmacSha256.c
> index 5d349dc..e17ef29 100644
> --- a/CryptoPkg/Library/BaseCryptLib/Hmac/CryptHmacSha256.c
> +++ b/CryptoPkg/Library/BaseCryptLib/Hmac/CryptHmacSha256.c
> @@ -162,11 +162,11 @@ HmacSha256Update (
> 
>    If HmacSha256Context is NULL, then return FALSE.
>    If HashValue is NULL, then return FALSE.
> 
>    @param[in, out]  HmacSha256Context  Pointer to the HMAC-SHA256 
> context.
> -  @param[out]      HashValue          Pointer to a buffer that receives the
> HMAC-SHA256 digest
> +  @param[out]      HmacValue          Pointer to a buffer that receives the
> HMAC-SHA256 digest
>                                        value (32 bytes).
> 
>    @retval TRUE   HMAC-SHA256 digest computation succeeded.
>    @retval FALSE  HMAC-SHA256 digest computation failed.
> 
> diff --git a/CryptoPkg/Library/BaseCryptLib/Hmac/CryptHmacSha256Null.c
> b/CryptoPkg/Library/BaseCryptLib/Hmac/CryptHmacSha256Null.c
> index 48704e1..35abdda 100644
> --- a/CryptoPkg/Library/BaseCryptLib/Hmac/CryptHmacSha256Null.c
> +++ b/CryptoPkg/Library/BaseCryptLib/Hmac/CryptHmacSha256Null.c
> @@ -107,11 +107,11 @@ HmacSha256Update (
>    Completes computation of the HMAC-SHA256 digest value.
> 
>    Return FALSE to indicate this interface is not supported.
> 
>    @param[in, out]  HmacSha256Context  Pointer to the HMAC-SHA256 
> context.
> -  @param[out]      HashValue          Pointer to a buffer that receives the
> HMAC-SHA256 digest
> +  @param[out]      HmacValue          Pointer to a buffer that receives the
> HMAC-SHA256 digest
>                                        value (32 bytes).
> 
>    @retval FALSE  This interface is not supported.
> 
>  **/
> --
> 1.9.5.msysgit.1