1. Patchew
  2. EDK2
  3. [edk2] [patch 0/4] Fix coding style issue
  4. View patch

[edk2] [patch 1/4] IntelFrameworkModulePkg/Csm: Refine coding style in comments

Dandan Bi posted 4 patches 8 years, 1 month ago
[edk2] [patch 1/4] IntelFrameworkModulePkg/Csm: Refine coding style in comments
Posted by Dandan Bi 8 years, 1 month ago 
Make the comments follow Edk2 coding style:
1. Make the comments starts with /** and end with **/.
2. Make the comments descrition end with '.'

Cc: Jian J Wang <jian.j.wang@intel.com>
Cc: Liming Gao <liming.gao@intel.com>
Contributed-under: TianoCore Contribution Agreement 1.1
Signed-off-by: Dandan Bi <dandan.bi@intel.com>
---
 IntelFrameworkModulePkg/Csm/BiosThunk/KeyboardDxe/BiosKeyboard.c | 8 ++++----
 IntelFrameworkModulePkg/Csm/LegacyBiosDxe/LegacyBios.c           | 8 ++++----
 IntelFrameworkModulePkg/Csm/LegacyBiosDxe/LegacyBiosInterface.h  | 8 ++++----
 3 files changed, 12 insertions(+), 12 deletions(-)

