Re: [PATCH 40/79] NetworkPkg/HttpDxe: Fix various typos

["Rabeda, Maciej" <maciej.rabeda@intel.com>]

Reviewed-by: Maciej Rabeda <maciej.rabeda@intel.com>

Thanks!
Maciej

-----Original Message-----
From: Philippe Mathieu-Daude <philmd@redhat.com> 
Sent: Tuesday, December 3, 2019 17:15
To: devel@edk2.groups.io
Cc: Antoine Coeur <coeur@gmx.fr>; Wu, Jiaxin <jiaxin.wu@intel.com>; Fu, Siyuan <siyuan.fu@intel.com>; Rabeda, Maciej <maciej.rabeda@intel.com>; Philippe Mathieu-Daude <philmd@redhat.com>
Subject: [PATCH 40/79] NetworkPkg/HttpDxe: Fix various typos

From: Antoine Coeur <coeur@gmx.fr>

Fix various typos in comments and documentation.

Cc: Jiaxin Wu <jiaxin.wu@intel.com>
Cc: Siyuan Fu <siyuan.fu@intel.com>
Cc: Maciej Rabeda <maciej.rabeda@intel.com>
Reviewed-by: Philippe Mathieu-Daude <philmd@redhat.com>
Signed-off-by: Philippe Mathieu-Daude <philmd@redhat.com>
---
 NetworkPkg/HttpDxe/HttpDriver.h   |  8 +++----
 NetworkPkg/HttpDxe/HttpProto.h    | 16 +++++++-------
 NetworkPkg/HttpDxe/HttpsSupport.h |  2 +-
 NetworkPkg/HttpDxe/HttpDriver.c   | 12 +++++------
 NetworkPkg/HttpDxe/HttpImpl.c     | 10 ++++-----
 NetworkPkg/HttpDxe/HttpProto.c    | 22 ++++++++++----------
 NetworkPkg/HttpDxe/HttpsSupport.c |  2 +-
 7 files changed, 36 insertions(+), 36 deletions(-)

