From mboxrd@z Thu Jan 1 00:00:00 1970 Return-Path: Received: from smtp.nue.novell.com (smtp.nue.novell.com [195.135.221.5]) (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 B2B7981D81 for ; Sun, 13 Nov 2016 20:04:02 -0800 (PST) Received: from nwb-ext-pat.microfocus.com ([10.120.13.103]) by smtp.nue.novell.com with ESMTP (TLS encrypted); Mon, 14 Nov 2016 05:04:05 +0100 Received: from GaryWorkstation (nwb-a10-snat.microfocus.com [10.120.13.201]) by nwb-ext-pat.microfocus.com with ESMTP (TLS encrypted); Mon, 14 Nov 2016 04:03:49 +0000 Date: Mon, 14 Nov 2016 12:03:43 +0800 From: Gary Lin To: "Zhang, Chao B" Cc: "edk2-devel@lists.01.org" Message-ID: <20161114040343.dtiw7wzqybrvgt4s@GaryWorkstation> References: <20161019070138.16424-1-glin@suse.com> <20161019070138.16424-30-glin@suse.com> MIME-Version: 1.0 In-Reply-To: User-Agent: Mutt/1.6.2 (2016-07-01) Subject: Re: [PATCH 29/33] SecurityPkg: Fix typos in comments X-BeenThere: edk2-devel@lists.01.org X-Mailman-Version: 2.1.21 Precedence: list List-Id: EDK II Development List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , X-List-Received-Date: Mon, 14 Nov 2016 04:04:03 -0000 Content-Type: text/plain; charset=us-ascii Content-Disposition: inline On Mon, Nov 14, 2016 at 03:12:16AM +0000, Zhang, Chao B wrote: > Hi Gary: > I see some warnings while running PatchChecy.py with this patch. > Please help to update the patch, run PatchCheck.py(BaseTools/Scripts) & re-send the patch. > Hi Chao, PatchCheck.py showed this: The commit message format passed all checks. Code format is not valid: * EFI_D_ERROR was used, but DEBUG_ERROR is now recommended File: SecurityPkg/Tcg/Tcg2Dxe/Tcg2Dxe.c Line: DEBUG ((EFI_D_ERROR, "Separator Event not Measured. Error!\n")); * EFI_D_ERROR was used, but DEBUG_ERROR is now recommended File: SecurityPkg/Tcg/TcgDxe/TcgDxe.c Line: DEBUG ((EFI_D_ERROR, "Separator Event not Measured. Error!\n")); * EFI_D_ERROR was used, but DEBUG_ERROR is now recommended File: SecurityPkg/Tcg/TrEEDxe/TrEEDxe.c Line: DEBUG ((EFI_D_ERROR, "Separator Event not Measured. Error!\n")); My patch only fixes typos (Seperator -> Separator) and I tried to avoid any functional change. I found that EFI_D_ERROR is widely used in SecurityPkg and it'd be better to convert all EFI_D_ERROR into DEBUG_ERROR in another patch. What do you think? Cheers, Gary Lin > > > > > Thanks & Best regards > Chao Zhang > > > -----Original Message----- > From: Gary Lin [mailto:glin@suse.com] > Sent: Wednesday, October 19, 2016 3:02 PM > To: edk2-devel@lists.01.org > Cc: Zhang, Chao B > Subject: [PATCH 29/33] SecurityPkg: Fix typos in comments > > - intialized -> initialized > - TURE -> TRUE > - successull -> successfully > - hanlder -> handler > - funciton -> function > - Seperator -> Separator > - Sumbit -> Submit > > Cc: Chao Zhang > Contributed-under: TianoCore Contribution Agreement 1.0 > Signed-off-by: Gary Lin > --- > SecurityPkg/Hash2DxeCrypto/Hash2DxeCrypto.c | 2 +- > SecurityPkg/Include/Library/TcgPpVendorLib.h | 4 ++-- > SecurityPkg/Include/Library/TcgStorageOpalLib.h | 2 +- > SecurityPkg/Include/Library/TrEEPpVendorLib.h | 4 ++-- > SecurityPkg/Library/DxeDeferImageLoadLib/DxeDeferImageLoadLib.c | 6 +++--- > SecurityPkg/Library/DxeRsa2048Sha256GuidedSectionExtractLib/DxeRsa2048Sha256GuidedSectionExtractLib.c | 2 +- > SecurityPkg/Library/PeiRsa2048Sha256GuidedSectionExtractLib/PeiRsa2048Sha256GuidedSectionExtractLib.c | 2 +- > SecurityPkg/Library/TcgStorageCoreLib/TcgStorageUtil.c | 2 +- > SecurityPkg/Library/TcgStorageOpalLib/TcgStorageOpalCore.c | 2 +- > SecurityPkg/Tcg/Opal/OpalPasswordDxe/OpalDriver.c | 2 +- > SecurityPkg/Tcg/Tcg2Dxe/Tcg2Dxe.c | 2 +- > SecurityPkg/Tcg/TcgDxe/TcgDxe.c | 2 +- > SecurityPkg/Tcg/TrEEDxe/TrEEDxe.c | 2 +- > SecurityPkg/UserIdentification/UserProfileManagerDxe/ModifyIdentityPolicy.c | 2 +- > SecurityPkg/UserIdentification/UserProfileManagerDxe/UserProfileManager.h | 2 +- > 15 files changed, 19 insertions(+), 19 deletions(-) > > diff --git a/SecurityPkg/Hash2DxeCrypto/Hash2DxeCrypto.c b/SecurityPkg/Hash2DxeCrypto/Hash2DxeCrypto.c > index ab34de7..93e3273 100644 > --- a/SecurityPkg/Hash2DxeCrypto/Hash2DxeCrypto.c > +++ b/SecurityPkg/Hash2DxeCrypto/Hash2DxeCrypto.c > @@ -64,7 +64,7 @@ BOOLEAN > > This function performs Hash digest on a data buffer of the specified size. > It can be called multiple times to compute the digest of long or discontinuous data streams. > - Hash context should be already correctly intialized by HashInit(), and should not be finalized > + Hash context should be already correctly initialized by HashInit(), and should not be finalized > by HashFinal(). Behavior with invalid context is undefined. > > If HashContext is NULL, then return FALSE. > diff --git a/SecurityPkg/Include/Library/TcgPpVendorLib.h b/SecurityPkg/Include/Library/TcgPpVendorLib.h > index 08b3690..284aa9e 100644 > --- a/SecurityPkg/Include/Library/TcgPpVendorLib.h > +++ b/SecurityPkg/Include/Library/TcgPpVendorLib.h > @@ -42,8 +42,8 @@ WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED. > #define TCG_PP_OPERATION_RESPONSE_BIOS_FAILURE 0xFFFFFFF1 > > // > -// The return code for Sumbit TPM Request to Pre-OS Environment > -// and Sumbit TPM Request to Pre-OS Environment 2 > +// The return code for Submit TPM Request to Pre-OS Environment > +// and Submit TPM Request to Pre-OS Environment 2 > // > #define TCG_PP_SUBMIT_REQUEST_TO_PREOS_SUCCESS 0 > #define TCG_PP_SUBMIT_REQUEST_TO_PREOS_NOT_IMPLEMENTED 1 > diff --git a/SecurityPkg/Include/Library/TcgStorageOpalLib.h b/SecurityPkg/Include/Library/TcgStorageOpalLib.h > index 108affc..9b64a8e 100644 > --- a/SecurityPkg/Include/Library/TcgStorageOpalLib.h > +++ b/SecurityPkg/Include/Library/TcgStorageOpalLib.h > @@ -290,7 +290,7 @@ OpalGlobalLockingRangeGenKey( > /** > > The function updates the ReadLocked and WriteLocked columns of the Global Locking Range. > - This funciton is required for a user1 authority, since a user1 authority shall only have access to ReadLocked and WriteLocked columns > + This function is required for a user1 authority, since a user1 authority shall only have access to ReadLocked and WriteLocked columns > (not ReadLockEnabled and WriteLockEnabled columns). > > @param[in] LockingSpSession OPAL_SESSION with OPAL_UID_LOCKING_SP to generate key > diff --git a/SecurityPkg/Include/Library/TrEEPpVendorLib.h b/SecurityPkg/Include/Library/TrEEPpVendorLib.h > index d3a0767..f0dcfd9 100644 > --- a/SecurityPkg/Include/Library/TrEEPpVendorLib.h > +++ b/SecurityPkg/Include/Library/TrEEPpVendorLib.h > @@ -45,8 +45,8 @@ WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED. > #define TREE_PP_OPERATION_RESPONSE_BIOS_FAILURE 0xFFFFFFF1 > > // > -// The return code for Sumbit TPM Request to Pre-OS Environment > -// and Sumbit TPM Request to Pre-OS Environment 2 > +// The return code for Submit TPM Request to Pre-OS Environment > +// and Submit TPM Request to Pre-OS Environment 2 > // > #define TREE_PP_SUBMIT_REQUEST_TO_PREOS_SUCCESS 0 > #define TREE_PP_SUBMIT_REQUEST_TO_PREOS_NOT_IMPLEMENTED 1 > diff --git a/SecurityPkg/Library/DxeDeferImageLoadLib/DxeDeferImageLoadLib.c b/SecurityPkg/Library/DxeDeferImageLoadLib/DxeDeferImageLoadLib.c > index 142b546..02a87f9 100644 > --- a/SecurityPkg/Library/DxeDeferImageLoadLib/DxeDeferImageLoadLib.c > +++ b/SecurityPkg/Library/DxeDeferImageLoadLib/DxeDeferImageLoadLib.c > @@ -469,7 +469,7 @@ Done: > @param[in] DevicePath Points to device path. > @param[in] AccessType The type of user access control. > > - @retval TURE The DevicePath is in the specified List. > + @retval TRUE The DevicePath is in the specified List. > @retval FALSE The DevicePath is not in the specified List. > > **/ > @@ -512,7 +512,7 @@ IsDevicePathInList ( > > @param[in] DevicePath Points to device path > > - @retval TURE The image pointed by DevicePath is permitted to load. > + @retval TRUE The image pointed by DevicePath is permitted to load. > @retval FALSE The image pointed by DevicePath is forbidden to load. > > **/ > @@ -545,7 +545,7 @@ VerifyDevicePath ( > > @param[in] DevicePath Points to device path. > > - @retval TURE The image pointed by DevicePath is a boot option. > + @retval TRUE The image pointed by DevicePath is a boot option. > @retval FALSE The image pointed by DevicePath is not a boot option. > > **/ > diff --git a/SecurityPkg/Library/DxeRsa2048Sha256GuidedSectionExtractLib/DxeRsa2048Sha256GuidedSectionExtractLib.c b/SecurityPkg/Library/DxeRsa2048Sha256GuidedSectionExtractLib/DxeRsa2048Sha256GuidedSectionExtractLib.c > index 5f5d242..39768fb 100644 > --- a/SecurityPkg/Library/DxeRsa2048Sha256GuidedSectionExtractLib/DxeRsa2048Sha256GuidedSectionExtractLib.c > +++ b/SecurityPkg/Library/DxeRsa2048Sha256GuidedSectionExtractLib/DxeRsa2048Sha256GuidedSectionExtractLib.c > @@ -59,7 +59,7 @@ CONST UINT8 mRsaE[] = { 0x01, 0x00, 0x01 }; > @param SectionAttribute The attribute of the input guided section. > > @retval EFI_SUCCESS The size of destination buffer, the size of scratch buffer and > - the attribute of the input section are successull retrieved. > + the attribute of the input section are successfully retrieved. > @retval EFI_INVALID_PARAMETER The GUID in InputSection does not match this instance guid. > > **/ > diff --git a/SecurityPkg/Library/PeiRsa2048Sha256GuidedSectionExtractLib/PeiRsa2048Sha256GuidedSectionExtractLib.c b/SecurityPkg/Library/PeiRsa2048Sha256GuidedSectionExtractLib/PeiRsa2048Sha256GuidedSectionExtractLib.c > index 4733703..ba1c700 100644 > --- a/SecurityPkg/Library/PeiRsa2048Sha256GuidedSectionExtractLib/PeiRsa2048Sha256GuidedSectionExtractLib.c > +++ b/SecurityPkg/Library/PeiRsa2048Sha256GuidedSectionExtractLib/PeiRsa2048Sha256GuidedSectionExtractLib.c > @@ -57,7 +57,7 @@ CONST UINT8 mRsaE[] = { 0x01, 0x00, 0x01 }; > @param SectionAttribute The attribute of the input guided section. > > @retval EFI_SUCCESS The size of destination buffer, the size of scratch buffer and > - the attribute of the input section are successull retrieved. > + the attribute of the input section are successfully retrieved. > @retval EFI_INVALID_PARAMETER The GUID in InputSection does not match this instance guid. > > **/ > diff --git a/SecurityPkg/Library/TcgStorageCoreLib/TcgStorageUtil.c b/SecurityPkg/Library/TcgStorageCoreLib/TcgStorageUtil.c > index 30808cd..286f5b6 100644 > --- a/SecurityPkg/Library/TcgStorageCoreLib/TcgStorageUtil.c > +++ b/SecurityPkg/Library/TcgStorageCoreLib/TcgStorageUtil.c > @@ -881,7 +881,7 @@ TcgIsProtocolSupported( > > @param Discovery > > - @retval TURE if lock, FALSE if not lock. > + @retval TRUE if lock, FALSE if not lock. > **/ > BOOLEAN > EFIAPI > diff --git a/SecurityPkg/Library/TcgStorageOpalLib/TcgStorageOpalCore.c b/SecurityPkg/Library/TcgStorageOpalLib/TcgStorageOpalCore.c > index a0eac33..90cc51a 100644 > --- a/SecurityPkg/Library/TcgStorageOpalLib/TcgStorageOpalCore.c > +++ b/SecurityPkg/Library/TcgStorageOpalLib/TcgStorageOpalCore.c > @@ -1055,7 +1055,7 @@ OpalGlobalLockingRangeGenKey( > /** > > The function updates the ReadLocked and WriteLocked columns of the Global Locking Range. > - This funciton is required for a user1 authority, since a user1 authority shall only have access to ReadLocked and WriteLocked columns > + This function is required for a user1 authority, since a user1 authority shall only have access to ReadLocked and WriteLocked columns > (not ReadLockEnabled and WriteLockEnabled columns). > > @param[in] LockingSpSession OPAL_SESSION with OPAL_UID_LOCKING_SP to generate key > diff --git a/SecurityPkg/Tcg/Opal/OpalPasswordDxe/OpalDriver.c b/SecurityPkg/Tcg/Opal/OpalPasswordDxe/OpalDriver.c > index 9bf1ced..bd12d5a 100644 > --- a/SecurityPkg/Tcg/Opal/OpalPasswordDxe/OpalDriver.c > +++ b/SecurityPkg/Tcg/Opal/OpalPasswordDxe/OpalDriver.c > @@ -406,7 +406,7 @@ OpalDriverGetDeviceList( > ReadyToBoot callback to send BlockSid command. > > @param Event Pointer to this event > - @param Context Event hanlder private Data > + @param Context Event handler private Data > > **/ > VOID > diff --git a/SecurityPkg/Tcg/Tcg2Dxe/Tcg2Dxe.c b/SecurityPkg/Tcg/Tcg2Dxe/Tcg2Dxe.c > index db8d662..804929e 100644 > --- a/SecurityPkg/Tcg/Tcg2Dxe/Tcg2Dxe.c > +++ b/SecurityPkg/Tcg/Tcg2Dxe/Tcg2Dxe.c > @@ -2073,7 +2073,7 @@ OnReadyToBoot ( > for (PcrIndex = 0; PcrIndex < 7; PcrIndex++) { > Status = MeasureSeparatorEvent (PcrIndex); > if (EFI_ERROR (Status)) { > - DEBUG ((EFI_D_ERROR, "Seperator Event not Measured. Error!\n")); > + DEBUG ((EFI_D_ERROR, "Separator Event not Measured. Error!\n")); > } > } > > diff --git a/SecurityPkg/Tcg/TcgDxe/TcgDxe.c b/SecurityPkg/Tcg/TcgDxe/TcgDxe.c > index 0d7e32a..3e6d87b 100644 > --- a/SecurityPkg/Tcg/TcgDxe/TcgDxe.c > +++ b/SecurityPkg/Tcg/TcgDxe/TcgDxe.c > @@ -1160,7 +1160,7 @@ OnReadyToBoot ( > for (PcrIndex = 0; PcrIndex < 8; PcrIndex++) { > Status = MeasureSeparatorEvent (PcrIndex); > if (EFI_ERROR (Status)) { > - DEBUG ((EFI_D_ERROR, "Seperator Event not Measured. Error!\n")); > + DEBUG ((EFI_D_ERROR, "Separator Event not Measured. Error!\n")); > } > } > > diff --git a/SecurityPkg/Tcg/TrEEDxe/TrEEDxe.c b/SecurityPkg/Tcg/TrEEDxe/TrEEDxe.c > index fb69fa1..fa51b64 100644 > --- a/SecurityPkg/Tcg/TrEEDxe/TrEEDxe.c > +++ b/SecurityPkg/Tcg/TrEEDxe/TrEEDxe.c > @@ -1500,7 +1500,7 @@ OnReadyToBoot ( > for (PcrIndex = 0; PcrIndex < 7; PcrIndex++) { > Status = MeasureSeparatorEvent (PcrIndex); > if (EFI_ERROR (Status)) { > - DEBUG ((EFI_D_ERROR, "Seperator Event not Measured. Error!\n")); > + DEBUG ((EFI_D_ERROR, "Separator Event not Measured. Error!\n")); > } > } > > diff --git a/SecurityPkg/UserIdentification/UserProfileManagerDxe/ModifyIdentityPolicy.c b/SecurityPkg/UserIdentification/UserProfileManagerDxe/ModifyIdentityPolicy.c > index 9f157f8..8382744 100644 > --- a/SecurityPkg/UserIdentification/UserProfileManagerDxe/ModifyIdentityPolicy.c > +++ b/SecurityPkg/UserIdentification/UserProfileManagerDxe/ModifyIdentityPolicy.c > @@ -409,7 +409,7 @@ CheckNewIdentityPolicy ( > /** > Save the identity policy and update UI with it. > > - This funciton will verify the new identity policy, in current implementation, > + This function will verify the new identity policy, in current implementation, > the identity policy can be: T, P & P & P & ..., P | P | P | ... > Here, "T" means "True", "P" means "Credential Provider", "&" means "and", "|" means "or". > Other identity policies are not supported. > diff --git a/SecurityPkg/UserIdentification/UserProfileManagerDxe/UserProfileManager.h b/SecurityPkg/UserIdentification/UserProfileManagerDxe/UserProfileManager.h > index afa420e..6491dc2 100644 > --- a/SecurityPkg/UserIdentification/UserProfileManagerDxe/UserProfileManager.h > +++ b/SecurityPkg/UserIdentification/UserProfileManagerDxe/UserProfileManager.h > @@ -254,7 +254,7 @@ AddIdentityPolicyItem ( > /** > Save the identity policy and update UI with it. > > - This funciton will verify the new identity policy, in current implementation, > + This function will verify the new identity policy, in current implementation, > the identity policy can be: T, P & P & P & ..., P | P | P | ... > Here, "T" means "True", "P" means "Credential Provider", "&" means "and", "|" means "or". > Other identity policies are not supported. > -- > 2.10.1 > > _______________________________________________ > edk2-devel mailing list > edk2-devel@lists.01.org > https://lists.01.org/mailman/listinfo/edk2-devel >