Re: [PATCH 24/33] Nt32Pkg: Fix typos in comments and variables

["Ni, Ruiyu" <ruiyu.ni@intel.com>]

Reviewed-by: Ruiyu Ni <ruiyu.ni@intel.com>
> -----Original Message-----
> From: edk2-devel [mailto:edk2-devel-bounces@lists.01.org] On Behalf Of
> Gary Lin
> Sent: Wednesday, October 19, 2016 3:01 PM
> To: edk2-devel@lists.01.org
> Cc: Ni, Ruiyu <ruiyu.ni@intel.com>
> Subject: [edk2] [PATCH 24/33] Nt32Pkg: Fix typos in comments and variables
> 
> - discontiguous -> discontinuous
> - reloaced -> relocated
> - supresses -> suppresses
> - debuging -> debugging
> - suported -> supported
> - availble -> available
> - environmemt -> environment
> - Seperator -> Separator
> - remmeber -> remember
> - interperted -> interpreted
> - the a new -> the new
> - initailized -> initialized
> - attribue -> attribute
> - boundry -> boundary
> - nto -> not
> - permenent -> permanent
> - immediatly -> immediately
> - excuted -> executed
> 
> Cc: Ruiyu Ni <ruiyu.ni@intel.com>
> Contributed-under: TianoCore Contribution Agreement 1.0
> Signed-off-by: Gary Lin <glin@suse.com>
> ---
>  Nt32Pkg/Include/Ppi/NtAutoscan.h                                          |  2 +-
> 
> Nt32Pkg/Library/DxeNt32PeCoffExtraActionLib/DxeNt32PeCoffExtraActionLi
> b.c |  8 ++--
> Nt32Pkg/Library/PeiNt32PeCoffExtraActionLib/PeiNt32PeCoffExtraActionLib.
> c |  6 +--
>  Nt32Pkg/Sec/SecMain.c                                                     | 50 ++++++++++----------
>  Nt32Pkg/Sec/SecMain.h                                                     |  6 +--
>  Nt32Pkg/Sec/WinNtThunk.c                                                  |  2 +-
>  Nt32Pkg/WinNtFirmwareVolumePei/WinntFwh.c                                 |  2 +-
>  7 files changed, 38 insertions(+), 38 deletions(-)
> 
> diff --git a/Nt32Pkg/Include/Ppi/NtAutoscan.h
> b/Nt32Pkg/Include/Ppi/NtAutoscan.h
> index 49c0294..1891bb4 100644
> --- a/Nt32Pkg/Include/Ppi/NtAutoscan.h
> +++ b/Nt32Pkg/Include/Ppi/NtAutoscan.h
> @@ -41,7 +41,7 @@ EFI_STATUS
> 
>  Routine Description:
>    This service is called from Index == 0 until it returns EFI_UNSUPPORTED.
> -  It allows discontiguous memory regions to be supported by the emulator.
> +  It allows discontinuous memory regions to be supported by the emulator.
>    It uses gSystemMemory[] and gSystemMemoryCount that were created by
>    parsing the Windows environment variable EFI_MEMORY_SIZE.
>    The size comes from the varaible and the address comes from the call to
> diff --git
> a/Nt32Pkg/Library/DxeNt32PeCoffExtraActionLib/DxeNt32PeCoffExtraAction
> Lib.c
> b/Nt32Pkg/Library/DxeNt32PeCoffExtraActionLib/DxeNt32PeCoffExtraActio
> nLib.c
> index 524d6c0..2f62d65 100644
> ---
> a/Nt32Pkg/Library/DxeNt32PeCoffExtraActionLib/DxeNt32PeCoffExtraAction
> Lib.c
> +++
> b/Nt32Pkg/Library/DxeNt32PeCoffExtraActionLib/DxeNt32PeCoffExtraActi
> +++ onLib.c
> @@ -290,7 +290,7 @@ PeCoffLoaderRelocateImageExtraAction (
>    // If we load our own PE COFF images the Windows debugger can not
> source
>    //  level debug our code. If a valid PDB pointer exists usw it to load
>    //  the *.dll file as a library using Windows* APIs. This allows
> -  //  source level debug. The image is still loaded and reloaced
> +  //  source level debug. The image is still loaded and relocated
>    //  in the Framework memory space like on a real system (by the code
> above),
>    //  but the entry point points into the DLL loaded by the code bellow.
>    //
> @@ -335,11 +335,11 @@ PeCoffLoaderRelocateImageExtraAction (
>      if (Library != NULL) {
>        //
>        // InitializeDriver is the entry point we put in all our EFI DLL's. The
> -      // DONT_RESOLVE_DLL_REFERENCES argument to LoadLIbraryEx()
> supresses the
> +      // DONT_RESOLVE_DLL_REFERENCES argument to LoadLIbraryEx()
> + suppresses the
>        // normal DLL entry point of DllMain, and prevents other modules that
> are
>        // referenced in side the DllFileName from being loaded. There is no error
>        // checking as the we can point to the PE32 image loaded by Tiano. This
> -      // step is only needed for source level debuging
> +      // step is only needed for source level debugging
>        //
>        DllEntryPoint = (VOID *) (UINTN) mWinNt->GetProcAddress (Library,
> "InitializeDriver");
> 
> @@ -355,7 +355,7 @@ PeCoffLoaderRelocateImageExtraAction (
>          DEBUG ((EFI_D_ERROR, "WARNING: DLL already loaded.  No source level
> debug %s. \n", DllFileName));
>        } else {
>          //
> -        // This DLL is not already loaded, so source level debugging is suported.
> +        // This DLL is not already loaded, so source level debugging is supported.
>          //
>          ImageContext->EntryPoint  = (EFI_PHYSICAL_ADDRESS) (UINTN)
> DllEntryPoint;
>          DEBUG ((EFI_D_INFO, "LoadLibraryEx (%s,\n               NULL,
> DONT_RESOLVE_DLL_REFERENCES)\n", DllFileName));
> diff --git
> a/Nt32Pkg/Library/PeiNt32PeCoffExtraActionLib/PeiNt32PeCoffExtraActionLi
> b.c
> b/Nt32Pkg/Library/PeiNt32PeCoffExtraActionLib/PeiNt32PeCoffExtraActionLi
> b.c
> index b05834e..682446a 100644
> ---
> a/Nt32Pkg/Library/PeiNt32PeCoffExtraActionLib/PeiNt32PeCoffExtraActionLi
> b.c
> +++
> b/Nt32Pkg/Library/PeiNt32PeCoffExtraActionLib/PeiNt32PeCoffExtraActi
> +++ onLib.c
> @@ -155,7 +155,7 @@ PeCoffLoaderRelocateImageExtraAction (
>    // If we load our own PE COFF images the Windows debugger can not
> source
>    //  level debug our code. If a valid PDB pointer exists usw it to load
>    //  the *.dll file as a library using Windows* APIs. This allows
> -  //  source level debug. The image is still loaded and reloaced
> +  //  source level debug. The image is still loaded and relocated
>    //  in the Framework memory space like on a real system (by the code
> above),
>    //  but the entry point points into the DLL loaded by the code bellow.
>    //
> @@ -200,11 +200,11 @@ PeCoffLoaderRelocateImageExtraAction (
>      if (Library != NULL) {
>        //
>        // InitializeDriver is the entry point we put in all our EFI DLL's. The
> -      // DONT_RESOLVE_DLL_REFERENCES argument to LoadLIbraryEx()
> supresses the
> +      // DONT_RESOLVE_DLL_REFERENCES argument to LoadLIbraryEx()
> + suppresses the
>        // normal DLL entry point of DllMain, and prevents other modules that
> are
>        // referenced in side the DllFileName from being loaded. There is no error
>        // checking as the we can point to the PE32 image loaded by Tiano. This
> -      // step is only needed for source level debuging
> +      // step is only needed for source level debugging
>        //
>        DllEntryPoint = (VOID *) (UINTN) mWinNt->GetProcAddress (Library,
> "InitializeDriver");
> 
> diff --git a/Nt32Pkg/Sec/SecMain.c b/Nt32Pkg/Sec/SecMain.c index
> e9f72df..80539fa 100644
> --- a/Nt32Pkg/Sec/SecMain.c
> +++ b/Nt32Pkg/Sec/SecMain.c
> @@ -22,7 +22,7 @@ Abstract:
>    will be, how may FD's will be loaded and also what the boot mode is.
> 
>    The SEC registers a set of services with the SEC core. gPrivateDispatchTable
> -  is a list of PPI's produced by the SEC that are availble for usage in PEI.
> +  is a list of PPI's produced by the SEC that are available for usage in PEI.
> 
>    This code produces 128 K of temporary memory for the PEI stack by directly
>    allocate memory space with ReadWrite and Execute attribute.
> @@ -161,7 +161,7 @@ Routine Description:
>  Arguments:
>    Argc - Number of command line arguments
>    Argv - Array of command line argument strings
> -  Envp - Array of environmemt variable strings
> +  Envp - Array of environment variable strings
> 
>  Returns:
>    0 - Normal exit
> @@ -228,7 +228,7 @@ Returns:
>    //
>    // Allocate space for gSystemMemory Array
>    //
> -  gSystemMemoryCount  = CountSeperatorsInString (MemorySizeStr, '!') + 1;
> +  gSystemMemoryCount  = CountSeparatorsInString (MemorySizeStr, '!') +
> + 1;
>    gSystemMemory       = calloc (gSystemMemoryCount, sizeof
> (NT_SYSTEM_MEMORY));
>    if (gSystemMemory == NULL) {
>      SecPrint ("ERROR : Can not allocate memory for %S.  Exiting.\n",
> MemorySizeStr); @@ -237,7 +237,7 @@ Returns:
>    //
>    // Allocate space for gSystemMemory Array
>    //
> -  gFdInfoCount  = CountSeperatorsInString (FirmwareVolumesStr, '!') + 1;
> +  gFdInfoCount  = CountSeparatorsInString (FirmwareVolumesStr, '!') +
> + 1;
>    gFdInfo       = calloc (gFdInfoCount, sizeof (NT_FD_INFO));
>    if (gFdInfo == NULL) {
>      SecPrint ("ERROR : Can not allocate memory for %S.  Exiting.\n",
> FirmwareVolumesStr); @@ -291,7 +291,7 @@ Returns:
>      }
> 
>      //
> -    // Open the FD and remmeber where it got mapped into our processes
> address space
> +    // Open the FD and remember where it got mapped into our processes
> + address space
>      //
>      Status = WinNtOpenFile (
>                FileName,
> @@ -307,7 +307,7 @@ Returns:
> 
>      SecPrint ("  FD loaded from");
>      //
> -    // printf can't print filenames directly as the \ gets interperted as an
> +    // printf can't print filenames directly as the \ gets interpreted
> + as an
>      //  escape character.
>      //
>      for (Index2 = 0; FileName[Index2] != '\0'; Index2++) { @@ -385,7 +385,7
> @@ Arguments:
>    CreationDisposition - The flags to pass to CreateFile().  Use to create new
> files for
>                          memory emulation, and exiting files for firmware volume
> emulation
>    BaseAddress         - The base address of the mapped file in the user address
> space.
> -                         If passed in as NULL the a new memory region is used.
> +                         If passed in as NULL the new memory region is used.
>                           If passed in as non NULL the request memory region is used for
>                            the mapping of the file into the process space.
>    Length              - The size of the mapped region in bytes
> @@ -701,7 +701,7 @@ SecWinNtPeiAutoScan (
> 
>  Routine Description:
>    This service is called from Index == 0 until it returns EFI_UNSUPPORTED.
> -  It allows discontiguous memory regions to be supported by the emulator.
> +  It allows discontinuous memory regions to be supported by the emulator.
>    It uses gSystemMemory[] and gSystemMemoryCount that were created by
>    parsing PcdWinNtMemorySizeForSecMain value.
>    The size comes from the Pcd value and the address comes from the
> memory space @@ -746,7 +746,7 @@ SecWinNtWinNtThunkAddress
> (  Routine Description:
>    Since the SEC is the only Windows program in stack it must export
>    an interface to do Win API calls. That's what the WinNtThunk address
> -  is for. gWinNt is initailized in WinNtThunk.c.
> +  is for. gWinNt is initialized in WinNtThunk.c.
> 
>  Arguments:
>    InterfaceSize - sizeof (EFI_WIN_NT_THUNK_PROTOCOL); @@ -799,7 +799,7
> @@ Returns:
>      return Status;
>    }
>    //
> -  // Allocate space in NT (not emulator) memory with ReadWrite and
> Execute attribue.
> +  // Allocate space in NT (not emulator) memory with ReadWrite and
> Execute attribute.
>    // Extra space is for alignment
>    //
>    ImageContext.ImageAddress = (EFI_PHYSICAL_ADDRESS) (UINTN)
> VirtualAlloc (NULL, (SIZE_T) (ImageContext.ImageSize +
> (ImageContext.SectionAlignment * 2)), MEM_COMMIT,
> PAGE_EXECUTE_READWRITE); @@ -807,7 +807,7 @@ Returns:
>      return EFI_OUT_OF_RESOURCES;
>    }
>    //
> -  // Align buffer on section boundry
> +  // Align buffer on section boundary
>    //
>    ImageContext.ImageAddress += ImageContext.SectionAlignment - 1;
>    ImageContext.ImageAddress &=
> ~((EFI_PHYSICAL_ADDRESS)ImageContext.SectionAlignment - 1); @@ -853,7
> +853,7 @@ Arguments:
> 
>  Returns:
>    EFI_SUCCESS     - Return the Base address and size of the FV
> -  EFI_UNSUPPORTED - Index does nto map to an FD in the system
> +  EFI_UNSUPPORTED - Index does not map to an FD in the system
> 
>  --*/
>  {
> @@ -956,28 +956,28 @@ Returns:
>  }
> 
>  UINTN
> -CountSeperatorsInString (
> +CountSeparatorsInString (
>    IN  CONST CHAR16   *String,
> -  IN  CHAR16         Seperator
> +  IN  CHAR16         Separator
>    )
>  /*++
> 
>  Routine Description:
> -  Count the number of seperators in String
> +  Count the number of separators in String
> 
>  Arguments:
>    String    - String to process
> -  Seperator - Item to count
> +  Separator - Item to count
> 
>  Returns:
> -  Number of Seperator in String
> +  Number of Separator in String
> 
>  --*/
>  {
>    UINTN Count;
> 
>    for (Count = 0; *String != '\0'; String++) {
> -    if (*String == Seperator) {
> +    if (*String == Separator) {
>        Count++;
>      }
>    }
> @@ -1010,7 +1010,7 @@ SecNt32PeCoffRelocateImage (
>    // If we load our own PE COFF images the Windows debugger can not
> source
>    //  level debug our code. If a valid PDB pointer exists usw it to load
>    //  the *.dll file as a library using Windows* APIs. This allows
> -  //  source level debug. The image is still loaded and reloaced
> +  //  source level debug. The image is still loaded and relocated
>    //  in the Framework memory space like on a real system (by the code
> above),
>    //  but the entry point points into the DLL loaded by the code bellow.
>    //
> @@ -1055,11 +1055,11 @@ SecNt32PeCoffRelocateImage (
>      if (Library != NULL) {
>        //
>        // InitializeDriver is the entry point we put in all our EFI DLL's. The
> -      // DONT_RESOLVE_DLL_REFERENCES argument to LoadLIbraryEx()
> supresses the
> +      // DONT_RESOLVE_DLL_REFERENCES argument to LoadLIbraryEx()
> + suppresses the
>        // normal DLL entry point of DllMain, and prevents other modules that
> are
>        // referenced in side the DllFileName from being loaded. There is no error
>        // checking as the we can point to the PE32 image loaded by Tiano. This
> -      // step is only needed for source level debuging
> +      // step is only needed for source level debugging
>        //
>        DllEntryPoint = (VOID *) (UINTN) GetProcAddress (Library,
> "InitializeDriver");
> 
> @@ -1103,7 +1103,7 @@ SecTemporaryRamSupport (
>    )
>  {
>    //
> -  // Migrate the whole temporary memory to permenent memory.
> +  // Migrate the whole temporary memory to permanent memory.
>    //
>    CopyMem (
>      (VOID*)(UINTN)PermanentMemoryBase,
> @@ -1113,8 +1113,8 @@ SecTemporaryRamSupport (
> 
>    //
>    // SecSwitchStack function must be invoked after the memory migration
> -  // immediatly, also we need fixup the stack change caused by new call into
> -  // permenent memory.
> +  // immediately, also we need fixup the stack change caused by new
> + call into  // permanent memory.
>    //
>    SecSwitchStack (
>      (UINT32) TemporaryMemoryBase,
> @@ -1123,7 +1123,7 @@ SecTemporaryRamSupport (
> 
>    //
>    // We need *not* fix the return address because currently,
> -  // The PeiCore is excuted in flash.
> +  // The PeiCore is executed in flash.
>    //
> 
>    //
> diff --git a/Nt32Pkg/Sec/SecMain.h b/Nt32Pkg/Sec/SecMain.h index
> 76522e3..8b19878 100644
> --- a/Nt32Pkg/Sec/SecMain.h
> +++ b/Nt32Pkg/Sec/SecMain.h
> @@ -524,9 +524,9 @@ Returns:
>  ;
> 
>  UINTN
> -CountSeperatorsInString (
> +CountSeparatorsInString (
>    IN  CONST CHAR16   *String,
> -  IN  CHAR16   Seperator
> +  IN  CHAR16   Separator
>    )
>  /*++
> 
> @@ -537,7 +537,7 @@ Routine Description:
>  Arguments:
> 
>    String    - TODO: add argument description
> -  Seperator - TODO: add argument description
> +  Separator - TODO: add argument description
> 
>  Returns:
> 
> diff --git a/Nt32Pkg/Sec/WinNtThunk.c b/Nt32Pkg/Sec/WinNtThunk.c index
> 9ab380c..3159ef4 100644
> --- a/Nt32Pkg/Sec/WinNtThunk.c
> +++ b/Nt32Pkg/Sec/WinNtThunk.c
> @@ -42,7 +42,7 @@ Abstract:
>  //  point could be modified dynamically. The SEC does not do that, so we
> must  //  disable the warning so we can compile the SEC. The previous
> method was to  //  asign each element in code. The disadvantage to that
> approach is it's harder -//  to tell if all the elements have been initailized
> properly.
> +//  to tell if all the elements have been initialized properly.
>  //
>  #pragma warning(disable : 4232)
>  #pragma warning(disable : 4996)
> diff --git a/Nt32Pkg/WinNtFirmwareVolumePei/WinntFwh.c
> b/Nt32Pkg/WinNtFirmwareVolumePei/WinntFwh.c
> index 20774ee..8cd9188 100644
> --- a/Nt32Pkg/WinNtFirmwareVolumePei/WinntFwh.c
> +++ b/Nt32Pkg/WinNtFirmwareVolumePei/WinntFwh.c
> @@ -48,7 +48,7 @@ Routine Description:
>    Perform a call-back into the SEC simulator to get address of the Firmware
> Hub
> 
>  Arguments:
> -  FfsHeader   - Ffs Header availible to every PEIM
> +  FfsHeader   - Ffs Header available to every PEIM
>    PeiServices - General purpose services available to every PEIM.
> 
>  Returns:
> --
> 2.10.1
> 
> _______________________________________________
> edk2-devel mailing list
> edk2-devel@lists.01.org
> https://lists.01.org/mailman/listinfo/edk2-devel