From mboxrd@z Thu Jan 1 00:00:00 1970 Received: from us-smtp-1.mimecast.com (us-smtp-1.mimecast.com [207.211.31.120]) by mx.groups.io with SMTP id smtpd.web12.1991.1578044466687527532 for ; Fri, 03 Jan 2020 01:41:06 -0800 Authentication-Results: mx.groups.io; dkim=pass header.i=@redhat.com header.s=mimecast20190719 header.b=ZZ7EL++Y; spf=pass (domain: redhat.com, ip: 207.211.31.120, mailfrom: philmd@redhat.com) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=redhat.com; s=mimecast20190719; t=1578044465; h=from:from:reply-to:subject:subject:date:date:message-id:message-id: to:to:cc:cc:mime-version:mime-version:content-type:content-type: content-transfer-encoding:content-transfer-encoding: in-reply-to:in-reply-to:references:references; bh=SjPeCwsNMUoasLnO4WaOyIpitri+SjhsG6JuhtavEBY=; b=ZZ7EL++YlVT1q/vWPCRzbnYmwHYR53kia1IZIoZ5kpCaW0h7TtmkOBGszAXJ6V8J++nMAt O12ksIwNDWjp3DEf4rhFgchS7TAVmrqo45XWza+eNrh6a/YwXVdCTMhB9twZdveYPj4NFN OxtN7Tpmgk1sH47XfsOTHOjM8MyuUGs= Received: from mimecast-mx01.redhat.com (mimecast-mx01.redhat.com [209.132.183.4]) (Using TLS) by relay.mimecast.com with ESMTP id us-mta-271-mcyM1zXjPlau_xhaHUE1oA-1; Fri, 03 Jan 2020 04:41:04 -0500 Received: from smtp.corp.redhat.com (int-mx02.intmail.prod.int.phx2.redhat.com [10.5.11.12]) (using TLSv1.2 with cipher AECDH-AES256-SHA (256/256 bits)) (No client certificate requested) by mimecast-mx01.redhat.com (Postfix) with ESMTPS id 78056800D4C; Fri, 3 Jan 2020 09:41:02 +0000 (UTC) Received: from x1w.redhat.com (ovpn-116-190.ams2.redhat.com [10.36.116.190]) by smtp.corp.redhat.com (Postfix) with ESMTPS id 8B8A760BF7; Fri, 3 Jan 2020 09:41:00 +0000 (UTC) From: =?UTF-8?B?UGhpbGlwcGUgTWF0aGlldS1EYXVkw6k=?= To: devel@edk2.groups.io Cc: Antoine Coeur , Jiaxin Wu , Siyuan Fu , Maciej Rabeda , Philippe Mathieu-Daude Subject: [PATCH v2 47/78] NetworkPkg/TcpDxe/Sock: Fix few typos Date: Fri, 3 Jan 2020 10:07:41 +0100 Message-Id: <20200103090812.10592-48-philmd@redhat.com> In-Reply-To: <20200103090812.10592-1-philmd@redhat.com> References: <20200103090812.10592-1-philmd@redhat.com> MIME-Version: 1.0 X-Scanned-By: MIMEDefang 2.79 on 10.5.11.12 X-MC-Unique: mcyM1zXjPlau_xhaHUE1oA-1 X-Mimecast-Spam-Score: 0 Content-Type: text/plain; charset="utf-8" Content-Transfer-Encoding: quoted-printable From: Antoine Coeur Fix few typos in comments and documentation. Cc: Jiaxin Wu Cc: Siyuan Fu Cc: Maciej Rabeda Signed-off-by: Antoine Coeur Reviewed-by: Philippe Mathieu-Daude Reviewed-by: Maciej Rabeda Signed-off-by: Philippe Mathieu-Daude --- 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 ( =20 @param[in] SockInitData Pointer to the initial data of the soc= ket. =20 - @return Pointer to the newly created socket, return NULL when exception = occured. + @return Pointer to the newly created socket, return NULL when exception = occurred. =20 **/ 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 @@ =20 @param[in] Sock Pointer to the socket. =20 - @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. =20 **/ #define SOCK_IS_UNCONFIGURED(Sock) ((Sock)->ConfigureState =3D=3D SO_UNCO= NFIGURED) @@ -118,8 +118,8 @@ =20 @param[in] Sock Pointer to the socket =20 - @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 =20 **/ #define SOCK_IS_CONFIGURED(Sock) \ @@ -131,8 +131,8 @@ =20 @param[in] Sock Pointer to the socket. =20 - @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. =20 **/ #define SOCK_IS_CONFIGURED_ACTIVE(Sock) ((Sock)->ConfigureState =3D=3D SO_= CONFIGURED_ACTIVE) @@ -142,8 +142,8 @@ =20 @param[in] Sock Pointer to the socket. =20 - @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. =20 **/ #define SOCK_IS_CONNECTED_PASSIVE(Sock) ((Sock)->ConfigureState =3D=3D SO_= CONFIGURED_PASSIVE) @@ -380,13 +380,13 @@ EFI_STATUS ); =20 /** - The Callback funtion called after the TCP socket is created. + The Callback function called after the TCP socket is created. =20 @param[in] This Pointer to the socket just created. @param[in] Context Context of the socket. =20 @retval EFI_SUCCESS This protocol installed successfully. - @retval other Some error occured. + @retval other Some error occurred. =20 **/ typedef @@ -429,7 +429,7 @@ typedef struct _SOCK_INIT_DATA { // Callbacks after socket is created and before socket is to be destroye= d. // 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 =20 // @@ -501,7 +501,7 @@ struct _TCP_SOCKET { // Callbacks after socket is created and before socket is to be destroye= d. // SOCK_CREATE_CALLBACK CreateCallback; ///< Callback after created - SOCK_DESTROY_CALLBACK DestroyCallback; ///< Callback before destroi= ed + SOCK_DESTROY_CALLBACK DestroyCallback; ///< Callback before destroy= ed VOID *Context; ///< The context of the call= back }; =20 @@ -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 th= is token + SOCKET *Sock; ///< The pointer to the socket thi= s token ///< belongs to } SOCK_TOKEN; =20 @@ -524,7 +524,7 @@ typedef struct _TCP_RSV_DATA { } TCP_RSV_DATA; =20 // -// Socket provided oprerations for low layer protocol implemented in SockI= mpl.c +// Socket provided operations for low layer protocol implemented in SockIm= pl.c // =20 /** @@ -676,12 +676,12 @@ SockNoMoreData ( =20 /** 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. =20 - @param[in] SockInitData Inital data to setting the socket. + @param[in] SockInitData Initial data to setting the socket. =20 - @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. =20 **/ SOCKET * @@ -723,7 +723,7 @@ SockConfigure ( /** Initiate a connection establishment process. =20 - @param[in] Sock Pointer to the socket to initiate the inita= te the + @param[in] Sock Pointer to the socket to initiate the connection. @param[in] Token Pointer to the token used for the connectio= n 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. =20 - @return The length of the data can be retreived. + @return The length of the data can be retrieved. =20 **/ UINT32 @@ -270,7 +270,7 @@ SockProcessSndToken ( ); =20 // - // Proceess it in the light of SockType + // Process it in the light of SockType // SndToken =3D (SOCK_IO_TOKEN *) SockToken->Token; TxData =3D SndToken->Packet.TxData; diff --git a/NetworkPkg/TcpDxe/SockInterface.c b/NetworkPkg/TcpDxe/SockInte= rface.c index ed0a031d3964..6217eb52dac5 100644 --- a/NetworkPkg/TcpDxe/SockInterface.c +++ b/NetworkPkg/TcpDxe/SockInterface.c @@ -255,12 +255,12 @@ SockDestroyChild ( =20 /** 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. =20 - @param[in] SockInitData Inital data to setting the socket. + @param[in] SockInitData Initial data to setting the socket. =20 - @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. =20 **/ SOCKET * @@ -397,7 +397,7 @@ OnExit: /** Initiate a connection establishment process. =20 - @param[in] Sock Pointer to the socket to initiate the inita= te the + @param[in] Sock Pointer to the socket to initiate the connection. @param[in] Token Pointer to the token used for the connectio= n 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. =20 - @retval EFI_SUCCESS Either a connection is accpeted or the Toke= n is + @retval EFI_SUCCESS Either a connection is accepted or the Toke= n 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 conf= igured to --=20 2.21.0