Re: [PATCH v2] ArmPlatformPkg: Fix various typos

["Philippe Mathieu-Daudé" <philmd@redhat.com>]

On 2/6/19 4:46 PM, Antoine Coeur wrote:
> Fix various typos in ArmPlatformPkg.
> 
> Contributed-under: TianoCore Contribution Agreement 1.1
> Signed-off-by: Coeur <coeur@gmx.fr>
> ---
>  ArmPlatformPkg/Drivers/NorFlashDxe/NorFlashDxe.c   | 4 ++--
>  ArmPlatformPkg/Include/Library/ArmPlatformLib.h    | 2 +-
>  ArmPlatformPkg/Include/Library/PL011UartLib.h      | 2 +-
>  ArmPlatformPkg/Library/PL011UartLib/PL011UartLib.c | 2 +-
>  ArmPlatformPkg/MemoryInitPei/MemoryInitPeim.c      | 2 +-
>  ArmPlatformPkg/PlatformPei/PlatformPeim.c          | 2 +-
>  ArmPlatformPkg/PrePeiCore/PrePeiCore.c             | 2 +-
>  ArmPlatformPkg/PrePi/PrePi.c                       | 2 +-
>  8 files changed, 9 insertions(+), 9 deletions(-)
> 
> diff --git a/ArmPlatformPkg/Drivers/NorFlashDxe/NorFlashDxe.c b/ArmPlatformPkg/Drivers/NorFlashDxe/NorFlashDxe.c
> index af40a4c884..73d389c811 100644
> --- a/ArmPlatformPkg/Drivers/NorFlashDxe/NorFlashDxe.c
> +++ b/ArmPlatformPkg/Drivers/NorFlashDxe/NorFlashDxe.c
> @@ -1115,7 +1115,7 @@ NorFlashWriteSingleBlock (
>    @retval EFI_SUCCESS           The data was read correctly from the device.
>    @retval EFI_DEVICE_ERROR      The device reported an error while performing the read.
>    @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.

We could argue if this one is strictly a *typo* ;)

