Re: [PATCH 49/79] NetworkPkg/TcpDxe/Sock: Fix few 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:16
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 49/79] NetworkPkg/TcpDxe/Sock: Fix few typos

From: Antoine Coeur <coeur@gmx.fr>

Fix few 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/TcpDxe/SockImpl.h      |  2 +-
 NetworkPkg/TcpDxe/Socket.h        | 36 ++++++++++----------
 NetworkPkg/TcpDxe/SockImpl.c      |  4 +--
 NetworkPkg/TcpDxe/SockInterface.c | 10 +++---
 4 files changed, 26 insertions(+), 26 deletions(-)

diff --git a/NetworkPkg/TcpDxe/SockImpl.h b/NetworkPkg/TcpDxe/SockImpl.h index f255b2fb5fad..5ec0435592d7 100644
--- a/NetworkPkg/TcpDxe/SockImpl.h
+++ b/NetworkPkg/TcpDxe/SockImpl.h
@@ -93,7 +93,7 @@ SockCancelToken (
 
   @param[in]  SockInitData          Pointer to the initial data of the socket.
 
-  @return Pointer to the newly created socket, return NULL when exception occured.
+  @return Pointer to the newly created socket, return NULL when exception occurred.
 
 **/
 SOCKET *
diff --git a/NetworkPkg/TcpDxe/Socket.h b/NetworkPkg/TcpDxe/Socket.h index 874708ea575a..9448710a916a 100644
--- a/NetworkPkg/TcpDxe/Socket.h
+++ b/NetworkPkg/TcpDxe/Socket.h
@@ -107,8 +107,8 @@
 
   @param[in]  Sock           Pointer to the socket.
 
-  @retval TRUE               The socket is unconfigued.
-  @retval FALSE              The socket is not unconfigued.
+  @retval TRUE               The socket is unconfigured.
+  @retval FALSE              The socket is not unconfigured.
 
 **/
 #define SOCK_IS_UNCONFIGURED(Sock)  ((Sock)->ConfigureState == SO_UNCONFIGURED) @@ -118,8 +118,8 @@
 
   @param[in] Sock            Pointer to the socket
 
-  @retval TRUE               The socket is configued
-  @retval FALSE              The socket is not configued
+  @retval TRUE               The socket is configured
+  @retval FALSE              The socket is not configured
 
 **/
 #define SOCK_IS_CONFIGURED(Sock) \
@@ -131,8 +131,8 @@
 
   @param[in] Sock            Pointer to the socket.
 
-  @retval TRUE               The socket is configued to active mode.
-  @retval FALSE              The socket is not configued to active mode.
+  @retval TRUE               The socket is configured to active mode.
+  @retval FALSE              The socket is not configured to active mode.
 
 **/
 #define SOCK_IS_CONFIGURED_ACTIVE(Sock) ((Sock)->ConfigureState == SO_CONFIGURED_ACTIVE) @@ -142,8 +142,8 @@
 
   @param[in] Sock            Pointer to the socket.
 
-  @retval TRUE               The socket is configued to passive mode.
-  @retval FALSE              The socket is not configued to passive mode.
+  @retval TRUE               The socket is configured to passive mode.
+  @retval FALSE              The socket is not configured to passive mode.
 
 **/
 #define SOCK_IS_CONNECTED_PASSIVE(Sock) ((Sock)->ConfigureState == SO_CONFIGURED_PASSIVE) @@ -380,13 +380,13 @@ EFI_STATUS
   );
 
 /**
-  The Callback funtion called after the TCP socket is created.
+  The Callback function called after the TCP socket is created.
 
   @param[in]  This            Pointer to the socket just created.
   @param[in]  Context         Context of the socket.
 
   @retval EFI_SUCCESS         This protocol installed successfully.
-  @retval other               Some error occured.
+  @retval other               Some error occurred.
 
 **/
 typedef