diff --git a/NetworkPkg/HttpDxe/HttpDriver.h b/NetworkPkg/HttpDxe/HttpDriver.h index bd6f658f3c24..5fe8c5b5e9b9 100644
--- a/NetworkPkg/HttpDxe/HttpDriver.h
+++ b/NetworkPkg/HttpDxe/HttpDriver.h
@@ -172,7 +172,7 @@ HttpDxeIp4DriverBindingSupported (
   @retval EFI_SUCCESS              The device was started.
   @retval EFI_DEVICE_ERROR         The device could not be started due to a device error.Currently not implemented.
   @retval EFI_OUT_OF_RESOURCES     The request could not be completed due to a lack of resources.
-  @retval Others                   The driver failded to start the device.
+  @retval Others                   The driver failed to start the device.
 
 **/
 EFI_STATUS
@@ -301,7 +301,7 @@ HttpDxeIp6DriverBindingSupported (
   @retval EFI_ALREADY_STARTED      This device is already running on ControllerHandle.
   @retval EFI_DEVICE_ERROR         The device could not be started due to a device error.Currently not implemented.
   @retval EFI_OUT_OF_RESOURCES     The request could not be completed due to a lack of resources.
-  @retval Others                   The driver failded to start the device.
+  @retval Others                   The driver failed to start the device.
 
 **/
 EFI_STATUS
@@ -359,7 +359,7 @@ HttpDxeIp6DriverBindingStop (
                       then a new handle is created. If it is a pointer to an existing UEFI handle,
                       then the protocol is added to the existing UEFI handle.
 
-  @retval EFI_SUCCES            The protocol was added to ChildHandle.
+  @retval EFI_SUCCESS           The protocol was added to ChildHandle.
   @retval EFI_INVALID_PARAMETER This is NULL, or ChildHandle is NULL.
   @retval EFI_OUT_OF_RESOURCES  There are not enough resources available to create
                                 the child.
@@ -383,7 +383,7 @@ HttpServiceBindingCreateChild (
   @param  This        Pointer to the EFI_SERVICE_BINDING_PROTOCOL instance.
   @param  ChildHandle Handle of the child to destroy
 
-  @retval EFI_SUCCES            The protocol was removed from ChildHandle.
+  @retval EFI_SUCCESS           The protocol was removed from ChildHandle.
   @retval EFI_UNSUPPORTED       ChildHandle does not support the protocol that is being removed.
   @retval EFI_INVALID_PARAMETER Child handle is NULL.
   @retval other                 The child handle was not destroyed
diff --git a/NetworkPkg/HttpDxe/HttpProto.h b/NetworkPkg/HttpDxe/HttpProto.h index 34308e016d3e..00ba26aca49a 100644
--- a/NetworkPkg/HttpDxe/HttpProto.h
+++ b/NetworkPkg/HttpDxe/HttpProto.h
@@ -308,7 +308,7 @@ HttpCloseTcpRxEvent (
   );
 
 /**
-  Intiialize the HTTP_PROTOCOL structure to the unconfigured state.
+  Initialize the HTTP_PROTOCOL structure to the unconfigured state.
 
   @param[in, out]  HttpInstance         Pointer to HTTP_PROTOCOL structure.
   @param[in]       IpVersion            Indicate us TCP4 protocol or TCP6 protocol.
@@ -453,7 +453,7 @@ HttpTransmitTcp (
   @param[in]  Map                The container of either user's transmit or receive
                                  token.
   @param[in]  Item               Current item to check against.
-  @param[in]  Context            The Token to check againist.
+  @param[in]  Context            The Token to check against.
 
   @retval EFI_ACCESS_DENIED      The token or event has already been enqueued in IP
   @retval EFI_SUCCESS            The current item isn't the same token/event as the
@@ -473,7 +473,7 @@ HttpTokenExist (
 
   @param[in]  Map                The container of TxToken.
   @param[in]  Item               Current item to check against.
-  @param[in]  Context            The Token to check againist.
+  @param[in]  Context            The Token to check against.
 
   @retval EFI_NOT_READY          The HTTP message is still queued in the list.
   @retval EFI_SUCCESS            The HTTP message has been sent out.
@@ -508,11 +508,11 @@ HttpInitSession (
   );
 
 /**
-  Transmit the HTTP or HTTPS mssage by processing the associated HTTP token.
+  Transmit the HTTP or HTTPS message by processing the associated HTTP token.
 
   @param[in]  Map                The container of TxToken or Tx6Token.
   @param[in]  Item               Current item to check against.
-  @param[in]  Context            The Token to check againist.
+  @param[in]  Context            The Token to check against.
 
   @retval EFI_OUT_OF_RESOURCES   Failed to allocate resources.
   @retval EFI_SUCCESS            The HTTP message is queued into TCP transmit
@@ -532,7 +532,7 @@ HttpTcpTransmit (
 
   @param[in]  Map                The container of Rx4Token or Rx6Token.
   @param[in]  Item               Current item to check against.
-  @param[in]  Context            The Token to check againist.
+  @param[in]  Context            The Token to check against.
 
   @retval EFI_SUCCESS            The HTTP response is queued into TCP receive
                                  queue.
@@ -552,7 +552,7 @@ HttpTcpReceive (
 
   @param[in]       HttpInstance    The HTTP instance private data.
   @param[in, out]  SizeofHeaders   The HTTP header length.
-  @param[in, out]  BufferSize      The size of buffer to cacahe the header message.
+  @param[in, out]  BufferSize      The size of buffer to cache the header message.
   @param[in]       Timeout         The time to wait for receiving the header packet.
 
   @retval EFI_SUCCESS              The HTTP header is received.
@@ -600,7 +600,7 @@ HttpTcpTokenCleanup (
   @param[in]  Wrap                Pointer to HTTP token's wrap data.
 
   @retval EFI_SUCCESS             Allocation succeeded.
-  @retval EFI_OUT_OF_RESOURCES    Failed to complete the opration due to lack of resources.
+  @retval EFI_OUT_OF_RESOURCES    Failed to complete the operation due to lack of resources.
   @retval EFI_NOT_READY           Can't find a corresponding TxToken.
 
 **/
diff --git a/NetworkPkg/HttpDxe/HttpsSupport.h b/NetworkPkg/HttpDxe/HttpsSupport.h
index 0e16968cd680..6851ceea75a5 100644
--- a/NetworkPkg/HttpDxe/HttpsSupport.h
+++ b/NetworkPkg/HttpDxe/HttpsSupport.h
@@ -149,7 +149,7 @@ TlsCommonReceive (
   );
 
 /**
-  Receive one TLS PDU. An TLS PDU contains an TLS record header and it's
+  Receive one TLS PDU. An TLS PDU contains an TLS record header and its
   corresponding record data. These two parts will be put into two blocks of buffers in the
   net buffer.
 
diff --git a/NetworkPkg/HttpDxe/HttpDriver.c b/NetworkPkg/HttpDxe/HttpDriver.c index 7c64d4215119..a9f5c0949ffe 100644
--- a/NetworkPkg/HttpDxe/HttpDriver.c
+++ b/NetworkPkg/HttpDxe/HttpDriver.c
@@ -78,7 +78,7 @@ HttpCreateService (
   @param[in]  HttpService        The HTTP private instance.
   @param[in]  UsingIpv6          Indicate use TCP4 protocol or TCP6 protocol.
                                  if TRUE, use Tcp6 protocol.
-                                 if FALSE, use Tcp4 protocl.
+                                 if FALSE, use Tcp4 protocol.
 **/
 VOID
 HttpCleanService (
@@ -152,7 +152,7 @@ HttpUtilitiesInstalledCallback (
          );
 
   //
-  // Close the event if Http utilities protocol is loacted.
+  // Close the event if Http utilities protocol is located.
   //
   if (mHttpUtilities != NULL && Event != NULL) {
      gBS->CloseEvent (Event);
@@ -668,7 +668,7 @@ HttpDxeIp4DriverBindingSupported (
   @retval EFI_ALREADY_STARTED      This device is already running on ControllerHandle.
   @retval EFI_DEVICE_ERROR         The device could not be started due to a device error.Currently not implemented.
   @retval EFI_OUT_OF_RESOURCES     The request could not be completed due to a lack of resources.
-  @retval Others                   The driver failded to start the device.
+  @retval Others                   The driver failed to start the device.
 
 **/
 EFI_STATUS
@@ -823,7 +823,7 @@ HttpDxeIp6DriverBindingSupported (
   @retval EFI_ALREADY_STARTED      This device is already running on ControllerHandle.
   @retval EFI_DEVICE_ERROR         The device could not be started due to a device error.Currently not implemented.
   @retval EFI_OUT_OF_RESOURCES     The request could not be completed due to a lack of resources.
-  @retval Others                   The driver failded to start the device.
+  @retval Others                   The driver failed to start the device.
 
 **/
 EFI_STATUS
@@ -897,7 +897,7 @@ HttpDxeIp6DriverBindingStop (
                       then a new handle is created. If it is a pointer to an existing UEFI handle,
                       then the protocol is added to the existing UEFI handle.
 
-  @retval EFI_SUCCES            The protocol was added to ChildHandle.
+  @retval EFI_SUCCESS           The protocol was added to ChildHandle.
   @retval EFI_INVALID_PARAMETER This is NULL, or ChildHandle is NULL.
   @retval EFI_OUT_OF_RESOURCES  There are not enough resources available to create
                                 the child.
@@ -981,7 +981,7 @@ ON_ERROR:
   @param  This        Pointer to the EFI_SERVICE_BINDING_PROTOCOL instance.
   @param  ChildHandle Handle of the child to destroy
 
-  @retval EFI_SUCCES            The protocol was removed from ChildHandle.
+  @retval EFI_SUCCESS           The protocol was removed from ChildHandle.
   @retval EFI_UNSUPPORTED       ChildHandle does not support the protocol that is being removed.
   @retval EFI_INVALID_PARAMETER Child handle is NULL.
   @retval other                 The child handle was not destroyed
diff --git a/NetworkPkg/HttpDxe/HttpImpl.c b/NetworkPkg/HttpDxe/HttpImpl.c index 6b877314bd57..aa77696f0d0d 100644
--- a/NetworkPkg/HttpDxe/HttpImpl.c
+++ b/NetworkPkg/HttpDxe/HttpImpl.c
@@ -188,7 +188,7 @@ EfiHttpConfigure (
 
   } else {
     //
-    // Reset all the resources related to HttpInsance.
+    // Reset all the resources related to HttpInstance.
     //
     HttpCleanProtocol (HttpInstance);
     HttpInstance->State = HTTP_STATE_UNCONFIGED; @@ -756,7 +756,7 @@ HttpCancelTokens (
   if (!HttpInstance->LocalAddressIsIPv6) {
     if (Wrap->TcpWrap.Rx4Token.CompletionToken.Event != NULL) {
       //
-      // Cancle the Token before close its Event.
+      // Cancel the Token before close its Event.
       //
       HttpInstance->Tcp4->Cancel (HttpInstance->Tcp4, &Wrap->TcpWrap.Rx4Token.CompletionToken);
 
@@ -768,7 +768,7 @@ HttpCancelTokens (
   } else {
     if (Wrap->TcpWrap.Rx6Token.CompletionToken.Event != NULL) {
       //
-      // Cancle the Token before close its Event.
+      // Cancel the Token before close its Event.
       //
       HttpInstance->Tcp6->Cancel (HttpInstance->Tcp6, &Wrap->TcpWrap.Rx6Token.CompletionToken);
 
@@ -956,7 +956,7 @@ HttpBodyParserCallback (
   @param[in]  Wrap                Pointer to HTTP token's wrap data.
 
   @retval EFI_SUCCESS             Allocation succeeded.
-  @retval EFI_OUT_OF_RESOURCES    Failed to complete the opration due to lack of resources.
+  @retval EFI_OUT_OF_RESOURCES    Failed to complete the operation due to lack of resources.
   @retval EFI_NOT_READY           Can't find a corresponding Tx4Token/Tx6Token or
                                   the EFI_HTTP_UTILITIES_PROTOCOL is not available.
 
@@ -1284,7 +1284,7 @@ HttpResponseWorker (
         }
       }
       //
-      // Return since we aready received required data.
+      // Return since we already received required data.
       //
       Status = EFI_SUCCESS;
       goto Exit;
diff --git a/NetworkPkg/HttpDxe/HttpProto.c b/NetworkPkg/HttpDxe/HttpProto.c index bacfbc995847..3c7c6ff9f0ce 100644
--- a/NetworkPkg/HttpDxe/HttpProto.c
+++ b/NetworkPkg/HttpDxe/HttpProto.c
@@ -301,7 +301,7 @@ HttpCreateTcpConnCloseEvent (
 
   if (!HttpInstance->LocalAddressIsIPv6) {
     //
-    // Create events for variuos asynchronous operations.
+    // Create events for various asynchronous operations.
     //
     Status = gBS->CreateEvent (
                     EVT_NOTIFY_SIGNAL,
@@ -330,7 +330,7 @@ HttpCreateTcpConnCloseEvent (
 
   } else {
     //
-    // Create events for variuos asynchronous operations.
+    // Create events for various asynchronous operations.
     //
     Status = gBS->CreateEvent (
                     EVT_NOTIFY_SIGNAL,
@@ -618,7 +618,7 @@ HttpCloseTcpRxEvent (  }
 
 /**
-  Intiialize the HTTP_PROTOCOL structure to the unconfigured state.
+  Initialize the HTTP_PROTOCOL structure to the unconfigured state.
 
   @param[in, out]  HttpInstance         Pointer to HTTP_PROTOCOL structure.
   @param[in]       IpVersion            Indicate us TCP4 protocol or TCP6 protocol.
@@ -1636,7 +1636,7 @@ ON_ERROR:
   @param[in]  Map                The container of either user's transmit or receive
                                  token.
   @param[in]  Item               Current item to check against.
-  @param[in]  Context            The Token to check againist.
+  @param[in]  Context            The Token to check against.
 
   @retval EFI_ACCESS_DENIED      The token or event has already been enqueued in IP
   @retval EFI_SUCCESS            The current item isn't the same token/event as the
@@ -1669,7 +1669,7 @@ HttpTokenExist (
 
   @param[in]  Map                The container of Tx4Token or Tx6Token.
   @param[in]  Item               Current item to check against.
-  @param[in]  Context            The Token to check againist.
+  @param[in]  Context            The Token to check against.
 
   @retval EFI_NOT_READY          The HTTP message is still queued in the list.
   @retval EFI_SUCCESS            The HTTP message has been sent out.
@@ -1695,11 +1695,11 @@ HttpTcpNotReady (  }
 
 /**
-  Transmit the HTTP or HTTPS mssage by processing the associated HTTP token.
+  Transmit the HTTP or HTTPS message by processing the associated HTTP token.
 
   @param[in]  Map                The container of Tx4Token or Tx6Token.
   @param[in]  Item               Current item to check against.
-  @param[in]  Context            The Token to check againist.
+  @param[in]  Context            The Token to check against.
 
   @retval EFI_OUT_OF_RESOURCES   Failed to allocate resources.
   @retval EFI_SUCCESS            The HTTP message is queued into TCP transmit
@@ -1774,7 +1774,7 @@ HttpTcpTransmit (
 
   @param[in]  Map                The container of Rx4Token or Rx6Token.
   @param[in]  Item               Current item to check against.
-  @param[in]  Context            The Token to check againist.
+  @param[in]  Context            The Token to check against.
 
   @retval EFI_SUCCESS            The HTTP response is queued into TCP receive
                                  queue.
@@ -1800,7 +1800,7 @@ HttpTcpReceive (
 
   @param[in]       HttpInstance     The HTTP instance private data.
   @param[in, out]  SizeofHeaders    The HTTP header length.
-  @param[in, out]  BufferSize       The size of buffer to cacahe the header message.
+  @param[in, out]  BufferSize       The size of buffer to cache the header message.
   @param[in]       Timeout          The time to wait for receiving the header packet.
 
   @retval EFI_SUCCESS               The HTTP header is received.
@@ -1880,7 +1880,7 @@ HttpTcpReceiveHeader (
 
         if (!HttpInstance->IsRxDone) {
           //
-          // Cancle the Token before close its Event.
+          // Cancel the Token before close its Event.
           //
           Tcp4->Cancel (HttpInstance->Tcp4, &Rx4Token->CompletionToken);
           gBS->CloseEvent (Rx4Token->CompletionToken.Event);
@@ -1980,7 +1980,7 @@ HttpTcpReceiveHeader (
 
         if (!HttpInstance->IsRxDone) {
           //
-          // Cancle the Token before close its Event.
+          // Cancel the Token before close its Event.
           //
           Tcp6->Cancel (HttpInstance->Tcp6, &Rx6Token->CompletionToken);
           gBS->CloseEvent (Rx6Token->CompletionToken.Event);
diff --git a/NetworkPkg/HttpDxe/HttpsSupport.c b/NetworkPkg/HttpDxe/HttpsSupport.c
index 5dfb13bd6021..7e0bf85c3c42 100644
--- a/NetworkPkg/HttpDxe/HttpsSupport.c
+++ b/NetworkPkg/HttpDxe/HttpsSupport.c
@@ -971,7 +971,7 @@ ON_EXIT:
 }
 
 /**
-  Receive one TLS PDU. An TLS PDU contains an TLS record header and it's
+  Receive one TLS PDU. An TLS PDU contains an TLS record header and its
   corresponding record data. These two parts will be put into two blocks of buffers in the
   net buffer.
 
--
2.21.0

--------------------------------------------------------------------

Intel Technology Poland sp. z o.o.
ul. Slowackiego 173 | 80-298 Gdansk | Sad Rejonowy Gdansk Polnoc | VII Wydzial Gospodarczy Krajowego Rejestru Sadowego - KRS 101882 | NIP 957-07-52-316 | Kapital zakladowy 200.000 PLN.

Ta wiadomosc wraz z zalacznikami jest przeznaczona dla okreslonego adresata i moze zawierac informacje poufne. W razie przypadkowego otrzymania tej wiadomosci, prosimy o powiadomienie nadawcy oraz trwale jej usuniecie; jakiekolwiek
przegladanie lub rozpowszechnianie jest zabronione.
This e-mail and any attachments may contain confidential material for the sole use of the intended recipient(s). If you are not the intended recipient, please contact the sender and delete all copies; any review or distribution by
others is strictly prohibited.