1. Patchew
  2. EDK2
  3. [edk2-devel] [PATCH 0/3] Fix coding style issues
  4. View patch

[edk2-devel] [PATCH 1/3] MdeModulePkg: Fix typos and add periods

Zhang, Shenglei posted 3 patches 6 years, 6 months ago
[edk2-devel] [PATCH 1/3] MdeModulePkg: Fix typos and add periods
Posted by Zhang, Shenglei 6 years, 6 months ago 
para in Presentation.c is spelled incorrectly.
Add periods in CapsuleLib.h and Presentation.c.

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/Universal/SetupBrowserDxe/Presentation.c | 4 ++--
 MdeModulePkg/Include/Library/CapsuleLib.h             | 2 +-
 2 files changed, 3 insertions(+), 3 deletions(-)

diff --git a/MdeModulePkg/Universal/SetupBrowserDxe/Presentation.c b/MdeModulePkg/Universal/SetupBrowserDxe/Presentation.c
index 7c36a6f2b7fa..bafee4c61292 100644
--- a/MdeModulePkg/Universal/SetupBrowserDxe/Presentation.c
+++ b/MdeModulePkg/Universal/SetupBrowserDxe/Presentation.c
@@ -21,9 +21,9 @@ FORM_DISPLAY_ENGINE_FORM gDisplayFormData;
 BOOLEAN            mFinishRetrieveCall = FALSE;
 
 /**
-  Check whether the ConfigAccess protocol is available
+  Check whether the ConfigAccess protocol is available.
 
-  @parm FormSet           FormSet of which the ConfigAcces protocol need to be checked.
+  @param FormSet           FormSet of which the ConfigAcces protocol need to be checked.
 
   @retval EFI_SUCCESS     The function executed successfully.
 
diff --git a/MdeModulePkg/Include/Library/CapsuleLib.h b/MdeModulePkg/Include/Library/CapsuleLib.h
index 7a5414c80f19..0f4164257619 100644
--- a/MdeModulePkg/Include/Library/CapsuleLib.h
+++ b/MdeModulePkg/Include/Library/CapsuleLib.h
@@ -101,7 +101,7 @@ CoDCheckCapsuleOnDiskFlag(
   );
 
 /**
-  This routine is called to clear CapsuleOnDisk flags including OsIndications and BootNext variable
+  This routine is called to clear CapsuleOnDisk flags including OsIndications and BootNext variable.
 
   @retval EFI_SUCCESS   All Capsule On Disk flags are cleared
 
-- 
2.18.0.windows.1


-=-=-=-=-=-=-=-=-=-=-=-
Groups.io Links: You receive all messages sent to this group.

View/Reply Online (#44601): https://edk2.groups.io/g/devel/message/44601
Mute This Topic: https://groups.io/mt/32652007/1787277
Group Owner: devel+owner@edk2.groups.io
Unsubscribe: https://edk2.groups.io/g/devel/unsub  [importer@patchew.org]
-=-=-=-=-=-=-=-=-=-=-=-
Re: [edk2-devel] [PATCH 1/3] MdeModulePkg: Fix typos and add periods
Posted by Philippe Mathieu-Daudé 6 years, 6 months ago 
On 7/30/19 10:37 AM, Zhang, Shenglei wrote:
> para in Presentation.c is spelled incorrectly.

'param'

> Add periods in CapsuleLib.h and Presentation.c.
> 
> 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/Universal/SetupBrowserDxe/Presentation.c | 4 ++--
>  MdeModulePkg/Include/Library/CapsuleLib.h             | 2 +-
>  2 files changed, 3 insertions(+), 3 deletions(-)
> 
> diff --git a/MdeModulePkg/Universal/SetupBrowserDxe/Presentation.c b/MdeModulePkg/Universal/SetupBrowserDxe/Presentation.c
> index 7c36a6f2b7fa..bafee4c61292 100644
> --- a/MdeModulePkg/Universal/SetupBrowserDxe/Presentation.c
> +++ b/MdeModulePkg/Universal/SetupBrowserDxe/Presentation.c
> @@ -21,9 +21,9 @@ FORM_DISPLAY_ENGINE_FORM gDisplayFormData;
>  BOOLEAN            mFinishRetrieveCall = FALSE;
>  
>  /**
> -  Check whether the ConfigAccess protocol is available
> +  Check whether the ConfigAccess protocol is available.
>  
> -  @parm FormSet           FormSet of which the ConfigAcces protocol need to be checked.
> +  @param FormSet           FormSet of which the ConfigAcces protocol need to be checked.
>  
>    @retval EFI_SUCCESS     The function executed successfully.
>  
> diff --git a/MdeModulePkg/Include/Library/CapsuleLib.h b/MdeModulePkg/Include/Library/CapsuleLib.h
> index 7a5414c80f19..0f4164257619 100644
> --- a/MdeModulePkg/Include/Library/CapsuleLib.h
> +++ b/MdeModulePkg/Include/Library/CapsuleLib.h
> @@ -101,7 +101,7 @@ CoDCheckCapsuleOnDiskFlag(
>    );
>  
>  /**
> -  This routine is called to clear CapsuleOnDisk flags including OsIndications and BootNext variable
> +  This routine is called to clear CapsuleOnDisk flags including OsIndications and BootNext variable.
>  
>    @retval EFI_SUCCESS   All Capsule On Disk flags are cleared
>  
> 

Reviewed-by: Philippe Mathieu-Daude <philmd@redhat.com>

-=-=-=-=-=-=-=-=-=-=-=-
Groups.io Links: You receive all messages sent to this group.

View/Reply Online (#44614): https://edk2.groups.io/g/devel/message/44614
Mute This Topic: https://groups.io/mt/32652007/1787277
Group Owner: devel+owner@edk2.groups.io
Unsubscribe: https://edk2.groups.io/g/devel/unsub  [importer@patchew.org]
-=-=-=-=-=-=-=-=-=-=-=-
Re: [edk2-devel] [PATCH 1/3] MdeModulePkg: Fix typos and add periods
Posted by Dandan Bi 6 years, 6 months ago 
Hi Shenglei,

How about refine the commit message like below before push the patch?
1.  Update @parm to @param in function comments in Presentation.c.
2.  Add missing period (.) in some function comments.

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



Thanks,
Dandan

> -----Original Message-----
> From: devel@edk2.groups.io [mailto:devel@edk2.groups.io] On Behalf Of
> Zhang, Shenglei
> Sent: Tuesday, July 30, 2019 4:38 PM
> To: devel@edk2.groups.io
> Cc: Wang, Jian J <jian.j.wang@intel.com>; Wu, Hao A <hao.a.wu@intel.com>
> Subject: [edk2-devel] [PATCH 1/3] MdeModulePkg: Fix typos and add
> periods
> 
> para in Presentation.c is spelled incorrectly.
> Add periods in CapsuleLib.h and Presentation.c.
> 
> 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/Universal/SetupBrowserDxe/Presentation.c | 4 ++--
>  MdeModulePkg/Include/Library/CapsuleLib.h             | 2 +-
>  2 files changed, 3 insertions(+), 3 deletions(-)
> 
> diff --git a/MdeModulePkg/Universal/SetupBrowserDxe/Presentation.c
> b/MdeModulePkg/Universal/SetupBrowserDxe/Presentation.c
> index 7c36a6f2b7fa..bafee4c61292 100644
> --- a/MdeModulePkg/Universal/SetupBrowserDxe/Presentation.c
> +++ b/MdeModulePkg/Universal/SetupBrowserDxe/Presentation.c
> @@ -21,9 +21,9 @@ FORM_DISPLAY_ENGINE_FORM gDisplayFormData;
>  BOOLEAN            mFinishRetrieveCall = FALSE;
> 
>  /**
> -  Check whether the ConfigAccess protocol is available
> +  Check whether the ConfigAccess protocol is available.
> 
> -  @parm FormSet           FormSet of which the ConfigAcces protocol need to
> be checked.
> +  @param FormSet           FormSet of which the ConfigAcces protocol need to
> be checked.
> 
>    @retval EFI_SUCCESS     The function executed successfully.
> 
> diff --git a/MdeModulePkg/Include/Library/CapsuleLib.h
> b/MdeModulePkg/Include/Library/CapsuleLib.h
> index 7a5414c80f19..0f4164257619 100644
> --- a/MdeModulePkg/Include/Library/CapsuleLib.h
> +++ b/MdeModulePkg/Include/Library/CapsuleLib.h
> @@ -101,7 +101,7 @@ CoDCheckCapsuleOnDiskFlag(
>    );
> 
>  /**
> -  This routine is called to clear CapsuleOnDisk flags including OsIndications
> and BootNext variable
> +  This routine is called to clear CapsuleOnDisk flags including OsIndications
> and BootNext variable.
> 
>    @retval EFI_SUCCESS   All Capsule On Disk flags are cleared
> 
> --
> 2.18.0.windows.1
> 
> 
> 


-=-=-=-=-=-=-=-=-=-=-=-
Groups.io Links: You receive all messages sent to this group.

View/Reply Online (#44646): https://edk2.groups.io/g/devel/message/44646
Mute This Topic: https://groups.io/mt/32652007/1787277
Group Owner: devel+owner@edk2.groups.io
Unsubscribe: https://edk2.groups.io/g/devel/unsub  [importer@patchew.org]
-=-=-=-=-=-=-=-=-=-=-=-
Re: [edk2-devel] [PATCH 1/3] MdeModulePkg: Fix typos and add periods
Posted by Wang, Jian J 6 years, 6 months ago 
Reviewed-by: Jian J Wang <jian.j.wang@intel.com>


> -----Original Message-----
> From: devel@edk2.groups.io [mailto:devel@edk2.groups.io] On Behalf Of
> Zhang, Shenglei
> Sent: Tuesday, July 30, 2019 4:38 PM
> To: devel@edk2.groups.io
> Cc: Wang, Jian J <jian.j.wang@intel.com>; Wu, Hao A <hao.a.wu@intel.com>
> Subject: [edk2-devel] [PATCH 1/3] MdeModulePkg: Fix typos and add
> periods
> 
> para in Presentation.c is spelled incorrectly.
> Add periods in CapsuleLib.h and Presentation.c.
> 
> 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/Universal/SetupBrowserDxe/Presentation.c | 4 ++--
>  MdeModulePkg/Include/Library/CapsuleLib.h             | 2 +-
>  2 files changed, 3 insertions(+), 3 deletions(-)
> 
> diff --git a/MdeModulePkg/Universal/SetupBrowserDxe/Presentation.c
> b/MdeModulePkg/Universal/SetupBrowserDxe/Presentation.c
> index 7c36a6f2b7fa..bafee4c61292 100644
> --- a/MdeModulePkg/Universal/SetupBrowserDxe/Presentation.c
> +++ b/MdeModulePkg/Universal/SetupBrowserDxe/Presentation.c
> @@ -21,9 +21,9 @@ FORM_DISPLAY_ENGINE_FORM gDisplayFormData;
>  BOOLEAN            mFinishRetrieveCall = FALSE;
> 
>  /**
> -  Check whether the ConfigAccess protocol is available
> +  Check whether the ConfigAccess protocol is available.
> 
> -  @parm FormSet           FormSet of which the ConfigAcces protocol need to
> be checked.
> +  @param FormSet           FormSet of which the ConfigAcces protocol need
> to be checked.
> 
>    @retval EFI_SUCCESS     The function executed successfully.
> 
> diff --git a/MdeModulePkg/Include/Library/CapsuleLib.h
> b/MdeModulePkg/Include/Library/CapsuleLib.h
> index 7a5414c80f19..0f4164257619 100644
> --- a/MdeModulePkg/Include/Library/CapsuleLib.h
> +++ b/MdeModulePkg/Include/Library/CapsuleLib.h
> @@ -101,7 +101,7 @@ CoDCheckCapsuleOnDiskFlag(
>    );
> 
>  /**
> -  This routine is called to clear CapsuleOnDisk flags including OsIndications
> and BootNext variable
> +  This routine is called to clear CapsuleOnDisk flags including OsIndications
> and BootNext variable.
> 
>    @retval EFI_SUCCESS   All Capsule On Disk flags are cleared
> 
> --
> 2.18.0.windows.1
> 
> 
> 


-=-=-=-=-=-=-=-=-=-=-=-
Groups.io Links: You receive all messages sent to this group.

View/Reply Online (#44607): https://edk2.groups.io/g/devel/message/44607
Mute This Topic: https://groups.io/mt/32652007/1787277
Group Owner: devel+owner@edk2.groups.io
Unsubscribe: https://edk2.groups.io/g/devel/unsub  [importer@patchew.org]
-=-=-=-=-=-=-=-=-=-=-=-

Patchew 2.1-devel-b67e4c2

© 2016 - 2026 Red Hat, Inc.