NetworkPkg/TcpDxe/Sock: Fix few typos

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>
Signed-off-by: Antoine Coeur <coeur@gmx.fr>
Reviewed-by: Philippe Mathieu-Daude <philmd@redhat.com>
Reviewed-by: Maciej Rabeda <maciej.rabeda@intel.com>
Signed-off-by: Philippe Mathieu-Daude <philmd@redhat.com>
Message-Id: <20200207010831.9046-48-philmd@redhat.com>

diff --git a/NetworkPkg/TcpDxe/SockImpl.c b/NetworkPkg/TcpDxe/SockImpl.c
index fb28e2ed40d3a31e791d99f05165d20b477f2203..564e621ef93b9905989c23b597336f317bacd9e2 100644 (file)
--- 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\r
                                     store the received data in the socket layer.\r
 \r
-  @return The length of the data can be retreived.\r
+  @return The length of the data can be retrieved.\r
 \r
 **/\r
 UINT32\r
@@ -270,7 +270,7 @@ SockProcessSndToken (
       );\r
 \r
     //\r
-    // Proceess it in the light of SockType\r
+    // Process it in the light of SockType\r
     //\r
     SndToken  = (SOCK_IO_TOKEN *) SockToken->Token;\r
     TxData    = SndToken->Packet.TxData;\r