diff --git a/IntelFrameworkModulePkg/Csm/BiosThunk/KeyboardDxe/BiosKeyboard.c b/IntelFrameworkModulePkg/Csm/BiosThunk/KeyboardDxe/BiosKeyboard.c
index d2224a2..ebf03d3 100644
--- a/IntelFrameworkModulePkg/Csm/BiosThunk/KeyboardDxe/BiosKeyboard.c
+++ b/IntelFrameworkModulePkg/Csm/BiosThunk/KeyboardDxe/BiosKeyboard.c
@@ -1731,12 +1731,12 @@ CheckKeyboardConnect (
     return TRUE;
   }
 }
 
 /**
-   Disable NULL pointer detection
-*/
+  Disable NULL pointer detection.
+**/
 VOID
 DisableNullDetection (
   VOID
   )
 {
@@ -1778,12 +1778,12 @@ DisableNullDetection (
     DEBUG ((DEBUG_WARN, "!!! Page 0 is supposed to be disabled !!!\r\n"));
   }
 }
 
 /**
-   Enable NULL pointer detection
-*/
+   Enable NULL pointer detection.
+**/
 VOID
 EnableNullDetection (
   VOID
   )
 {
diff --git a/IntelFrameworkModulePkg/Csm/LegacyBiosDxe/LegacyBios.c b/IntelFrameworkModulePkg/Csm/LegacyBiosDxe/LegacyBios.c
index 3176a98..e009999 100644
--- a/IntelFrameworkModulePkg/Csm/LegacyBiosDxe/LegacyBios.c
+++ b/IntelFrameworkModulePkg/Csm/LegacyBiosDxe/LegacyBios.c
@@ -792,12 +792,12 @@ ToggleEndOfDxeStatus (
 // functions can be used to disable/enable NULL pointer detection before/after
 // accessing those memory.
 //
 
 /**
-   Enable NULL pointer detection
-*/
+   Enable NULL pointer detection.
+**/
 VOID
 EnableNullDetection (
   VOID
   )
 {
@@ -842,12 +842,12 @@ EnableNullDetection (
     ASSERT_EFI_ERROR (Status);
   }
 }
 
 /**
-   Disable NULL pointer detection
-*/
+   Disable NULL pointer detection.
+**/
 VOID
 DisableNullDetection (
   VOID
   )
 {
diff --git a/IntelFrameworkModulePkg/Csm/LegacyBiosDxe/LegacyBiosInterface.h b/IntelFrameworkModulePkg/Csm/LegacyBiosDxe/LegacyBiosInterface.h
index 20dfef3..86a3b09 100644
--- a/IntelFrameworkModulePkg/Csm/LegacyBiosDxe/LegacyBiosInterface.h
+++ b/IntelFrameworkModulePkg/Csm/LegacyBiosDxe/LegacyBiosInterface.h
@@ -1543,20 +1543,20 @@ EFI_STATUS
 LegacyBiosInstallVgaRom (
   IN  LEGACY_BIOS_INSTANCE            *Private
   );
 
 /**
-   Enable NULL pointer detection
-*/
+   Enable NULL pointer detection.
+**/
 VOID
 EnableNullDetection (
   VOID
   );
 
 /**
-   Disable NULL pointer detection
-*/
+   Disable NULL pointer detection.
+**/
 VOID
 DisableNullDetection (
   VOID
   );
 
-- 
1.9.5.msysgit.1

_______________________________________________
edk2-devel mailing list
edk2-devel@lists.01.org
https://lists.01.org/mailman/listinfo/edk2-devel
Re: [edk2] [patch 1/4] IntelFrameworkModulePkg/Csm: Refine coding style in comments
Posted by Wang, Jian J 8 years ago 

Reviewed-by: Jian J Wang <jian.j.wang@intel.com>


> -----Original Message-----
> From: Bi, Dandan
> Sent: Friday, October 20, 2017 9:00 AM
> To: edk2-devel@lists.01.org
> Cc: Wang, Jian J <jian.j.wang@intel.com>; Gao, Liming <liming.gao@intel.com>
> Subject: [patch 1/4] IntelFrameworkModulePkg/Csm: Refine coding style in
> comments
> 
> Make the comments follow Edk2 coding style:
> 1. Make the comments starts with /** and end with **/.
> 2. Make the comments descrition end with '.'
> 
> Cc: Jian J Wang <jian.j.wang@intel.com>
> Cc: Liming Gao <liming.gao@intel.com>
> Contributed-under: TianoCore Contribution Agreement 1.1
> Signed-off-by: Dandan Bi <dandan.bi@intel.com>
> ---
>  IntelFrameworkModulePkg/Csm/BiosThunk/KeyboardDxe/BiosKeyboard.c | 8
> ++++----
>  IntelFrameworkModulePkg/Csm/LegacyBiosDxe/LegacyBios.c           | 8 ++++----
>  IntelFrameworkModulePkg/Csm/LegacyBiosDxe/LegacyBiosInterface.h  | 8
> ++++----
>  3 files changed, 12 insertions(+), 12 deletions(-)
> 
> diff --git
> a/IntelFrameworkModulePkg/Csm/BiosThunk/KeyboardDxe/BiosKeyboard.c
> b/IntelFrameworkModulePkg/Csm/BiosThunk/KeyboardDxe/BiosKeyboard.c
> index d2224a2..ebf03d3 100644
> --- a/IntelFrameworkModulePkg/Csm/BiosThunk/KeyboardDxe/BiosKeyboard.c
> +++
> b/IntelFrameworkModulePkg/Csm/BiosThunk/KeyboardDxe/BiosKeyboard.c
> @@ -1731,12 +1731,12 @@ CheckKeyboardConnect (
>      return TRUE;
>    }
>  }
> 
>  /**
> -   Disable NULL pointer detection
> -*/
> +  Disable NULL pointer detection.
> +**/
>  VOID
>  DisableNullDetection (
>    VOID
>    )
>  {
> @@ -1778,12 +1778,12 @@ DisableNullDetection (
>      DEBUG ((DEBUG_WARN, "!!! Page 0 is supposed to be disabled !!!\r\n"));
>    }
>  }
> 
>  /**
> -   Enable NULL pointer detection
> -*/
> +   Enable NULL pointer detection.
> +**/
>  VOID
>  EnableNullDetection (
>    VOID
>    )
>  {
> diff --git a/IntelFrameworkModulePkg/Csm/LegacyBiosDxe/LegacyBios.c
> b/IntelFrameworkModulePkg/Csm/LegacyBiosDxe/LegacyBios.c
> index 3176a98..e009999 100644
> --- a/IntelFrameworkModulePkg/Csm/LegacyBiosDxe/LegacyBios.c
> +++ b/IntelFrameworkModulePkg/Csm/LegacyBiosDxe/LegacyBios.c
> @@ -792,12 +792,12 @@ ToggleEndOfDxeStatus (
>  // functions can be used to disable/enable NULL pointer detection before/after
>  // accessing those memory.
>  //
> 
>  /**
> -   Enable NULL pointer detection
> -*/
> +   Enable NULL pointer detection.
> +**/
>  VOID
>  EnableNullDetection (
>    VOID
>    )
>  {
> @@ -842,12 +842,12 @@ EnableNullDetection (
>      ASSERT_EFI_ERROR (Status);
>    }
>  }
> 
>  /**
> -   Disable NULL pointer detection
> -*/
> +   Disable NULL pointer detection.
> +**/
>  VOID
>  DisableNullDetection (
>    VOID
>    )
>  {
> diff --git
> a/IntelFrameworkModulePkg/Csm/LegacyBiosDxe/LegacyBiosInterface.h
> b/IntelFrameworkModulePkg/Csm/LegacyBiosDxe/LegacyBiosInterface.h
> index 20dfef3..86a3b09 100644
> --- a/IntelFrameworkModulePkg/Csm/LegacyBiosDxe/LegacyBiosInterface.h
> +++ b/IntelFrameworkModulePkg/Csm/LegacyBiosDxe/LegacyBiosInterface.h
> @@ -1543,20 +1543,20 @@ EFI_STATUS
>  LegacyBiosInstallVgaRom (
>    IN  LEGACY_BIOS_INSTANCE            *Private
>    );
> 
>  /**
> -   Enable NULL pointer detection
> -*/
> +   Enable NULL pointer detection.
> +**/
>  VOID
>  EnableNullDetection (
>    VOID
>    );
> 
>  /**
> -   Disable NULL pointer detection
> -*/
> +   Disable NULL pointer detection.
> +**/
>  VOID
>  DisableNullDetection (
>    VOID
>    );
> 
> --
> 1.9.5.msysgit.1

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

Patchew 2.1-devel-8c64711

© 2016 - 2025 Red Hat, Inc.