>    @retval EFI_INVALID_PARAMETER The read request contains device addresses that are not
>                                  valid for the device.
>  
> @@ -1160,7 +1160,7 @@ NorFlashDiskIoReadDisk (
>    @retval EFI_WRITE_PROTECTED   The device can not be written to.
>    @retval EFI_DEVICE_ERROR      The device reported an error while performing the write.
>    @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_INVALID_PARAMETER The write request contains device addresses that are not
>                                   valid for the device.
>  
> diff --git a/ArmPlatformPkg/Include/Library/ArmPlatformLib.h b/ArmPlatformPkg/Include/Library/ArmPlatformLib.h
> index 3ad4c16066..fd264b31f7 100644
> --- a/ArmPlatformPkg/Include/Library/ArmPlatformLib.h
> +++ b/ArmPlatformPkg/Include/Library/ArmPlatformLib.h
> @@ -20,7 +20,7 @@
>  //
>  #include <PiPei.h>
>  //
> -// The protocols, PPI and GUID defintions for this module
> +// The protocols, PPI and GUID definitions for this module
>  //
>  #include <Ppi/MasterBootMode.h>
>  #include <Ppi/BootInRecoveryMode.h>
> diff --git a/ArmPlatformPkg/Include/Library/PL011UartLib.h b/ArmPlatformPkg/Include/Library/PL011UartLib.h
> index 8cfc3d118a..495def8d7d 100644
> --- a/ArmPlatformPkg/Include/Library/PL011UartLib.h
> +++ b/ArmPlatformPkg/Include/Library/PL011UartLib.h
> @@ -118,7 +118,7 @@ PL011UartSetControl (
>                           . EFI_SERIAL_OUTPUT_BUFFER_EMPTY : equal to one if the
>                             transmit buffer is empty, 0 otherwise.
>                           . EFI_SERIAL_HARDWARE_LOOPBACK_ENABLE : equal to one if
> -                           the hardware loopback is enabled (the ouput feeds the
> +                           the hardware loopback is enabled (the output feeds the
>                             receive buffer), 0 otherwise.
>                           . EFI_SERIAL_SOFTWARE_LOOPBACK_ENABLE : equal to one if
>                             a loopback is accomplished by software, 0 otherwise.
> diff --git a/ArmPlatformPkg/Library/PL011UartLib/PL011UartLib.c b/ArmPlatformPkg/Library/PL011UartLib/PL011UartLib.c
> index 61a34fda0b..60c06a63a4 100644
> --- a/ArmPlatformPkg/Library/PL011UartLib/PL011UartLib.c
> +++ b/ArmPlatformPkg/Library/PL011UartLib/PL011UartLib.c
> @@ -327,7 +327,7 @@ PL011UartSetControl (
>                           . EFI_SERIAL_OUTPUT_BUFFER_EMPTY : equal to one if the
>                             transmit buffer is empty, 0 otherwise.
>                           . EFI_SERIAL_HARDWARE_LOOPBACK_ENABLE : equal to one if
> -                           the hardware loopback is enabled (the ouput feeds the
> +                           the hardware loopback is enabled (the output feeds the
>                             receive buffer), 0 otherwise.
>                           . EFI_SERIAL_SOFTWARE_LOOPBACK_ENABLE : equal to one if
>                             a loopback is accomplished by software, 0 otherwise.

Which makes me wonder what is the benefit of copying the same doc twice,
in the header and the source?

> diff --git a/ArmPlatformPkg/MemoryInitPei/MemoryInitPeim.c b/ArmPlatformPkg/MemoryInitPei/MemoryInitPeim.c
> index 010f93add7..6f2a357b96 100644
> --- a/ArmPlatformPkg/MemoryInitPei/MemoryInitPeim.c
> +++ b/ArmPlatformPkg/MemoryInitPei/MemoryInitPeim.c
> @@ -15,7 +15,7 @@
>  #include <PiPei.h>
>  
>  //
> -// The protocols, PPI and GUID defintions for this module
> +// The protocols, PPI and GUID definitions for this module
>  //
>  #include <Ppi/MasterBootMode.h>
>  #include <Ppi/BootInRecoveryMode.h>
> diff --git a/ArmPlatformPkg/PlatformPei/PlatformPeim.c b/ArmPlatformPkg/PlatformPei/PlatformPeim.c
> index 14f301e947..4d9f3c2d54 100644
> --- a/ArmPlatformPkg/PlatformPei/PlatformPeim.c
> +++ b/ArmPlatformPkg/PlatformPei/PlatformPeim.c
> @@ -15,7 +15,7 @@
>  #include <PiPei.h>
>  
>  //
> -// The protocols, PPI and GUID defintions for this module
> +// The protocols, PPI and GUID definitions for this module
>  //
>  #include <Ppi/MasterBootMode.h>
>  #include <Ppi/BootInRecoveryMode.h>
> diff --git a/ArmPlatformPkg/PrePeiCore/PrePeiCore.c b/ArmPlatformPkg/PrePeiCore/PrePeiCore.c
> index 3a81e2e23f..be1d28a4d6 100644
> --- a/ArmPlatformPkg/PrePeiCore/PrePeiCore.c
> +++ b/ArmPlatformPkg/PrePeiCore/PrePeiCore.c
> @@ -44,7 +44,7 @@ CreatePpiList (
>    PlatformPpiListSize = 0;
>    ArmPlatformGetPlatformPpiList (&PlatformPpiListSize, &PlatformPpiList);
>  
> -  // Copy the Common and Platform PPis in Temporrary Memory
> +  // Copy the Common and Platform PPis in Temporary Memory
>    ListBase = PcdGet64 (PcdCPUCoresStackBase);
>    CopyMem ((VOID*)ListBase, gCommonPpiTable, sizeof(gCommonPpiTable));
>    CopyMem ((VOID*)(ListBase + sizeof(gCommonPpiTable)), PlatformPpiList, PlatformPpiListSize);
> diff --git a/ArmPlatformPkg/PrePi/PrePi.c b/ArmPlatformPkg/PrePi/PrePi.c
> index 245bdded1e..a9cd8b8f9d 100644
> --- a/ArmPlatformPkg/PrePi/PrePi.c
> +++ b/ArmPlatformPkg/PrePi/PrePi.c
> @@ -199,7 +199,7 @@ CEntryPoint (
>          ArmCallSEV ();
>        }
>      } else {
> -      // Wait the Primay core has defined the address of the Global Variable region (event: ARM_CPU_EVENT_DEFAULT)
> +      // Wait the Primary core has defined the address of the Global Variable region (event: ARM_CPU_EVENT_DEFAULT)
>        ArmCallWFE ();
>      }
>    }
> 

Reviewed-by: Philippe Mathieu-Daude <philmd@redhat.com>