public inbox for devel@edk2.groups.io
 help / color / mirror / Atom feed
From: Dandan Bi <dandan.bi@intel.com>
To: edk2-devel@lists.01.org
Cc: Ard Biesheuvel <ard.biesheuvel@linaro.org>,
	Liming Gao <liming.gao@intel.com>
Subject: [patch 2/2] MdePkg: Fix coding style issues
Date: Fri,  1 Feb 2019 14:02:00 +0800	[thread overview]
Message-ID: <20190201060200.40136-3-dandan.bi@intel.com> (raw)
In-Reply-To: <20190201060200.40136-1-dandan.bi@intel.com>

REF: https://bugzilla.tianocore.org/show_bug.cgi?id=1478

Fix issues that reported by Edk2 coding style check tool(ECC) that:
in Comment, <@param SystemTable> does NOT consistent with parameter
name MmSystemTable.

Cc: Ard Biesheuvel <ard.biesheuvel@linaro.org>
Cc: Liming Gao <liming.gao@intel.com>
Contributed-under: TianoCore Contribution Agreement 1.1
Signed-off-by: Dandan Bi <dandan.bi@intel.com>
---
 .../Library/StandaloneMmDriverEntryPoint.h       | 16 ++++++++--------
 .../StandaloneMmDriverEntryPoint.c               |  4 ++--
 .../StandaloneMmServicesTableLib.c               |  4 ++--
 3 files changed, 12 insertions(+), 12 deletions(-)

diff --git a/MdePkg/Include/Library/StandaloneMmDriverEntryPoint.h b/MdePkg/Include/Library/StandaloneMmDriverEntryPoint.h
index d618998622..fbc75add73 100644
--- a/MdePkg/Include/Library/StandaloneMmDriverEntryPoint.h
+++ b/MdePkg/Include/Library/StandaloneMmDriverEntryPoint.h
@@ -34,12 +34,12 @@ extern CONST UINT32                   _gMmRevision;
   is an error status, then ProcessLibraryDestructorList() must be called.
   The return value from ProcessModuleEntryPointList() is returned.
   If _gMmRevision is not zero and MmSystemTable->Hdr.Revision is
   less than _gMmRevision, then return EFI_INCOMPATIBLE_VERSION.
 
-  @param  ImageHandle  The image handle of the Standalone MM Driver.
-  @param  SystemTable  A pointer to the EFI System Table.
+  @param  ImageHandle    The image handle of the Standalone MM Driver.
+  @param  MmSystemTable  A pointer to the MM System Table.
 
   @retval  EFI_SUCCESS               The Standalone MM Driver exited normally.
   @retval  EFI_INCOMPATIBLE_VERSION  _gMmRevision is greater than
                                      MmSystemTable->Hdr.Revision.
   @retval  Other                     Return value from
