From mboxrd@z Thu Jan 1 00:00:00 1970 Return-Path: Received-SPF: Pass (sender SPF authorized) identity=mailfrom; client-ip=134.134.136.65; helo=mga03.intel.com; envelope-from=jian.j.wang@intel.com; receiver=edk2-devel@lists.01.org Received: from mga03.intel.com (mga03.intel.com [134.134.136.65]) (using TLSv1.2 with cipher ECDHE-RSA-AES256-GCM-SHA384 (256/256 bits)) (No client certificate requested) by ml01.01.org (Postfix) with ESMTPS id 796FC2034CF70 for ; Sun, 22 Oct 2017 18:16:24 -0700 (PDT) Received: from fmsmga006.fm.intel.com ([10.253.24.20]) by orsmga103.jf.intel.com with ESMTP/TLS/DHE-RSA-AES256-GCM-SHA384; 22 Oct 2017 18:20:06 -0700 X-ExtLoop1: 1 X-IronPort-AV: E=Sophos;i="5.43,420,1503385200"; d="scan'208";a="166219291" Received: from fmsmsx104.amr.corp.intel.com ([10.18.124.202]) by fmsmga006.fm.intel.com with ESMTP; 22 Oct 2017 18:20:06 -0700 Received: from fmsmsx115.amr.corp.intel.com (10.18.116.19) by fmsmsx104.amr.corp.intel.com (10.18.124.202) with Microsoft SMTP Server (TLS) id 14.3.319.2; Sun, 22 Oct 2017 18:20:05 -0700 Received: from shsmsx101.ccr.corp.intel.com (10.239.4.153) by fmsmsx115.amr.corp.intel.com (10.18.116.19) with Microsoft SMTP Server (TLS) id 14.3.319.2; Sun, 22 Oct 2017 18:20:05 -0700 Received: from shsmsx103.ccr.corp.intel.com ([169.254.4.213]) by SHSMSX101.ccr.corp.intel.com ([169.254.1.159]) with mapi id 14.03.0319.002; Mon, 23 Oct 2017 09:20:04 +0800 From: "Wang, Jian J" To: "Bi, Dandan" , "edk2-devel@lists.01.org" CC: "Dong, Eric" Thread-Topic: [patch 3/4] MdeModulePkg/DxeIplPeim: Refine coding style in function comments Thread-Index: AQHTST7TCcNFNvXmM0uJxyyAB3RLvKLwp5jQ Date: Mon, 23 Oct 2017 01:20:04 +0000 Message-ID: References: <1508461193-5204-1-git-send-email-dandan.bi@intel.com> <1508461193-5204-4-git-send-email-dandan.bi@intel.com> In-Reply-To: <1508461193-5204-4-git-send-email-dandan.bi@intel.com> Accept-Language: en-US X-MS-Has-Attach: X-MS-TNEF-Correlator: x-titus-metadata-40: eyJDYXRlZ29yeUxhYmVscyI6IiIsIk1ldGFkYXRhIjp7Im5zIjoiaHR0cDpcL1wvd3d3LnRpdHVzLmNvbVwvbnNcL0ludGVsMyIsImlkIjoiOGQ5NzE4NTQtMzJiNS00YTk5LTllMzEtZTVmYjAxODczZjNhIiwicHJvcHMiOlt7Im4iOiJDVFBDbGFzc2lmaWNhdGlvbiIsInZhbHMiOlt7InZhbHVlIjoiQ1RQX0lDIn1dfV19LCJTdWJqZWN0TGFiZWxzIjpbXSwiVE1DVmVyc2lvbiI6IjE3LjIuNS4xOCIsIlRydXN0ZWRMYWJlbEhhc2giOiJtVGpGN1dcL053VkFoVDhDVWU5cVVJb3RMTmlFKzFNQm9ZU3BNNW5jdThjenhrTnB0TSttNjZtOTA0NngzVWJHaCJ9 x-ctpclassification: CTP_IC dlp-product: dlpe-windows dlp-version: 11.0.0.116 dlp-reaction: no-action x-originating-ip: [10.239.127.40] MIME-Version: 1.0 Subject: Re: [patch 3/4] MdeModulePkg/DxeIplPeim: Refine coding style in function comments X-BeenThere: edk2-devel@lists.01.org X-Mailman-Version: 2.1.22 Precedence: list List-Id: EDK II Development List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , X-List-Received-Date: Mon, 23 Oct 2017 01:16:24 -0000 Content-Language: en-US Content-Type: text/plain; charset="us-ascii" Content-Transfer-Encoding: quoted-printable Reviewed-by: Jian J Wang > -----Original Message----- > From: Bi, Dandan > Sent: Friday, October 20, 2017 9:00 AM > To: edk2-devel@lists.01.org > Cc: Wang, Jian J ; Dong, Eric > Subject: [patch 3/4] MdeModulePkg/DxeIplPeim: Refine coding style in func= tion > comments >=20 > Make the comments align with the function. > And add some missing function comments. >=20 > Cc: Jian J Wang > Cc: Eric Dong > Contributed-under: TianoCore Contribution Agreement 1.1 > Signed-off-by: Dandan Bi > --- > MdeModulePkg/Core/DxeIplPeim/DxeIpl.h | 14 +++++++------- > MdeModulePkg/Core/DxeIplPeim/X64/VirtualMemory.c | 15 +++++++++++---- > 2 files changed, 18 insertions(+), 11 deletions(-) >=20 > 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 > ); >=20 > /** > - Clear legacy memory located at the first 4K-page. > + Clear legacy memory located at the first 4K-page. >=20 > - 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 t= o 4095 > + exists and has not been allocated, and then clear it if so. >=20 > - @param HoStart The start of HobList passed to DxeCore. > + @param HobStart The start of HobList passed to DxeCore. >=20 > **/ > VOID > ClearFirst4KPage ( > IN VOID *HobStart > ); >=20 > /** > - Return configure status of NULL pointer detection feature > + Return configure status of NULL pointer detection feature. >=20 > - @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. >=20 > #include "DxeIpl.h" > #include "VirtualMemory.h" >=20 > /** > - Clear legacy memory located at the first 4K-page, if available. > + Clear legacy memory located at the first 4K-page, if available. >=20 > - 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 t= o 4095 > + exists and has not been allocated, and then clear it if so. >=20 > - @param HoStart The start of HobList passed to DxeCo= re. > + @param HobStart The start of HobList passed to DxeCor= e. >=20 > **/ > VOID > ClearFirst4KPage ( > IN VOID *HobStart > @@ -84,10 +84,17 @@ ClearFirst4KPage ( > } >=20 > return; > } >=20 > +/** > + 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