From: Jiaxin Wu <Jiaxin.wu@intel.com>
Date: Tue, 25 Sep 2018 03:34:10 +0000 (+0800)
Subject: MdeModulePkg/Tcp4Dxe: Add the clarification compared to TcpDxe in NetworkPkg.
X-Git-Tag: edk2-stable201903~952
X-Git-Url: https://git.proxmox.com/?p=mirror_edk2.git;a=commitdiff_plain;h=18e205754d78a55ca32e25f3e21125ea8caf7424

MdeModulePkg/Tcp4Dxe: Add the clarification compared to TcpDxe in NetworkPkg.

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>
Reviewed-by: Laszlo Ersek <lersek@redhat.com>
---

diff --git a/MdeModulePkg/Universal/Network/Tcp4Dxe/Tcp4Dxe.inf b/MdeModulePkg/Universal/Network/Tcp4Dxe/Tcp4Dxe.inf
index b54321caaa..fb7f4f8502 100644
--- a/MdeModulePkg/Universal/Network/Tcp4Dxe/Tcp4Dxe.inf
+++ b/MdeModulePkg/Universal/Network/Tcp4Dxe/Tcp4Dxe.inf
@@ -2,7 +2,17 @@
 #  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 fewer features than the TcpDxe driver in NetworkPkg (e.g. IPv6, 
+#     TCP Cancel function).
+#  4) TcpDxe driver in NetworkPkg is recommended for use instead of this one even though
+#     both of them can be used.
 #
 #  Copyright (c) 2006 - 2018, Intel Corporation. All rights reserved.<BR>
 #  This program and the accompanying materials