Re: [PATCH 73/79] SourceLevelDebugPkg/DebugCommunicationLib: Fix various typos

["Wu, Hao A" <hao.a.wu@intel.com>]

> -----Original Message-----
> From: Philippe Mathieu-Daude [mailto:philmd@redhat.com]
> Sent: Wednesday, December 04, 2019 12:16 AM
> To: devel@edk2.groups.io
> Cc: Antoine Coeur; Wu, Hao A; Philippe Mathieu-Daude
> Subject: [PATCH 73/79] SourceLevelDebugPkg/DebugCommunicationLib: Fix
> various typos
> 
> From: Antoine Coeur <coeur@gmx.fr>
> 
> Fix various typos in comments and documentation.


Reviewed-by: Hao A Wu <hao.a.wu@intel.com>

Best Regards,
Hao Wu


> 
> Cc: Hao A Wu <hao.a.wu@intel.com>
> Reviewed-by: Philippe Mathieu-Daude <philmd@redhat.com>
> Signed-off-by: Philippe Mathieu-Daude <philmd@redhat.com>
> ---
> 
> SourceLevelDebugPkg/Library/DebugCommunicationLibSerialPort/DebugCom
> municationLibSerialPort.inf | 2 +-
>  SourceLevelDebugPkg/Include/Library/DebugCommunicationLib.h
> | 2 +-
> 
> SourceLevelDebugPkg/Library/DebugCommunicationLibUsb3/DebugCommunic
> ationLibUsb3Internal.h       | 4 ++--
> 
> SourceLevelDebugPkg/Library/DebugCommunicationLibSerialPort/DebugCom
> municationLibSerialPort.c   | 2 +-
> 
> SourceLevelDebugPkg/Library/DebugCommunicationLibUsb3/DebugCommunic
> ationLibUsb3Common.c         | 2 +-
> 
> SourceLevelDebugPkg/Library/DebugCommunicationLibUsb3/DebugCommunic
> ationLibUsb3Dxe.c            | 2 +-
> 
> SourceLevelDebugPkg/Library/DebugCommunicationLibUsb3/DebugCommunic
> ationLibUsb3Transfer.c       | 4 ++--
> 
> SourceLevelDebugPkg/Library/DebugCommunicationLibSerialPort/DebugCom
> municationLibSerialPort.uni | 2 +-
>  8 files changed, 10 insertions(+), 10 deletions(-)
> 
> diff --git
> a/SourceLevelDebugPkg/Library/DebugCommunicationLibSerialPort/DebugCo
> mmunicationLibSerialPort.inf
> b/SourceLevelDebugPkg/Library/DebugCommunicationLibSerialPort/DebugCo
> mmunicationLibSerialPort.inf
> index 668e0bef178e..21af18cfb0b0 100644
> ---
> a/SourceLevelDebugPkg/Library/DebugCommunicationLibSerialPort/DebugCo
> mmunicationLibSerialPort.inf
> +++
> b/SourceLevelDebugPkg/Library/DebugCommunicationLibSerialPort/DebugCo
> mmunicationLibSerialPort.inf
> @@ -1,5 +1,5 @@
>  ## @file
> -#  Debug Communication Library instance based on serila port.
> +#  Debug Communication Library instance based on serial port.
>  #
>  #  Copyright (c) 2010 - 2014, Intel Corporation. All rights reserved.<BR>
>  #
> diff --git a/SourceLevelDebugPkg/Include/Library/DebugCommunicationLib.h
> b/SourceLevelDebugPkg/Include/Library/DebugCommunicationLib.h
> index bc7a00b537c7..73e0f19f92a9 100644
> --- a/SourceLevelDebugPkg/Include/Library/DebugCommunicationLib.h
> +++ b/SourceLevelDebugPkg/Include/Library/DebugCommunicationLib.h
> @@ -30,7 +30,7 @@ VOID
>  /**
>    Initialize the debug port.
> 
> -  This function will initialize debug port to get it ready for data transmition. If
> +  This function will initialize debug port to get it ready for data transmission. If
>    certain Debug Communication Library instance has to save some private data
> in the
>    stack, this function must work on the mode that doesn't return to the caller,
> then
>    the caller needs to wrap up all rest of logic after DebugPortInitialize() into
> one
> diff --git
> a/SourceLevelDebugPkg/Library/DebugCommunicationLibUsb3/DebugCommun
> icationLibUsb3Internal.h
> b/SourceLevelDebugPkg/Library/DebugCommunicationLibUsb3/DebugCommun
> icationLibUsb3Internal.h
> index 72ed2c74162f..df50220f33dc 100644
> ---
> a/SourceLevelDebugPkg/Library/DebugCommunicationLibUsb3/DebugCommun
> icationLibUsb3Internal.h
> +++
> b/SourceLevelDebugPkg/Library/DebugCommunicationLibUsb3/DebugCommun
> icationLibUsb3Internal.h
> @@ -85,7 +85,7 @@
>  #define XHC_DEBUG_PORT_ON_OFF_DELAY    100000
> 
>  //
> -// USB debug device string descritpor (header size + unicode string length)
> +// USB debug device string descriptor (header size + unicode string length)
>  //
>  #define STRING0_DESC_LEN      4
>  #define MANU_DESC_LEN         12
> @@ -680,7 +680,7 @@ USB3InitializeReal (
>    @param  Direction             The direction of data transfer.
>    @param  Data                  Array of pointers to the buffers of data to transmit
>                                  from or receive into.
> -  @param  DataLength            The lenght of the data buffer.
> +  @param  DataLength            The length of the data buffer.
>    @param  Timeout               Indicates the maximum time, in millisecond,
> which
>                                  the transfer is allowed to complete.
> 
> diff --git
> a/SourceLevelDebugPkg/Library/DebugCommunicationLibSerialPort/DebugCo
> mmunicationLibSerialPort.c
> b/SourceLevelDebugPkg/Library/DebugCommunicationLibSerialPort/DebugCo
> mmunicationLibSerialPort.c
> index 604c7e6d52ce..045026508e80 100644
> ---
> a/SourceLevelDebugPkg/Library/DebugCommunicationLibSerialPort/DebugCo
> mmunicationLibSerialPort.c
> +++
> b/SourceLevelDebugPkg/Library/DebugCommunicationLibSerialPort/DebugCo
> mmunicationLibSerialPort.c
> @@ -15,7 +15,7 @@
>  /**
>    Initialize the debug port.
> 
> -  This function will initialize debug port to get it ready for data transmition. If
> +  This function will initialize debug port to get it ready for data transmission. If
>    certain Debug Communication Library instance has to save some private data
> in the
>    stack, this function must work on the mode that doesn't return to the caller,
> then
>    the caller needs to wrap up all rest of logic after DebugPortInitialize() into
> one
> diff --git
> a/SourceLevelDebugPkg/Library/DebugCommunicationLibUsb3/DebugCommun
> icationLibUsb3Common.c
> b/SourceLevelDebugPkg/Library/DebugCommunicationLibUsb3/DebugCommun
> icationLibUsb3Common.c
> index 4e49a7437f8b..d76314a42ae6 100644
> ---
> a/SourceLevelDebugPkg/Library/DebugCommunicationLibUsb3/DebugCommun
> icationLibUsb3Common.c
> +++
> b/SourceLevelDebugPkg/Library/DebugCommunicationLibUsb3/DebugCommun
> icationLibUsb3Common.c
> @@ -162,7 +162,7 @@ XhcClearDebugRegBit (
>  }
> 
>  /**
> -  Program and eanble XHCI MMIO base address.
> +  Program and enable XHCI MMIO base address.
> 
>    @return XHCI MMIO base address.
> 
> diff --git
> a/SourceLevelDebugPkg/Library/DebugCommunicationLibUsb3/DebugCommun
> icationLibUsb3Dxe.c
> b/SourceLevelDebugPkg/Library/DebugCommunicationLibUsb3/DebugCommun
> icationLibUsb3Dxe.c
> index d4245465ce74..d2ff2d52a70f 100644
> ---
> a/SourceLevelDebugPkg/Library/DebugCommunicationLibUsb3/DebugCommun
> icationLibUsb3Dxe.c
> +++
> b/SourceLevelDebugPkg/Library/DebugCommunicationLibUsb3/DebugCommun
> icationLibUsb3Dxe.c
> @@ -25,7 +25,7 @@ EFI_PCI_IO_PROTOCOL         *mUsb3PciIo = NULL;
>  /**
>    Creates a named event that can be signaled.
> 
> -  This function creates an event using NotifyTpl, NoifyFunction.
> +  This function creates an event using NotifyTpl, NotifyFunction.
>    If Name is NULL, then ASSERT().
>    If NotifyTpl is not a legal TPL value, then ASSERT().
>    If NotifyFunction is NULL, then ASSERT().
> diff --git
> a/SourceLevelDebugPkg/Library/DebugCommunicationLibUsb3/DebugCommun
> icationLibUsb3Transfer.c
> b/SourceLevelDebugPkg/Library/DebugCommunicationLibUsb3/DebugCommun
> icationLibUsb3Transfer.c
> index a3e3c134d8f1..262cfab3fbb4 100644
> ---
> a/SourceLevelDebugPkg/Library/DebugCommunicationLibUsb3/DebugCommun
> icationLibUsb3Transfer.c
> +++
> b/SourceLevelDebugPkg/Library/DebugCommunicationLibUsb3/DebugCommun
> icationLibUsb3Transfer.c
> @@ -152,7 +152,7 @@ XhcCheckNewEvent (
> 
>    EvtRing->EventRingDequeue += sizeof (TRB_TEMPLATE);
>    //
> -  // If the dequeue pointer is beyond the ring, then roll-back it to the begining
> of the ring.
> +  // If the dequeue pointer is beyond the ring, then roll-back it to the beginning
> of the ring.
>    //
>    if ((UINTN)EvtRing->EventRingDequeue >= ((UINTN) EvtRing->EventRingSeg0
> + sizeof (TRB_TEMPLATE) * EvtRing->TrbNumber)) {
>      EvtRing->EventRingDequeue = EvtRing->EventRingSeg0;
> @@ -510,7 +510,7 @@ XhcCreateUrb (
>    @param  Direction             The direction of data transfer.
>    @param  Data                  Array of pointers to the buffers of data to transmit
>                                  from or receive into.
> -  @param  DataLength            The lenght of the data buffer.
> +  @param  DataLength            The length of the data buffer.
>    @param  Timeout               Indicates the maximum time, in microsecond,
> which
>                                  the transfer is allowed to complete.
> 
> diff --git
> a/SourceLevelDebugPkg/Library/DebugCommunicationLibSerialPort/DebugCo
> mmunicationLibSerialPort.uni
> b/SourceLevelDebugPkg/Library/DebugCommunicationLibSerialPort/DebugCo
> mmunicationLibSerialPort.uni
> index f8e46fcfaef8..4bea6d51e032 100644
> ---
> a/SourceLevelDebugPkg/Library/DebugCommunicationLibSerialPort/DebugCo
> mmunicationLibSerialPort.uni
> +++
> b/SourceLevelDebugPkg/Library/DebugCommunicationLibSerialPort/DebugCo
> mmunicationLibSerialPort.uni
> @@ -1,5 +1,5 @@
>  // /** @file
> -// Debug Communication Library instance based on serila port.
> +// Debug Communication Library instance based on serial port.
>  //
>  // Debug Communication Library instance based on serial port.
>  //
> --
> 2.21.0