@@ -429,7 +429,7 @@ typedef struct _SOCK_INIT_DATA {
   // Callbacks after socket is created and before socket is to be destroyed.
   //
   SOCK_CREATE_CALLBACK   CreateCallback;  ///< Callback after created
-  SOCK_DESTROY_CALLBACK  DestroyCallback; ///< Callback before destroied
+  SOCK_DESTROY_CALLBACK  DestroyCallback; ///< Callback before 
+ destroyed
   VOID                   *Context;        ///< The context of the callback
 
   //
@@ -501,7 +501,7 @@ struct _TCP_SOCKET {
   // Callbacks after socket is created and before socket is to be destroyed.
   //
   SOCK_CREATE_CALLBACK      CreateCallback;   ///< Callback after created
-  SOCK_DESTROY_CALLBACK     DestroyCallback;  ///< Callback before destroied
+  SOCK_DESTROY_CALLBACK     DestroyCallback;  ///< Callback before destroyed
   VOID                      *Context;         ///< The context of the callback
 };
 
@@ -512,7 +512,7 @@ typedef struct _SOCK_TOKEN {
   LIST_ENTRY            TokenList;      ///< The entry to add in the token list
   SOCK_COMPLETION_TOKEN *Token;         ///< The application's token
   UINT32                RemainDataLen;  ///< Unprocessed data length
-  SOCKET                *Sock;          ///< The poninter to the socket this token
+  SOCKET                *Sock;          ///< The pointer to the socket this token
                                         ///< belongs to  } SOCK_TOKEN;
 
@@ -524,7 +524,7 @@ typedef struct _TCP_RSV_DATA {  } TCP_RSV_DATA;
 
 //
-// Socket provided oprerations for low layer protocol implemented in SockImpl.c
+// Socket provided operations for low layer protocol implemented in 
+SockImpl.c
 //
 
 /**
@@ -676,12 +676,12 @@ SockNoMoreData (
 
 /**
   Create a socket and its associated protocol control block
-  with the intial data SockInitData and protocol specific
+  with the initial data SockInitData and protocol specific
   data ProtoData.
 
-  @param[in]  SockInitData         Inital data to setting the socket.
+  @param[in]  SockInitData         Initial data to setting the socket.
 
-  @return Pointer to the newly created socket. If NULL, an error condition occured.
+  @return Pointer to the newly created socket. If NULL, an error condition occurred.
 
 **/
 SOCKET *
@@ -723,7 +723,7 @@ SockConfigure (
 /**
   Initiate a connection establishment process.
 
-  @param[in]  Sock             Pointer to the socket to initiate the initate the
+  @param[in]  Sock             Pointer to the socket to initiate the
                                connection.
   @param[in]  Token            Pointer to the token used for the connection
                                operation.
diff --git a/NetworkPkg/TcpDxe/SockImpl.c b/NetworkPkg/TcpDxe/SockImpl.c index fb28e2ed40d3..564e621ef93b 100644
--- a/NetworkPkg/TcpDxe/SockImpl.c
+++ b/NetworkPkg/TcpDxe/SockImpl.c
@@ -89,7 +89,7 @@ SockFreeFoo (
   @param[in]  BufLen                The maximum length of the data buffer to
                                     store the received data in the socket layer.
 
-  @return The length of the data can be retreived.
+  @return The length of the data can be retrieved.
 
 **/
 UINT32
@@ -270,7 +270,7 @@ SockProcessSndToken (
       );
 
     //
-    // Proceess it in the light of SockType
+    // Process it in the light of SockType
     //
     SndToken  = (SOCK_IO_TOKEN *) SockToken->Token;
     TxData    = SndToken->Packet.TxData;
diff --git a/NetworkPkg/TcpDxe/SockInterface.c b/NetworkPkg/TcpDxe/SockInterface.c
index ed0a031d3964..6217eb52dac5 100644
--- a/NetworkPkg/TcpDxe/SockInterface.c
+++ b/NetworkPkg/TcpDxe/SockInterface.c
@@ -255,12 +255,12 @@ SockDestroyChild (
 
 /**
   Create a socket and its associated protocol control block
-  with the intial data SockInitData and protocol specific
+  with the initial data SockInitData and protocol specific
   data ProtoData.
 
-  @param[in]  SockInitData         Inital data to setting the socket.
+  @param[in]  SockInitData         Initial data to setting the socket.
 
-  @return Pointer to the newly created socket. If NULL, an error condition occured.
+  @return Pointer to the newly created socket. If NULL, an error condition occurred.
 
 **/
 SOCKET *
@@ -397,7 +397,7 @@ OnExit:
 /**
   Initiate a connection establishment process.
 
-  @param[in]  Sock             Pointer to the socket to initiate the initate the
+  @param[in]  Sock             Pointer to the socket to initiate the
                                connection.
   @param[in]  Token            Pointer to the token used for the connection
                                operation.
@@ -474,7 +474,7 @@ OnExit:
   @param[in]  Sock             Pointer to the socket to accept connections.
   @param[in]  Token            The token to accept a connection.
 
-  @retval EFI_SUCCESS          Either a connection is accpeted or the Token is
+  @retval EFI_SUCCESS          Either a connection is accepted or the Token is
                                buffered for further acception.
   @retval EFI_ACCESS_DENIED    Failed to get the lock to access the socket, or the
                                socket is closed, or the socket is not configured to
--
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.