Re: [Patch 1/6] MdeModulePkg/Tcp4Dxe: Add the clarification compared to TcpDxe in NetworkPkg.

[Laszlo Ersek <lersek@redhat.com>]

On 09/25/18 05:44, Jiaxin Wu wrote:
> Ref: https://bugzilla.tianocore.org/show_bug.cgi?id=1205
> 
> This patch is to add the driver usage/difference clarification
> compared to TcpDxe in NetworkPkg.
> 
> Cc: Ye Ting <ting.ye@intel.com>
> Cc: Fu Siyuan <siyuan.fu@intel.com>
> Cc: Laszlo Ersek <lersek@redhat.com>
> Contributed-under: TianoCore Contribution Agreement 1.1
> Signed-off-by: Wu Jiaxin <jiaxin.wu@intel.com>
> ---
>  MdeModulePkg/Universal/Network/Tcp4Dxe/Tcp4Dxe.inf | 12 +++++++++++-
>  1 file changed, 11 insertions(+), 1 deletion(-)
> 
> diff --git a/MdeModulePkg/Universal/Network/Tcp4Dxe/Tcp4Dxe.inf b/MdeModulePkg/Universal/Network/Tcp4Dxe/Tcp4Dxe.inf
> index b54321caaa..0561eb7421 100644
> --- a/MdeModulePkg/Universal/Network/Tcp4Dxe/Tcp4Dxe.inf
> +++ b/MdeModulePkg/Universal/Network/Tcp4Dxe/Tcp4Dxe.inf
> @@ -1,10 +1,20 @@
>  ## @file
>  #  This module produces EFI TCPv4 Protocol and EFI TCPv4 Service Binding Protocol.
>  #
>  #  This module produces EFI TCPv4(Transmission Control Protocol version 4) Protocol
> -#  upon EFI IPv4 Protocol, to provide basic TCPv4 I/O services.
> +#  upon EFI IPv4 Protocol, to provide basic TCPv4 I/O services. This driver only 
> +#  supports IPv4 network stack.
> +#
> +#  Notes: 
> +#  1) This driver can't co-work with the TcpDxe driver in NetworkPkg. 
> +#  2) This driver might have some issues that have been fixed in the TcpDxe driver 
> +#     in NetworkPkg. 
> +#  3) This driver supports less feature than the TcpDxe driver in NetworkPkg (e.g. IPv6, 
> +#     TCP Cancel function). 
> +#  4) TcpDxe driver in NetworkPkg is recommanded to use instead of this one even both 
> +#     of them can be used.

Sorry, a few more suggestions:

- "recommanded to use" --> "recommended for use" (both typo fix and
grammar fix)

- "even" --> "even though".

Anyway I don't think it's necessary to repost the patch just because of
this.

Thanks!
Laszlo



>  #
>  #  Copyright (c) 2006 - 2018, Intel Corporation. All rights reserved.<BR>
>  #  This program and the accompanying materials
>  #  are licensed and made available under the terms and conditions of the BSD License
>  #  which accompanies this distribution. The full text of the license may be found at
>