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 b54321caaa617aa68481833fc06967a5cf8ffbf6..fb7f4f85028d269dc7056178225e5fb9b23c7d5c 100644 (file)
--- 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.\r
 #\r
 #  This module produces EFI TCPv4(Transmission Control Protocol version 4) Protocol\r
-#  upon EFI IPv4 Protocol, to provide basic TCPv4 I/O services.\r
+#  upon EFI IPv4 Protocol, to provide basic TCPv4 I/O services. This driver only \r
+#  supports IPv4 network stack.\r
+#\r
+#  Notes:\r
+#  1) This driver can't co-work with the TcpDxe driver in NetworkPkg.\r
+#  2) This driver might have some issues that have been fixed in the TcpDxe driver \r
+#     in NetworkPkg.\r
+#  3) This driver supports fewer features than the TcpDxe driver in NetworkPkg (e.g. IPv6, \r
+#     TCP Cancel function).\r
+#  4) TcpDxe driver in NetworkPkg is recommended for use instead of this one even though\r
+#     both of them can be used.\r
 #\r
 #  Copyright (c) 2006 - 2018, Intel Corporation. All rights reserved.<BR>\r
 #  This program and the accompanying materials\r