Re: [patch 1/2] MdeModulePkg: Fix coding style issues

["Wu, Hao A" <hao.a.wu@intel.com>]

> -----Original Message-----
> From: Bi, Dandan
> Sent: Friday, February 01, 2019 2:02 PM
> To: edk2-devel@lists.01.org
> Cc: Ard Biesheuvel; Wang, Jian J; Wu, Hao A
> Subject: [patch 1/2] MdeModulePkg: Fix coding style issues
> 
> REF: https://bugzilla.tianocore.org/show_bug.cgi?id=1479
> 
> Fix issues that reported by Edk2 coding style check tool(ECC) that:
> Comment description should end with period '.'
> 
> Cc: Ard Biesheuvel <ard.biesheuvel@linaro.org>
> Cc: Jian J Wang <jian.j.wang@intel.com>
> Cc: Hao Wu <hao.a.wu@intel.com>
> Contributed-under: TianoCore Contribution Agreement 1.1
> Signed-off-by: Dandan Bi <dandan.bi@intel.com>
> ---
>  .../FaultTolerantWriteDxe/FaultTolerantWriteSmmCommon.h     | 4 ++--
>  .../FaultTolerantWriteDxe/FaultTolerantWriteStandaloneMm.c  | 2 +-
>  .../FaultTolerantWriteDxe/FaultTolerantWriteTraditionalMm.c | 2 +-
>  .../Universal/Variable/RuntimeDxe/PrivilegePolymorphic.h    | 4 ++--
>  .../Universal/Variable/RuntimeDxe/VariableStandaloneMm.c    | 6 +++---
>  .../Universal/Variable/RuntimeDxe/VariableTraditionalMm.c   | 4 ++--
>  6 files changed, 11 insertions(+), 11 deletions(-)
> 
> diff --git
> a/MdeModulePkg/Universal/FaultTolerantWriteDxe/FaultTolerantWriteSmmCo
> mmon.h
> b/MdeModulePkg/Universal/FaultTolerantWriteDxe/FaultTolerantWriteSmmCo
> mmon.h
> index 61293ca864..cf1aef7ca4 100644
> ---
> a/MdeModulePkg/Universal/FaultTolerantWriteDxe/FaultTolerantWriteSmmCo
> mmon.h
> +++
> b/MdeModulePkg/Universal/FaultTolerantWriteDxe/FaultTolerantWriteSmmCo
> mmon.h
> @@ -76,11 +76,11 @@ typedef struct {
>    BOOLEAN                               Complete;
>    UINT8                                 Data[1];
>  } SMM_FTW_GET_LAST_WRITE_HEADER;
> 
>  /**
> -  Shared entry point of the module
> +  Shared entry point of the module.
> 
>    @retval EFI_SUCCESS           The initialization finished successfully.
>    @retval EFI_OUT_OF_RESOURCES  Allocate memory error
>    @retval EFI_INVALID_PARAMETER Workspace or Spare block does not exist
> 
> @@ -107,11 +107,11 @@ FtwSmmIsBufferOutsideSmmValid (
>    IN EFI_PHYSICAL_ADDRESS  Buffer,
>    IN UINT64                Length
>    );
> 
>  /**
> -  Notify the system that the SMM FTW driver is ready
> +  Notify the system that the SMM FTW driver is ready.
>  **/
>  VOID
>  FtwNotifySmmReady (
>    VOID
>    );
> diff --git
> a/MdeModulePkg/Universal/FaultTolerantWriteDxe/FaultTolerantWriteStandal
> oneMm.c
> b/MdeModulePkg/Universal/FaultTolerantWriteDxe/FaultTolerantWriteStandal
> oneMm.c
> index 8a4ea5b476..c2aa501465 100644
> ---
> a/MdeModulePkg/Universal/FaultTolerantWriteDxe/FaultTolerantWriteStandal
> oneMm.c
> +++
> b/MdeModulePkg/Universal/FaultTolerantWriteDxe/FaultTolerantWriteStandal
> oneMm.c
> @@ -63,11 +63,11 @@ FtwCalculateCrc32 (
>  {
>    return CalculateCrc32 (Buffer, Length);
>  }
> 
>  /**
> -  Notify the system that the SMM FTW driver is ready
> +  Notify the system that the SMM FTW driver is ready.
>  **/
>  VOID
>  FtwNotifySmmReady (
>    VOID
>    )
> diff --git
> a/MdeModulePkg/Universal/FaultTolerantWriteDxe/FaultTolerantWriteTraditi
> onalMm.c
> b/MdeModulePkg/Universal/FaultTolerantWriteDxe/FaultTolerantWriteTraditi
> onalMm.c
> index 0981c3c2a9..7c76e1f756 100644
> ---
> a/MdeModulePkg/Universal/FaultTolerantWriteDxe/FaultTolerantWriteTraditi
> onalMm.c
> +++
> b/MdeModulePkg/Universal/FaultTolerantWriteDxe/FaultTolerantWriteTraditi
> onalMm.c
> @@ -70,11 +70,11 @@ FtwCalculateCrc32 (
> 
>    return ReturnValue;
>  }
> 
>  /**
> -  Notify the system that the SMM FTW driver is ready
> +  Notify the system that the SMM FTW driver is ready.
>  **/
>  VOID
>  FtwNotifySmmReady (
>    VOID
>    )
> diff --git
> a/MdeModulePkg/Universal/Variable/RuntimeDxe/PrivilegePolymorphic.h
> b/MdeModulePkg/Universal/Variable/RuntimeDxe/PrivilegePolymorphic.h
> index 0a886558f4..9b294e6b36 100644
> --- a/MdeModulePkg/Universal/Variable/RuntimeDxe/PrivilegePolymorphic.h
> +++ b/MdeModulePkg/Universal/Variable/RuntimeDxe/PrivilegePolymorphic.h
> @@ -96,19 +96,19 @@ VOID
>  VariableSpeculationBarrier (
>    VOID
>    );
> 
>  /**
> -  Notify the system that the SMM variable driver is ready
> +  Notify the system that the SMM variable driver is ready.
>  **/
>  VOID
>  VariableNotifySmmReady (
>    VOID
>    );
> 
>  /**
> -  Notify the system that the SMM variable write driver is ready
> +  Notify the system that the SMM variable write driver is ready.
>  **/
>  VOID
>  VariableNotifySmmWriteReady (
>    VOID
>    );
> diff --git
> a/MdeModulePkg/Universal/Variable/RuntimeDxe/VariableStandaloneMm.c
> b/MdeModulePkg/Universal/Variable/RuntimeDxe/VariableStandaloneMm.c
> index 1e87ccfb5d..2eed038054 100644
> ---
> a/MdeModulePkg/Universal/Variable/RuntimeDxe/VariableStandaloneMm.c
> +++
> b/MdeModulePkg/Universal/Variable/RuntimeDxe/VariableStandaloneMm.c
> @@ -36,31 +36,31 @@ VariableSmmIsBufferOutsideSmmValid (
>  {
>    return TRUE;
>  }
> 
>  /**
> -  Notify the system that the SMM variable driver is ready
> +  Notify the system that the SMM variable driver is ready.
>  **/
>  VOID
>  VariableNotifySmmReady (
>    VOID
>    )
>  {
>  }
> 
>  /**
> -  Notify the system that the SMM variable write driver is ready
> +  Notify the system that the SMM variable write driver is ready.
>  **/
>  VOID
>  VariableNotifySmmWriteReady (
>    VOID
>    )
>  {
>  }
> 
>  /**
> -  Variable service MM driver entry point
> +  Variable service MM driver entry point.
> 
>    @param[in] ImageHandle    A handle for the image that is initializing this
>                              driver
>    @param[in] MmSystemTable  A pointer to the MM system table
> 
> diff --git
> a/MdeModulePkg/Universal/Variable/RuntimeDxe/VariableTraditionalMm.c
> b/MdeModulePkg/Universal/Variable/RuntimeDxe/VariableTraditionalMm.c
> index 84f2d12b58..42e2c63c3a 100644
> ---
> a/MdeModulePkg/Universal/Variable/RuntimeDxe/VariableTraditionalMm.c
> +++
> b/MdeModulePkg/Universal/Variable/RuntimeDxe/VariableTraditionalMm.c
> @@ -38,11 +38,11 @@ VariableSmmIsBufferOutsideSmmValid (
>  {
>    return SmmIsBufferOutsideSmmValid (Buffer, Length);
>  }
> 
>  /**
> -  Notify the system that the SMM variable driver is ready
> +  Notify the system that the SMM variable driver is ready.
>  **/
>  VOID
>  VariableNotifySmmReady (
>    VOID
>    )
> @@ -59,11 +59,11 @@ VariableNotifySmmReady (
>                    );
>    ASSERT_EFI_ERROR (Status);
>  }
> 
>  /**
> -  Notify the system that the SMM variable write driver is ready
> +  Notify the system that the SMM variable write driver is ready.

Reviewed-by: Hao Wu <hao.a.wu@intel.com>

Best Regards,
Hao Wu

>  **/
>  VOID
>  VariableNotifySmmWriteReady (
>    VOID
>    )
> --
> 2.18.0.windows.1