From: "Wang, Jian J" <jian.j.wang@intel.com>
To: "Bi, Dandan" <dandan.bi@intel.com>,
"edk2-devel@lists.01.org" <edk2-devel@lists.01.org>
Cc: "Dong, Eric" <eric.dong@intel.com>
Subject: Re: [patch 3/4] MdeModulePkg/DxeIplPeim: Refine coding style in function comments
Date: Mon, 23 Oct 2017 01:20:04 +0000 [thread overview]
Message-ID: <D827630B58408649ACB04F44C510003624CA3E5C@SHSMSX103.ccr.corp.intel.com> (raw)
In-Reply-To: <1508461193-5204-4-git-send-email-dandan.bi@intel.com>
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>; Dong, Eric <eric.dong@intel.com>
> Subject: [patch 3/4] MdeModulePkg/DxeIplPeim: Refine coding style in function
> comments
>
> Make the comments align with the function.
> And add some missing function comments.
>
> Cc: Jian J Wang <jian.j.wang@intel.com>
> Cc: Eric Dong <eric.dong@intel.com>
> Contributed-under: TianoCore Contribution Agreement 1.1
> Signed-off-by: Dandan Bi <dandan.bi@intel.com>
> ---
> MdeModulePkg/Core/DxeIplPeim/DxeIpl.h | 14 +++++++-------
> MdeModulePkg/Core/DxeIplPeim/X64/VirtualMemory.c | 15 +++++++++++----
> 2 files changed, 18 insertions(+), 11 deletions(-)
>
> diff --git a/MdeModulePkg/Core/DxeIplPeim/DxeIpl.h
> b/MdeModulePkg/Core/DxeIplPeim/DxeIpl.h
> index ecf1866..f3aabdb 100644
> --- a/MdeModulePkg/Core/DxeIplPeim/DxeIpl.h
> +++ b/MdeModulePkg/Core/DxeIplPeim/DxeIpl.h
> @@ -239,28 +239,28 @@ Decompress (
> OUT VOID **OutputBuffer,
> OUT UINTN *OutputSize
> );
>
> /**
> - Clear legacy memory located at the first 4K-page.
> + Clear legacy memory located at the first 4K-page.
>
> - This function traverses the whole HOB list to check if memory from 0 to 4095
> - exists and has not been allocated, and then clear it if so.
> + This function traverses the whole HOB list to check if memory from 0 to 4095
> + exists and has not been allocated, and then clear it if so.
>
> - @param HoStart The start of HobList passed to DxeCore.
> + @param HobStart The start of HobList passed to DxeCore.
>
> **/
> VOID
> ClearFirst4KPage (
> IN VOID *HobStart
> );
>
> /**
> - Return configure status of NULL pointer detection feature
> + Return configure status of NULL pointer detection feature.
>
> - @return TRUE NULL pointer detection feature is enabled
> - @return FALSE NULL pointer detection feature is disabled
> + @return TRUE NULL pointer detection feature is enabled
> + @return FALSE NULL pointer detection feature is disabled
> **/
> BOOLEAN
> IsNullDetectionEnabled (
> VOID
> );
> diff --git a/MdeModulePkg/Core/DxeIplPeim/X64/VirtualMemory.c
> b/MdeModulePkg/Core/DxeIplPeim/X64/VirtualMemory.c
> index a10dea2..29b6205 100644
> --- a/MdeModulePkg/Core/DxeIplPeim/X64/VirtualMemory.c
> +++ b/MdeModulePkg/Core/DxeIplPeim/X64/VirtualMemory.c
> @@ -30,16 +30,16 @@ WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY
> KIND, EITHER EXPRESS OR IMPLIED.
>
> #include "DxeIpl.h"
> #include "VirtualMemory.h"
>
> /**
> - Clear legacy memory located at the first 4K-page, if available.
> + Clear legacy memory located at the first 4K-page, if available.
>
> - This function traverses the whole HOB list to check if memory from 0 to 4095
> - exists and has not been allocated, and then clear it if so.
> + This function traverses the whole HOB list to check if memory from 0 to 4095
> + exists and has not been allocated, and then clear it if so.
>
> - @param HoStart The start of HobList passed to DxeCore.
> + @param HobStart The start of HobList passed to DxeCore.
>
> **/
> VOID
> ClearFirst4KPage (
> IN VOID *HobStart
> @@ -84,10 +84,17 @@ ClearFirst4KPage (
> }
>
> return;
> }
>
> +/**
> + Return configure status of NULL pointer detection feature.
> +
> + @return TRUE NULL pointer detection feature is enabled
> + @return FALSE NULL pointer detection feature is disabled
> +
> +**/
> BOOLEAN
> IsNullDetectionEnabled (
> VOID
> )
> {
> --
> 1.9.5.msysgit.1
next prev parent reply other threads:[~2017-10-23 1:16 UTC|newest]
Thread overview: 9+ messages / expand[flat|nested] mbox.gz Atom feed top
2017-10-20 0:59 [patch 0/4] Fix coding style issue Dandan Bi
2017-10-20 0:59 ` [patch 1/4] IntelFrameworkModulePkg/Csm: Refine coding style in comments Dandan Bi
2017-10-23 1:19 ` Wang, Jian J
2017-10-20 0:59 ` [patch 2/4] IntelFrameworkModule/LegacyBios: Avoid explicit comparison for BOOLEAN Dandan Bi
2017-10-23 1:19 ` Wang, Jian J
2017-10-20 0:59 ` [patch 3/4] MdeModulePkg/DxeIplPeim: Refine coding style in function comments Dandan Bi
2017-10-23 1:20 ` Wang, Jian J [this message]
2017-10-20 0:59 ` [patch 4/4] UefiCpuPkg/MtrrLib: Make comments align with function Dandan Bi
2017-10-20 2:08 ` Ni, Ruiyu
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=D827630B58408649ACB04F44C510003624CA3E5C@SHSMSX103.ccr.corp.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