From 26cfe2c659348da1bcfde15624e002f751608a87 Mon Sep 17 00:00:00 2001 From: Antoine Coeur Date: Fri, 7 Feb 2020 02:07:18 +0100 Subject: [PATCH] EmulatorPkg/Unix: Fix various typos Fix various typos in comments and documentation. Cc: Jordan Justen Cc: Andrew Fish Cc: Ray Ni Signed-off-by: Antoine Coeur Reviewed-by: Philippe Mathieu-Daude Reviewed-by: Ray Ni Signed-off-by: Philippe Mathieu-Daude Message-Id: <20200207010831.9046-6-philmd@redhat.com> --- EmulatorPkg/Unix/GdbRun.sh | 4 +-- EmulatorPkg/Unix/Host/BerkeleyPacketFilter.c | 2 +- EmulatorPkg/Unix/Host/BlockIo.c | 12 ++++----- EmulatorPkg/Unix/Host/EmuThunk.c | 2 +- EmulatorPkg/Unix/Host/Host.c | 26 ++++++++++---------- EmulatorPkg/Unix/Host/LinuxPacketFilter.c | 2 +- EmulatorPkg/Unix/Host/Pthreads.c | 2 +- EmulatorPkg/Unix/Host/X64/Gasket.S | 4 +-- EmulatorPkg/Unix/Host/X64/SwitchStack.S | 2 +- EmulatorPkg/Unix/lldbefi.py | 14 +++++------ 10 files changed, 35 insertions(+), 35 deletions(-) diff --git a/EmulatorPkg/Unix/GdbRun.sh b/EmulatorPkg/Unix/GdbRun.sh index 8c761ff2c9..b050ad5e2c 100644 --- a/EmulatorPkg/Unix/GdbRun.sh +++ b/EmulatorPkg/Unix/GdbRun.sh @@ -62,8 +62,8 @@ define RemoveFirmwareSymbolFile end if gInXcode == 1 - # in Xcode the program is already runing. Issuing a run command - # will cause a fatal debugger error. The break point sciprt that + # in Xcode the program is already running. Issuing a run command + # will cause a fatal debugger error. The break point script that # is used to source this script sets gInCode to 1. else # diff --git a/EmulatorPkg/Unix/Host/BerkeleyPacketFilter.c b/EmulatorPkg/Unix/Host/BerkeleyPacketFilter.c index 3013bbc86b..441f1e8d0a 100644 --- a/EmulatorPkg/Unix/Host/BerkeleyPacketFilter.c +++ b/EmulatorPkg/Unix/Host/BerkeleyPacketFilter.c @@ -5,7 +5,7 @@ Tested on Mac OS X. Copyright (c) 2004 - 2019, Intel Corporation. All rights reserved.
-Portitions copyright (c) 2011, Apple Inc. All rights reserved. +Portions copyright (c) 2011, Apple Inc. All rights reserved. SPDX-License-Identifier: BSD-2-Clause-Patent diff --git a/EmulatorPkg/Unix/Host/BlockIo.c b/EmulatorPkg/Unix/Host/BlockIo.c index 07e39347e4..18368060d5 100644 --- a/EmulatorPkg/Unix/Host/BlockIo.c +++ b/EmulatorPkg/Unix/Host/BlockIo.c @@ -398,7 +398,7 @@ EmuBlockIoReadBlocks ( Done: if (Token != NULL) { if (Token->Event != NULL) { - // Caller is responcible for signaling EFI Event + // Caller is responsible for signaling EFI Event Token->TransactionStatus = Status; return EFI_SUCCESS; } @@ -429,7 +429,7 @@ Done: the Event is NULL. @retval EFI_WRITE_PROTECTED The device can not be written to. @retval EFI_NO_MEDIA There is no media in the device. - @retval EFI_MEDIA_CHNAGED The MediaId does not matched the current device. + @retval EFI_MEDIA_CHANGED The MediaId does not match the current device. @retval EFI_DEVICE_ERROR The device reported an error while performing the write. @retval EFI_BAD_BUFFER_SIZE The Buffer was not a multiple of the block size of the device. @retval EFI_INVALID_PARAMETER The write request contains LBAs that are not valid, @@ -477,7 +477,7 @@ EmuBlockIoWriteBlocks ( Done: if (Token != NULL) { if (Token->Event != NULL) { - // Caller is responcible for signaling EFI Event + // Caller is responsible for signaling EFI Event Token->TransactionStatus = Status; return EFI_SUCCESS; } @@ -500,7 +500,7 @@ Done: @retval EFI_SUCCESS The flush request was queued if Event is not NULL. All outstanding data was written correctly to the device if the Event is NULL. - @retval EFI_DEVICE_ERROR The device reported an error while writting back + @retval EFI_DEVICE_ERROR The device reported an error while writing back the data. @retval EFI_WRITE_PROTECTED The device cannot be written to. @retval EFI_NO_MEDIA There is no media in the device. @@ -529,7 +529,7 @@ EmuBlockIoFlushBlocks ( if (Token != NULL) { if (Token->Event != NULL) { - // Caller is responcible for signaling EFI Event + // Caller is responsible for signaling EFI Event Token->TransactionStatus = EFI_SUCCESS; return EFI_SUCCESS; } @@ -544,7 +544,7 @@ EmuBlockIoFlushBlocks ( @param[in] This Indicates a pointer to the calling context. @param[in] ExtendedVerification Indicates that the driver may perform a more - exhausive verfication operation of the device + exhaustive verification operation of the device during reset. @retval EFI_SUCCESS The device was reset. diff --git a/EmulatorPkg/Unix/Host/EmuThunk.c b/EmulatorPkg/Unix/Host/EmuThunk.c index 1e9dc99187..b8b0651c6a 100644 --- a/EmulatorPkg/Unix/Host/EmuThunk.c +++ b/EmulatorPkg/Unix/Host/EmuThunk.c @@ -6,7 +6,7 @@ The mUnixThunkTable exists so that a change to EFI_EMU_THUNK_PROTOCOL will cause an error in initializing the array if all the member functions are not added. It looks like adding a element to end and not initializing - it may cause the table to be initaliized with the members at the end being + it may cause the table to be initialized with the members at the end being set to zero. This is bad as jumping to zero will crash. Copyright (c) 2004 - 2019, Intel Corporation. All rights reserved.
diff --git a/EmulatorPkg/Unix/Host/Host.c b/EmulatorPkg/Unix/Host/Host.c index b431a4c2ed..b4e5510613 100644 --- a/EmulatorPkg/Unix/Host/Host.c +++ b/EmulatorPkg/Unix/Host/Host.c @@ -38,7 +38,7 @@ UINTN gFdInfoCount = 0; EMU_FD_INFO *gFdInfo; // -// Array that supports seperate memory rantes. +// Array that supports separate memory ranges. // The memory ranges are set in system.cmd via the EFI_MEMORY_SIZE variable. // The number of array elements is allocated base on parsing // EFI_MEMORY_SIZE and the memory is never freed. @@ -379,7 +379,7 @@ Arguments: Returns: EFI_SUCCESS - The file was opened and mapped. EFI_NOT_FOUND - FileName was not found in the current directory - EFI_DEVICE_ERROR - An error occured attempting to map the opened file + EFI_DEVICE_ERROR - An error occurred attempting to map the opened file **/ EFI_STATUS @@ -523,7 +523,7 @@ Arguments: PeiCorePe32File - SEC PE32 Returns: - Success means control is transfered and thus we should never return + Success means control is transferred and thus we should never return **/ VOID @@ -611,7 +611,7 @@ Routine Description: It allows discontinuous memory regions to be supported by the emulator. It uses gSystemMemory[] and gSystemMemoryCount that were created by parsing the host environment variable EFI_MEMORY_SIZE. - The size comes from the varaible and the address comes from the call to + The size comes from the variable and the address comes from the call to UnixOpenFile. Arguments: @@ -661,7 +661,7 @@ Routine Description: This is all of GCD for system memory passed to DXE Core. FV mapping and other device mapped into system memory are not - inlcuded in the check. + included in the check. Arguments: Index - Which memory region to use @@ -775,7 +775,7 @@ SecPeCoffGetEntryPoint ( Routine Description: Return the FD Size and base address. Since the FD is loaded from a - file into host memory only the SEC will know it's address. + file into host memory only the SEC will know its address. Arguments: Index - Which FD, starts at zero. @@ -898,7 +898,7 @@ Routine Description: The ModHandle is needed to unload the image. Arguments: - ImageContext - Input data returned from PE Laoder Library. Used to find the + ImageContext - Input data returned from PE Loader Library. Used to find the .PDB file name of the PE Image. ModHandle - Returned from LoadLibraryEx() and stored for call to FreeLibrary(). @@ -922,7 +922,7 @@ AddHandle ( for (Index = 0; Index < mImageContextModHandleArraySize; Index++, Array++) { if (Array->ImageContext == NULL) { // - // Make a copy of the stirng and store the ModHandle + // Make a copy of the string and store the ModHandle // Array->ImageContext = ImageContext; Array->ModHandle = ModHandle; @@ -933,7 +933,7 @@ AddHandle ( // // No free space in mImageContextModHandleArray so grow it by // IMAGE_CONTEXT_TO_MOD_HANDLE entires. realloc will - // copy the old values to the new locaiton. But it does + // copy the old values to the new location. But it does // not zero the new memory area. // PreviousSize = mImageContextModHandleArraySize * sizeof (IMAGE_CONTEXT_TO_MOD_HANDLE); @@ -961,11 +961,11 @@ Routine Description: Return the ModHandle and delete the entry in the array. Arguments: - ImageContext - Input data returned from PE Laoder Library. Used to find the + ImageContext - Input data returned from PE Loader Library. Used to find the .PDB file name of the PE Image. Returns: - ModHandle - ModHandle assoicated with ImageContext is returned + ModHandle - ModHandle associated with ImageContext is returned NULL - No ModHandle associated with ImageContext **/ @@ -1129,7 +1129,7 @@ SecGdbScriptBreak ( /** - Adds the image to a gdb script so it's symbols can be loaded. + Adds the image to a gdb script so its symbols can be loaded. The AddFirmwareSymbolFile helper macro is used. @param ImageContext The PE/COFF image context @@ -1202,7 +1202,7 @@ SecPeCoffRelocateImageExtraAction ( /** - Adds the image to a gdb script so it's symbols can be unloaded. + Adds the image to a gdb script so its symbols can be unloaded. The RemoveFirmwareSymbolFile helper macro is used. @param ImageContext The PE/COFF image context diff --git a/EmulatorPkg/Unix/Host/LinuxPacketFilter.c b/EmulatorPkg/Unix/Host/LinuxPacketFilter.c index a8028d18ff..2b772ab884 100644 --- a/EmulatorPkg/Unix/Host/LinuxPacketFilter.c +++ b/EmulatorPkg/Unix/Host/LinuxPacketFilter.c @@ -6,7 +6,7 @@ is just a template that needs to get filled in. Copyright (c) 2004 - 2009, Intel Corporation. All rights reserved.
-Portitions copyright (c) 2011, Apple Inc. All rights reserved. +Portions copyright (c) 2011, Apple Inc. All rights reserved. SPDX-License-Identifier: BSD-2-Clause-Patent diff --git a/EmulatorPkg/Unix/Host/Pthreads.c b/EmulatorPkg/Unix/Host/Pthreads.c index f07bcfce66..025687c356 100644 --- a/EmulatorPkg/Unix/Host/Pthreads.c +++ b/EmulatorPkg/Unix/Host/Pthreads.c @@ -133,7 +133,7 @@ PthreadCreate ( EnabledOnEntry = FALSE; } - // Aquire lock for global, SecFakePthreadStart runs in a different thread. + // Acquire lock for global, SecFakePthreadStart runs in a different thread. pthread_mutex_lock (&mThreadMangle.Mutex); mThreadMangle.Start = Start; diff --git a/EmulatorPkg/Unix/Host/X64/Gasket.S b/EmulatorPkg/Unix/Host/X64/Gasket.S index a9ca707562..030faa8e4c 100644 --- a/EmulatorPkg/Unix/Host/X64/Gasket.S +++ b/EmulatorPkg/Unix/Host/X64/Gasket.S @@ -15,11 +15,11 @@ // // Gaskets are EFI ABI to UNIX ABI calls // EFI ABI code will sub 40 (0x28) from %rsp before calling a function -// This is the 32 (0x20) byte to spill registers and 8 bytes to align stack on 16 byte boundry. +// This is the 32 (0x20) byte to spill registers and 8 bytes to align stack on 16 byte boundary. // .text -// 32 byte shadow to spill rcx-r9, 8 bytes to align stack on 16 byte boundry +// 32 byte shadow to spill rcx-r9, 8 bytes to align stack on 16 byte boundary // Any call with 0 - 4 arguments allocates 40 bytes on the stack. // For more than 4 args you always have to increase in quanta of 16 so 5 or 6 args is 56, // 7 or 8 args is 72, and 9 or 10 args is 88 diff --git a/EmulatorPkg/Unix/Host/X64/SwitchStack.S b/EmulatorPkg/Unix/Host/X64/SwitchStack.S index 4126cc9912..36838bf29e 100644 --- a/EmulatorPkg/Unix/Host/X64/SwitchStack.S +++ b/EmulatorPkg/Unix/Host/X64/SwitchStack.S @@ -1,7 +1,7 @@ #------------------------------------------------------------------------------ # # Copyright (c) 2006 - 2008, Intel Corporation. All rights reserved.
-# Portitions copyright (c) 2011, Apple Inc. All rights reserved. +# Portions copyright (c) 2011, Apple Inc. All rights reserved. # SPDX-License-Identifier: BSD-2-Clause-Patent # #------------------------------------------------------------------------------ diff --git a/EmulatorPkg/Unix/lldbefi.py b/EmulatorPkg/Unix/lldbefi.py index 7f99a7f83f..c3fb2675cb 100755 --- a/EmulatorPkg/Unix/lldbefi.py +++ b/EmulatorPkg/Unix/lldbefi.py @@ -1,7 +1,7 @@ #!/usr/bin/python # -# Copyright 2014 Apple Inc. All righes reserved. +# Copyright 2014 Apple Inc. All rights reserved. # # SPDX-License-Identifier: BSD-2-Clause-Patent # @@ -278,7 +278,7 @@ def EFI_DEVICE_PATH_PROTOCOL_TypeSummary (valobj,internal_dict): Address = long ("%d" % valobj.addr) if (Address == lldb.LLDB_INVALID_ADDRESS): - # Need to reserach this, it seems to be the nested struct case + # Need to research this, it seems to be the nested struct case ExprStr = "" elif (Type & 0x7f == 0x7f): ExprStr = "End Device Path" if SubType == 0xff else "End This Instance" @@ -304,7 +304,7 @@ def EFI_DEVICE_PATH_PROTOCOL_TypeSummary (valobj,internal_dict): def TypePrintFormating(debugger): # - # Set the default print formating for EFI types in lldb. + # Set the default print formatting for EFI types in lldb. # seems lldb defaults to decimal. # category = debugger.GetDefaultCategory() @@ -390,7 +390,7 @@ def LoadEmulatorEfiSymbols(frame, bp_loc , internal_dict): FileName = frame.thread.process.ReadCStringFromMemory (FileNamePtr, FileNameLen, Error) if not Error.Success(): print "!ReadCStringFromMemory() did not find a %d byte C string at %x" % (FileNameLen, FileNamePtr) - # make breakpoint command contiue + # make breakpoint command continue return False debugger = frame.thread.process.target.debugger @@ -410,12 +410,12 @@ def LoadEmulatorEfiSymbols(frame, bp_loc , internal_dict): if not target.RemoveModule (SBModule): print "!lldb.target.RemoveModule (%s) FAILED" % SBModule - # make breakpoint command contiue + # make breakpoint command continue return False def GuidToCStructStr (guid, Name=False): # - # Convert a 16-byte bytesarry (or bytearray compat object) to C guid string + # Convert a 16-byte bytesarray (or bytearray compat object) to C guid string # { 0xB402621F, 0xA940, 0x1E4A, { 0x86, 0x6B, 0x4D, 0xC9, 0x16, 0x2B, 0x34, 0x7C } } # # Name=True means lookup name in GuidNameDict and us it if you find it @@ -522,7 +522,7 @@ def __lldb_init_module (debugger, internal_dict): if len(data) >= 2: guid_dict[data[0].upper()] = data[1].strip('\n') - # init EFI specific type formaters + # init EFI specific type formatters TypePrintFormating (debugger)