diff --git a/NetworkPkg/TcpDxe/SockImpl.h b/NetworkPkg/TcpDxe/SockImpl.h
index f255b2fb5fadc874b257e9b42626ae66372822f7..5ec0435592d734368feda1d4f2bcc4b97d2f22a1 100644 (file)
--- a/NetworkPkg/TcpDxe/SockImpl.h
+++ b/NetworkPkg/TcpDxe/SockImpl.h
@@ -93,7 +93,7 @@ SockCancelToken (
 \r
   @param[in]  SockInitData          Pointer to the initial data of the socket.\r
 \r
-  @return Pointer to the newly created socket, return NULL when exception occured.\r
+  @return Pointer to the newly created socket, return NULL when exception occurred.\r
 \r
 **/\r
 SOCKET *\r

diff --git a/NetworkPkg/TcpDxe/SockInterface.c b/NetworkPkg/TcpDxe/SockInterface.c
index ed0a031d39640384a58e3b308535b6c73ebe6ac5..6217eb52dac519826fb2e1026baf47697c747af7 100644 (file)
--- a/NetworkPkg/TcpDxe/SockInterface.c
+++ b/NetworkPkg/TcpDxe/SockInterface.c
@@ -255,12 +255,12 @@ SockDestroyChild (
 \r
 /**\r
   Create a socket and its associated protocol control block\r
-  with the intial data SockInitData and protocol specific\r
+  with the initial data SockInitData and protocol specific\r
   data ProtoData.\r
 \r
-  @param[in]  SockInitData         Inital data to setting the socket.\r
+  @param[in]  SockInitData         Initial data to setting the socket.\r
 \r
-  @return Pointer to the newly created socket. If NULL, an error condition occured.\r
+  @return Pointer to the newly created socket. If NULL, an error condition occurred.\r
 \r
 **/\r
 SOCKET *\r
@@ -397,7 +397,7 @@ OnExit:
 /**\r
   Initiate a connection establishment process.\r
 \r
-  @param[in]  Sock             Pointer to the socket to initiate the initate the\r
+  @param[in]  Sock             Pointer to the socket to initiate the\r
                                connection.\r
   @param[in]  Token            Pointer to the token used for the connection\r
                                operation.\r
@@ -474,7 +474,7 @@ OnExit:
   @param[in]  Sock             Pointer to the socket to accept connections.\r
   @param[in]  Token            The token to accept a connection.\r
 \r
-  @retval EFI_SUCCESS          Either a connection is accpeted or the Token is\r
+  @retval EFI_SUCCESS          Either a connection is accepted or the Token is\r
                                buffered for further acception.\r
   @retval EFI_ACCESS_DENIED    Failed to get the lock to access the socket, or the\r
                                socket is closed, or the socket is not configured to\r

diff --git a/NetworkPkg/TcpDxe/Socket.h b/NetworkPkg/TcpDxe/Socket.h
index 874708ea575a44009712e5dff5e42e6aa8fe15d6..9448710a916a9010281978735cf40e462b6a76cf 100644 (file)
--- a/NetworkPkg/TcpDxe/Socket.h
+++ b/NetworkPkg/TcpDxe/Socket.h
@@ -107,8 +107,8 @@
 \r
   @param[in]  Sock           Pointer to the socket.\r
 \r
-  @retval TRUE               The socket is unconfigued.\r
-  @retval FALSE              The socket is not unconfigued.\r
+  @retval TRUE               The socket is unconfigured.\r
+  @retval FALSE              The socket is not unconfigured.\r
 \r
 **/\r
 #define SOCK_IS_UNCONFIGURED(Sock)  ((Sock)->ConfigureState == SO_UNCONFIGURED)\r
@@ -118,8 +118,8 @@
 \r
   @param[in] Sock            Pointer to the socket\r
 \r
-  @retval TRUE               The socket is configued\r
-  @retval FALSE              The socket is not configued\r
+  @retval TRUE               The socket is configured\r
+  @retval FALSE              The socket is not configured\r
 \r
 **/\r
 #define SOCK_IS_CONFIGURED(Sock) \\r
@@ -131,8 +131,8 @@
 \r
   @param[in] Sock            Pointer to the socket.\r
 \r
-  @retval TRUE               The socket is configued to active mode.\r
-  @retval FALSE              The socket is not configued to active mode.\r
+  @retval TRUE               The socket is configured to active mode.\r
+  @retval FALSE              The socket is not configured to active mode.\r
 \r
 **/\r
 #define SOCK_IS_CONFIGURED_ACTIVE(Sock) ((Sock)->ConfigureState == SO_CONFIGURED_ACTIVE)\r
@@ -142,8 +142,8 @@
 \r
   @param[in] Sock            Pointer to the socket.\r
 \r
-  @retval TRUE               The socket is configued to passive mode.\r
-  @retval FALSE              The socket is not configued to passive mode.\r
+  @retval TRUE               The socket is configured to passive mode.\r
+  @retval FALSE              The socket is not configured to passive mode.\r
 \r
 **/\r
 #define SOCK_IS_CONNECTED_PASSIVE(Sock) ((Sock)->ConfigureState == SO_CONFIGURED_PASSIVE)\r
@@ -380,13 +380,13 @@ EFI_STATUS
   );\r
 \r
 /**\r
-  The Callback funtion called after the TCP socket is created.\r
+  The Callback function called after the TCP socket is created.\r
 \r
   @param[in]  This            Pointer to the socket just created.\r
   @param[in]  Context         Context of the socket.\r
 \r
   @retval EFI_SUCCESS         This protocol installed successfully.\r
-  @retval other               Some error occured.\r
+  @retval other               Some error occurred.\r
 \r
 **/\r
 typedef\r
@@ -429,7 +429,7 @@ typedef struct _SOCK_INIT_DATA {
   // Callbacks after socket is created and before socket is to be destroyed.\r
   //\r
   SOCK_CREATE_CALLBACK   CreateCallback;  ///< Callback after created\r
-  SOCK_DESTROY_CALLBACK  DestroyCallback; ///< Callback before destroied\r
+  SOCK_DESTROY_CALLBACK  DestroyCallback; ///< Callback before destroyed\r
   VOID                   *Context;        ///< The context of the callback\r
 \r
   //\r
@@ -501,7 +501,7 @@ struct _TCP_SOCKET {
   // Callbacks after socket is created and before socket is to be destroyed.\r
   //\r
   SOCK_CREATE_CALLBACK      CreateCallback;   ///< Callback after created\r
-  SOCK_DESTROY_CALLBACK     DestroyCallback;  ///< Callback before destroied\r
+  SOCK_DESTROY_CALLBACK     DestroyCallback;  ///< Callback before destroyed\r
   VOID                      *Context;         ///< The context of the callback\r
 };\r
 \r
@@ -512,7 +512,7 @@ typedef struct _SOCK_TOKEN {
   LIST_ENTRY            TokenList;      ///< The entry to add in the token list\r
   SOCK_COMPLETION_TOKEN *Token;         ///< The application's token\r
   UINT32                RemainDataLen;  ///< Unprocessed data length\r
-  SOCKET                *Sock;          ///< The poninter to the socket this token\r
+  SOCKET                *Sock;          ///< The pointer to the socket this token\r
                                         ///< belongs to\r
 } SOCK_TOKEN;\r
 \r
@@ -524,7 +524,7 @@ typedef struct _TCP_RSV_DATA {
 } TCP_RSV_DATA;\r
 \r
 //\r
-// Socket provided oprerations for low layer protocol implemented in SockImpl.c\r
+// Socket provided operations for low layer protocol implemented in SockImpl.c\r
 //\r
 \r
 /**\r
@@ -676,12 +676,12 @@ SockNoMoreData (
 \r
 /**\r
   Create a socket and its associated protocol control block\r
-  with the intial data SockInitData and protocol specific\r
+  with the initial data SockInitData and protocol specific\r
   data ProtoData.\r
 \r
-  @param[in]  SockInitData         Inital data to setting the socket.\r
+  @param[in]  SockInitData         Initial data to setting the socket.\r
 \r
-  @return Pointer to the newly created socket. If NULL, an error condition occured.\r
+  @return Pointer to the newly created socket. If NULL, an error condition occurred.\r
 \r
 **/\r
 SOCKET *\r
@@ -723,7 +723,7 @@ SockConfigure (
 /**\r
   Initiate a connection establishment process.\r
 \r
-  @param[in]  Sock             Pointer to the socket to initiate the initate the\r
+  @param[in]  Sock             Pointer to the socket to initiate the\r
                                connection.\r
   @param[in]  Token            Pointer to the token used for the connection\r
                                operation.\r