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=star.zeng@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 D3D5821159813 for ; Wed, 26 Sep 2018 18:50:33 -0700 (PDT) X-Amp-Result: SKIPPED(no attachment in message) X-Amp-File-Uploaded: False Received: from fmsmga006.fm.intel.com ([10.253.24.20]) by orsmga103.jf.intel.com with ESMTP/TLS/DHE-RSA-AES256-GCM-SHA384; 26 Sep 2018 18:50:32 -0700 X-ExtLoop1: 1 X-IronPort-AV: E=Sophos;i="5.54,308,1534834800"; d="scan'208";a="267031652" Received: from shwdeopenpsi068.ccr.corp.intel.com ([10.239.158.46]) by fmsmga006.fm.intel.com with ESMTP; 26 Sep 2018 18:49:58 -0700 From: Star Zeng To: edk2-devel@lists.01.org Cc: Star Zeng , Liming Gao , Ruiyu Ni , Jian J Wang Date: Thu, 27 Sep 2018 09:49:56 +0800 Message-Id: <1538012996-38760-1-git-send-email-star.zeng@intel.com> X-Mailer: git-send-email 2.7.0.windows.1 Subject: [PATCH] MdeModulePkg Variable: Fix comment typo 'end' to 'start' X-BeenThere: edk2-devel@lists.01.org X-Mailman-Version: 2.1.29 Precedence: list List-Id: EDK II Development List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , X-List-Received-Date: Thu, 27 Sep 2018 01:50:34 -0000 REF: https://bugzilla.tianocore.org/show_bug.cgi?id=1214 This patch only updates comment and function description, so has no functionality impact. This patch fixes comment typo 'end' to 'start' in GetStartPointer. GetStartPointer for PEI and DXE has aligned function description, but GetEndPointer does not. This patch also aligns GetEndPointer's function description for PEI and DXE. Cc: Liming Gao Cc: Ruiyu Ni Cc: Jian J Wang Contributed-under: TianoCore Contribution Agreement 1.1 Signed-off-by: Star Zeng --- MdeModulePkg/Universal/Variable/Pei/Variable.c | 14 +++++++++----- MdeModulePkg/Universal/Variable/RuntimeDxe/Variable.c | 2 +- 2 files changed, 10 insertions(+), 6 deletions(-) diff --git a/MdeModulePkg/Universal/Variable/Pei/Variable.c b/MdeModulePkg/Universal/Variable/Pei/Variable.c index 96a52f23d1c1..77b3eaeb210d 100644 --- a/MdeModulePkg/Universal/Variable/Pei/Variable.c +++ b/MdeModulePkg/Universal/Variable/Pei/Variable.c @@ -57,7 +57,7 @@ PeimInitializeVariableServices ( @param VarStoreHeader Pointer to the Variable Store Header. - @return Pointer to the first variable header + @return Pointer to the first variable header. **/ VARIABLE_HEADER * @@ -66,18 +66,22 @@ GetStartPointer ( ) { // - // The end of variable store + // The start of variable store // return (VARIABLE_HEADER *) HEADER_ALIGN (VarStoreHeader + 1); } /** - This code gets the pointer to the last variable memory pointer byte. - @param VarStoreHeader Pointer to the Variable Store Header. + Gets the pointer to the end of the variable storage area. + + This function gets pointer to the end of the variable storage + area, according to the input variable store header. + + @param VarStoreHeader Pointer to the Variable Store Header. - @return VARIABLE_HEADER* pointer to last unavailable Variable Header. + @return Pointer to the end of the variable storage area. **/ VARIABLE_HEADER * diff --git a/MdeModulePkg/Universal/Variable/RuntimeDxe/Variable.c b/MdeModulePkg/Universal/Variable/RuntimeDxe/Variable.c index 1ea2f84dda68..dc8622db8138 100644 --- a/MdeModulePkg/Universal/Variable/RuntimeDxe/Variable.c +++ b/MdeModulePkg/Universal/Variable/RuntimeDxe/Variable.c @@ -681,7 +681,7 @@ GetStartPointer ( ) { // - // The end of variable store. + // The start of variable store. // return (VARIABLE_HEADER *) HEADER_ALIGN (VarStoreHeader + 1); } -- 2.7.0.windows.1