@@ -66,12 +66,12 @@ _ModuleEntryPoint (
   tools and those build tools are responsible for collecting the set of library
   instances, determine which ones have constructors, and calling the library
   constructors in the proper order based upon each of the library instances own
   dependencies.
 
-  @param  ImageHandle  The image handle of the Standalone MM Driver.
-  @param  SystemTable  A pointer to the MM System Table.
+  @param  ImageHandle    The image handle of the Standalone MM Driver.
+  @param  MmSystemTable  A pointer to the MM System Table.
 
 **/
 VOID
 EFIAPI
 ProcessLibraryConstructorList (
@@ -92,12 +92,12 @@ ProcessLibraryConstructorList (
   This function is auto generated by build tools and those build tools are
   responsible for collecting the set of library instances, determine which ones
   have destructors, and calling the library destructors in the proper order
   based upon each of the library instances own dependencies.
 
-  @param  ImageHandle  The image handle of the Standalone MM Driver.
-  @param  SystemTable  A pointer to the MM System Table.
+  @param  ImageHandle    The image handle of the Standalone MM Driver.
+  @param  MmSystemTable  A pointer to the MM System Table.
 
 **/
 VOID
 EFIAPI
 ProcessLibraryDestructorList (
@@ -113,12 +113,12 @@ ProcessLibraryDestructorList (
   This function calls the set of module entry points.
   This function is auto generated by build tools and those build tools are
   responsible for collecting the module entry points and calling them in a
   specified order.
 
-  @param  ImageHandle  The image handle of the Standalone MM Driver.
-  @param  SystemTable  A pointer to the EFI System Table.
+  @param  ImageHandle    The image handle of the Standalone MM Driver.
+  @param  MmSystemTable  A pointer to the MM System Table.
 
   @retval  EFI_SUCCESS   The Standalone MM Driver executed normally.
   @retval  !EFI_SUCCESS  The Standalone MM Driver failed to execute normally.
 **/
 EFI_STATUS
diff --git a/MdePkg/Library/StandaloneMmDriverEntryPoint/StandaloneMmDriverEntryPoint.c b/MdePkg/Library/StandaloneMmDriverEntryPoint/StandaloneMmDriverEntryPoint.c
index 4fb494d8cb..b665233142 100644
--- a/MdePkg/Library/StandaloneMmDriverEntryPoint/StandaloneMmDriverEntryPoint.c
+++ b/MdePkg/Library/StandaloneMmDriverEntryPoint/StandaloneMmDriverEntryPoint.c
@@ -32,12 +32,12 @@ WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
   is an error status, then ProcessLibraryDestructorList() must be called.
   The return value from ProcessModuleEntryPointList() is returned.
   If _gMmRevision is not zero and SystemTable->Hdr.Revision is
   less than _gMmRevision, then return EFI_INCOMPATIBLE_VERSION.
 
-  @param  ImageHandle  The image handle of the Standalone MM Driver.
-  @param  SystemTable  A pointer to the EFI System Table.
+  @param  ImageHandle    The image handle of the Standalone MM Driver.
+  @param  MmSystemTable  A pointer to the MM System Table.
 
   @retval  EFI_SUCCESS               The Standalone MM Driver exited normally.
   @retval  EFI_INCOMPATIBLE_VERSION  _gMmRevision is greater than
                                      MmSystemTable->Hdr.Revision.
   @retval  Other                     Return value from
diff --git a/MdePkg/Library/StandaloneMmServicesTableLib/StandaloneMmServicesTableLib.c b/MdePkg/Library/StandaloneMmServicesTableLib/StandaloneMmServicesTableLib.c
index b870f25fcf..de7c980c7b 100644
--- a/MdePkg/Library/StandaloneMmServicesTableLib/StandaloneMmServicesTableLib.c
+++ b/MdePkg/Library/StandaloneMmServicesTableLib/StandaloneMmServicesTableLib.c
@@ -20,12 +20,12 @@
 EFI_MM_SYSTEM_TABLE   *gMmst             = NULL;
 
 /**
   The constructor function caches the pointer of the MM Services Table.
 
-  @param  ImageHandle   The firmware allocated handle for the EFI image.
-  @param  SystemTable   A pointer to the EFI System Table.
+  @param  ImageHandle     The firmware allocated handle for the EFI image.
+  @param  MmSystemTable   A pointer to the MM System Table.
 
   @retval EFI_SUCCESS   The constructor always returns EFI_SUCCESS.
 
 **/
 EFI_STATUS
-- 
2.18.0.windows.1



  parent reply	other threads:[~2019-02-01  6:02 UTC|newest]

Thread overview: 6+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2019-02-01  6:01 [patch 0/2] Fix coding style issues in MdeModulePkg and MdePkg Dandan Bi
2019-02-01  6:01 ` [patch 1/2] MdeModulePkg: Fix coding style issues Dandan Bi
2019-02-01  6:22   ` Wu, Hao A
2019-02-01  6:02 ` Dandan Bi [this message]
2019-02-01 10:27 ` [patch 0/2] Fix coding style issues in MdeModulePkg and MdePkg Ard Biesheuvel
2019-02-02 13:38   ` Gao, Liming

Reply instructions:

You may reply publicly to this message via plain-text email
using any one of the following methods:

* Save the following mbox file, import it into your mail client,
  and reply-to-list from there: mbox

  Avoid top-posting and favor interleaved quoting:
  https://en.wikipedia.org/wiki/Posting_style#Interleaved_style

* Reply using the --to, --cc, and --in-reply-to
  switches of git-send-email(1):

  git send-email \
    --in-reply-to=20190201060200.40136-3-dandan.bi@intel.com \
    --to=devel@edk2.groups.io \
    /path/to/YOUR_REPLY

  https://kernel.org/pub/software/scm/git/docs/git-send-email.html

* If your mail client supports setting the In-Reply-To header
  via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line before the message body.
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox