From: Dandan Bi <dandan.bi@intel.com>
To: edk2-devel@lists.01.org
Cc: Ard Biesheuvel <ard.biesheuvel@linaro.org>,
Jian J Wang <jian.j.wang@intel.com>, Hao Wu <hao.a.wu@intel.com>
Subject: [patch 1/2] MdeModulePkg: Fix coding style issues
Date: Fri, 1 Feb 2019 14:01:59 +0800 [thread overview]
Message-ID: <20190201060200.40136-2-dandan.bi@intel.com> (raw)
In-Reply-To: <20190201060200.40136-1-dandan.bi@intel.com>
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/FaultTolerantWriteSmmCommon.h b/MdeModulePkg/Universal/FaultTolerantWriteDxe/FaultTolerantWriteSmmCommon.h
index 61293ca864..cf1aef7ca4 100644
--- a/MdeModulePkg/Universal/FaultTolerantWriteDxe/FaultTolerantWriteSmmCommon.h
+++ b/MdeModulePkg/Universal/FaultTolerantWriteDxe/FaultTolerantWriteSmmCommon.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/FaultTolerantWriteStandaloneMm.c b/MdeModulePkg/Universal/FaultTolerantWriteDxe/FaultTolerantWriteStandaloneMm.c
index 8a4ea5b476..c2aa501465 100644
--- a/MdeModulePkg/Universal/FaultTolerantWriteDxe/FaultTolerantWriteStandaloneMm.c
+++ b/MdeModulePkg/Universal/FaultTolerantWriteDxe/FaultTolerantWriteStandaloneMm.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/FaultTolerantWriteTraditionalMm.c b/MdeModulePkg/Universal/FaultTolerantWriteDxe/FaultTolerantWriteTraditionalMm.c
index 0981c3c2a9..7c76e1f756 100644
--- a/MdeModulePkg/Universal/FaultTolerantWriteDxe/FaultTolerantWriteTraditionalMm.c
+++ b/MdeModulePkg/Universal/FaultTolerantWriteDxe/FaultTolerantWriteTraditionalMm.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.
**/
VOID
VariableNotifySmmWriteReady (
VOID
)
--
2.18.0.windows.1
next prev 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 ` Dandan Bi [this message]
2019-02-01 6:22 ` [patch 1/2] MdeModulePkg: Fix coding style issues Wu, Hao A
2019-02-01 6:02 ` [patch 2/2] MdePkg: " Dandan Bi
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-2-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