From c1d8b697cf22861b71833b87609a52b436960308 Mon Sep 17 00:00:00 2001 From: Antoine Coeur Date: Fri, 7 Feb 2020 02:07:37 +0100 Subject: [PATCH] MdePkg/Library/Dxe: Fix various typos Fix various typos in documentation, comments and strings, and remove the duplicated 'the'. Cc: Michael D Kinney Cc: Liming Gao Signed-off-by: Antoine Coeur Reviewed-by: Philippe Mathieu-Daude Reviewed-by: Michael D Kinney Reviewed-by: Liming Gao Signed-off-by: Philippe Mathieu-Daude Message-Id: <20200207010831.9046-25-philmd@redhat.com> --- MdePkg/Include/Library/DxeServicesLib.h | 2 +- .../DxeExtractGuidedSectionLib.c | 10 +++++----- MdePkg/Library/DxeHobLib/HobLib.c | 2 +- MdePkg/Library/DxeIoLibCpuIo2/IoLib.c | 2 +- MdePkg/Library/DxePcdLib/DxePcdLib.inf | 2 +- MdePkg/Library/DxePcdLib/DxePcdLib.uni | 2 +- .../Library/DxeRuntimePciExpressLib/PciExpressLib.c | 6 +++--- MdePkg/Library/DxeServicesLib/DxeServicesLib.c | 12 ++++++------ .../DxeServicesTableLib/DxeServicesTableLib.c | 2 +- MdePkg/Library/DxeSmbusLib/DxeSmbusLib.c | 2 +- 10 files changed, 21 insertions(+), 21 deletions(-) diff --git a/MdePkg/Include/Library/DxeServicesLib.h b/MdePkg/Include/Library/DxeServicesLib.h index 838abf356f..689f47a54f 100644 --- a/MdePkg/Include/Library/DxeServicesLib.h +++ b/MdePkg/Include/Library/DxeServicesLib.h @@ -171,7 +171,7 @@ GetSectionFromFv ( /** - Searches the FFS file the the currently executing module was loaded from and returns the first matching FFS section. + Searches the FFS file the currently executing module was loaded from and returns the first matching FFS section. This function searches the FFS file that the currently executing module was loaded from for a FFS sections of type SectionType. If the FFS file contains at least SectionInstance instances of the FFS section specified by SectionType, diff --git a/MdePkg/Library/DxeExtractGuidedSectionLib/DxeExtractGuidedSectionLib.c b/MdePkg/Library/DxeExtractGuidedSectionLib/DxeExtractGuidedSectionLib.c index 4dfe450be9..ef730ec551 100644 --- a/MdePkg/Library/DxeExtractGuidedSectionLib/DxeExtractGuidedSectionLib.c +++ b/MdePkg/Library/DxeExtractGuidedSectionLib/DxeExtractGuidedSectionLib.c @@ -150,7 +150,7 @@ ExtractGuidedSectionGetGuidList ( If GetInfoHandler is NULL, then ASSERT(). If DecodeHandler is NULL, then ASSERT(). - @param[in] SectionGuid A pointer to the GUID associated with the the handlers + @param[in] SectionGuid A pointer to the GUID associated with the handlers of the GUIDed section type being registered. @param[in] GetInfoHandler The pointer to a function that examines a GUIDed section and returns the size of the decoded buffer and the size of an optional scratch buffer @@ -231,9 +231,9 @@ ExtractGuidedSectionRegisterHandlers ( Examines a GUIDed section specified by InputSection. If GUID for InputSection does not match any of the GUIDs registered through ExtractGuidedSectionRegisterHandlers(), then RETURN_UNSUPPORTED is returned. - If the GUID of InputSection does match the GUID that this handler supports, then the the associated handler + If the GUID of InputSection does match the GUID that this handler supports, then the associated handler of type EXTRACT_GUIDED_SECTION_GET_INFO_HANDLER that was registered with ExtractGuidedSectionRegisterHandlers() - is used to retrieve the OututBufferSize, ScratchSize, and Attributes values. The return status from the handler of + is used to retrieve the OutputBufferSize, ScratchSize, and Attributes values. The return status from the handler of type EXTRACT_GUIDED_SECTION_GET_INFO_HANDLER is returned. If InputSection is NULL, then ASSERT(). @@ -311,7 +311,7 @@ ExtractGuidedSectionGetInfo ( Decodes the GUIDed section specified by InputSection. If GUID for InputSection does not match any of the GUIDs registered through ExtractGuidedSectionRegisterHandlers(), then RETURN_UNSUPPORTED is returned. - If the GUID of InputSection does match the GUID that this handler supports, then the the associated handler + If the GUID of InputSection does match the GUID that this handler supports, then the associated handler of type EXTRACT_GUIDED_SECTION_DECODE_HANDLER that was registered with ExtractGuidedSectionRegisterHandlers() is used to decode InputSection into the buffer specified by OutputBuffer and the authentication status of this decode operation is returned in AuthenticationStatus. If the decoded buffer is identical to the data in InputSection, @@ -397,7 +397,7 @@ ExtractGuidedSectionDecode ( If SectionGuid is NULL, then ASSERT(). - @param[in] SectionGuid A pointer to the GUID associated with the handlersof the GUIDed + @param[in] SectionGuid A pointer to the GUID associated with the handlers of the GUIDed section type being retrieved. @param[out] GetInfoHandler Pointer to a function that examines a GUIDed section and returns the size of the decoded buffer and the size of an optional scratch diff --git a/MdePkg/Library/DxeHobLib/HobLib.c b/MdePkg/Library/DxeHobLib/HobLib.c index bf2470f6e2..ffac638d18 100644 --- a/MdePkg/Library/DxeHobLib/HobLib.c +++ b/MdePkg/Library/DxeHobLib/HobLib.c @@ -1,5 +1,5 @@ /** @file - HOB Library implemenation for Dxe Phase. + HOB Library implementation for Dxe Phase. Copyright (c) 2006 - 2018, Intel Corporation. All rights reserved.
SPDX-License-Identifier: BSD-2-Clause-Patent diff --git a/MdePkg/Library/DxeIoLibCpuIo2/IoLib.c b/MdePkg/Library/DxeIoLibCpuIo2/IoLib.c index b37e7a299e..21f88d9852 100644 --- a/MdePkg/Library/DxeIoLibCpuIo2/IoLib.c +++ b/MdePkg/Library/DxeIoLibCpuIo2/IoLib.c @@ -11,7 +11,7 @@ #include "DxeCpuIo2LibInternal.h" // -// Globle varible to cache pointer to CpuIo2 protocol. +// Global variable to cache pointer to CpuIo2 protocol. // EFI_CPU_IO2_PROTOCOL *mCpuIo = NULL; diff --git a/MdePkg/Library/DxePcdLib/DxePcdLib.inf b/MdePkg/Library/DxePcdLib/DxePcdLib.inf index c3f67543a4..3d4d21b442 100644 --- a/MdePkg/Library/DxePcdLib/DxePcdLib.inf +++ b/MdePkg/Library/DxePcdLib/DxePcdLib.inf @@ -16,7 +16,7 @@ # Note: A driver of type DXE_RUNTIME_DRIVER and DXE_SMM_DRIVER can only use this DxePcdLib # in their initialization without any issues to access Dynamic and DynamicEx PCD. They can't # access Dynamic and DynamicEx PCD in the implementation of runtime services and SMI handlers. -# Because EFI_PCD_PROTOCOL is DXE protocol that is not aviable in OS runtime phase. +# Because EFI_PCD_PROTOCOL is DXE protocol that is not available in OS runtime phase. # # Copyright (c) 2007 - 2018, Intel Corporation. All rights reserved.
# diff --git a/MdePkg/Library/DxePcdLib/DxePcdLib.uni b/MdePkg/Library/DxePcdLib/DxePcdLib.uni index 889f427e5f..c48aea35db 100644 --- a/MdePkg/Library/DxePcdLib/DxePcdLib.uni +++ b/MdePkg/Library/DxePcdLib/DxePcdLib.uni @@ -22,5 +22,5 @@ #string STR_MODULE_ABSTRACT #language en-US "PCD Library using PCD Protocol" -#string STR_MODULE_DESCRIPTION #language en-US "There are two PCD protocols: 1) PCD_PROTOCOL It is an EDKII implementation that supporst Dynamic/DynamicEx PCDs. 2) EFI_PCD_PROTOCOL It is defined by PI Specification 1.2, Vol 3, which only support dynamicEx type PCD. For dynamicEx type PCDs, it is compatible between PCD_PROTOCOL and EFI_PCD_PROTOCOL. This library instance uses the PCD_PROTOCOL to handle dynamic PCD requests and uses EFI_PCD_PROTOCOL to handle DynamicEx type PCDs." +#string STR_MODULE_DESCRIPTION #language en-US "There are two PCD protocols: 1) PCD_PROTOCOL It is an EDKII implementation that supports Dynamic/DynamicEx PCDs. 2) EFI_PCD_PROTOCOL It is defined by PI Specification 1.2, Vol 3, which only support dynamicEx type PCD. For dynamicEx type PCDs, it is compatible between PCD_PROTOCOL and EFI_PCD_PROTOCOL. This library instance uses the PCD_PROTOCOL to handle dynamic PCD requests and uses EFI_PCD_PROTOCOL to handle DynamicEx type PCDs." diff --git a/MdePkg/Library/DxeRuntimePciExpressLib/PciExpressLib.c b/MdePkg/Library/DxeRuntimePciExpressLib/PciExpressLib.c index 7e5852e641..b899543510 100644 --- a/MdePkg/Library/DxeRuntimePciExpressLib/PciExpressLib.c +++ b/MdePkg/Library/DxeRuntimePciExpressLib/PciExpressLib.c @@ -298,7 +298,7 @@ PciExpressRegisterForRuntimeAccess ( Address = GetPciExpressAddress (Address & 0x0ffff000); // - // See if Address has already been registerd for runtime access + // See if Address has already been registered for runtime access // for (Index = 0; Index < mDxeRuntimePciExpressLibNumberOfRuntimeRanges; Index++) { if (mDxeRuntimePciExpressLibRegistrationTable[Index].PhysicalAddress == Address) { @@ -1456,7 +1456,7 @@ PciExpressBitFieldAndThenOr32 ( Size into the buffer specified by Buffer. This function only allows the PCI configuration registers from a single PCI function to be read. Size is returned. When possible 32-bit PCI configuration read cycles are used to read - from StartAdress to StartAddress + Size. Due to alignment restrictions, 8-bit + from StartAddress to StartAddress + Size. Due to alignment restrictions, 8-bit and 16-bit PCI configuration read cycles may be used at the beginning and the end of the range. @@ -1559,7 +1559,7 @@ PciExpressReadBuffer ( Size from the buffer specified by Buffer. This function only allows the PCI configuration registers from a single PCI function to be written. Size is returned. When possible 32-bit PCI configuration write cycles are used to - write from StartAdress to StartAddress + Size. Due to alignment restrictions, + write from StartAddress to StartAddress + Size. Due to alignment restrictions, 8-bit and 16-bit PCI configuration write cycles may be used at the beginning and the end of the range. diff --git a/MdePkg/Library/DxeServicesLib/DxeServicesLib.c b/MdePkg/Library/DxeServicesLib/DxeServicesLib.c index 0735b2f804..3e3bbf6055 100644 --- a/MdePkg/Library/DxeServicesLib/DxeServicesLib.c +++ b/MdePkg/Library/DxeServicesLib/DxeServicesLib.c @@ -25,7 +25,7 @@ /** Identify the device handle from which the Image is loaded from. As this device handle is passed to GetSectionFromFv as the identifier for a Firmware Volume, an EFI_FIRMWARE_VOLUME2_PROTOCOL - protocol instance should be located succesfully by calling gBS->HandleProtocol (). + protocol instance should be located successfully by calling gBS->HandleProtocol (). This function locates the EFI_LOADED_IMAGE_PROTOCOL instance installed on ImageHandle. It then returns EFI_LOADED_IMAGE_PROTOCOL.DeviceHandle. @@ -71,7 +71,7 @@ InternalImageHandleToFvHandle ( Section type and instance number from the specified Firmware Volume. This functions first locate the EFI_FIRMWARE_VOLUME2_PROTOCOL protocol instance on FvHandle in order to - carry out the Firmware Volume read operation. The function then reads the Firmware Section found sepcifed + carry out the Firmware Volume read operation. The function then reads the Firmware Section found specified by NameGuid, SectionType and SectionInstance. The details of this search order is defined in description of EFI_FIRMWARE_VOLUME2_PROTOCOL.ReadSection () @@ -94,7 +94,7 @@ InternalImageHandleToFvHandle ( @param SectionType The Firmware Section type. @param SectionInstance The instance number of Firmware Section to read from starting from 0. - @param Buffer On output, Buffer contains the the data read + @param Buffer On output, Buffer contains the data read from the section in the Firmware File found. @param Size On output, the size of Buffer. @@ -517,7 +517,7 @@ GetSectionFromFv ( /** - Searches the FFS file the the currently executing module was loaded from and returns the first matching FFS section. + Searches the FFS file the currently executing module was loaded from and returns the first matching FFS section. This function searches the FFS file that the currently executing module was loaded from for a FFS sections of type SectionType. If the FFS file contains at least SectionInstance instances of the FFS section specified by SectionType, @@ -597,7 +597,7 @@ GetSectionFromFfs ( selection. If FALSE, then FilePath must match an exact file to be loaded. @param[in] FilePath The pointer to the device path of the file - that is absracted to the file buffer. + that is abstracted to the file buffer. @param[out] FileSize The pointer to the size of the abstracted file buffer. @param[out] AuthenticationStatus Pointer to the authentication status. @@ -745,7 +745,7 @@ GetFileBufferByFilePath ( } // // Parse each MEDIA_FILEPATH_DP node. There may be more than one, since the - // directory information and filename can be seperate. The goal is to inch + // directory information and filename can be separate. The goal is to inch // our way down each device path node and close the previous node // DevicePathNode = TempDevicePathNode; diff --git a/MdePkg/Library/DxeServicesTableLib/DxeServicesTableLib.c b/MdePkg/Library/DxeServicesTableLib/DxeServicesTableLib.c index 6783e4d754..9acb1b79b3 100644 --- a/MdePkg/Library/DxeServicesTableLib/DxeServicesTableLib.c +++ b/MdePkg/Library/DxeServicesTableLib/DxeServicesTableLib.c @@ -9,7 +9,7 @@ Please attention this library instance can not be used util EFI_SYSTEM_TABLE was initialized. - This library contains contruct function to retrieve EFI_DXE_SERIVCE, this construct + This library contains construct function to retrieve EFI_DXE_SERVICE, this construct function will be invoked in DXE driver's autogen file. Copyright (c) 2006 - 2018, Intel Corporation. All rights reserved.
diff --git a/MdePkg/Library/DxeSmbusLib/DxeSmbusLib.c b/MdePkg/Library/DxeSmbusLib/DxeSmbusLib.c index f6e3d4508f..d9cca7eb5f 100644 --- a/MdePkg/Library/DxeSmbusLib/DxeSmbusLib.c +++ b/MdePkg/Library/DxeSmbusLib/DxeSmbusLib.c @@ -12,7 +12,7 @@ SPDX-License-Identifier: BSD-2-Clause-Patent // -// Globle varible to cache pointer to Smbus protocol. +// Global variable to cache pointer to Smbus protocol. // EFI_SMBUS_HC_PROTOCOL *mSmbus = NULL; -- 2.39.2