MdeModulePkg/IScsiDxe: Add the clarification compared to IScsiDxe in NetworkPkg.

Ref: https://bugzilla.tianocore.org/show_bug.cgi?id=1205

This patch is to add the driver usage/difference clarification
compared to IScsiDxe 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/IScsiDxe/IScsiDxe.inf b/MdeModulePkg/Universal/Network/IScsiDxe/IScsiDxe.inf
index c3b8c7d15af170e5663d4065dc8958493271dcdc..48729e3029f7df1ee515e787eaca10ebc6765459 100644 (file)
--- a/MdeModulePkg/Universal/Network/IScsiDxe/IScsiDxe.inf
+++ b/MdeModulePkg/Universal/Network/IScsiDxe/IScsiDxe.inf
@@ -4,7 +4,17 @@
 #  This module produces EFI iSCSI Initiator Name Protocol upon EFI TCPv4 Protocol\r
 #  and EFI DHCPv4 Protocol, to provide the capability to do the transport for SCSI\r
 #  data over TCP/IP. It installs EFI HII Configuration Access Protocol to provide\r
-#  one way to configurate the iSCSI setting.\r
+#  one way to configurate the iSCSI setting. This driver only supports IPv4 network\r
+#  stack.\r
+#\r
+#  Notes:\r
+#  1) This driver can't co-work with the IScsiDxe driver in NetworkPkg.\r
+#  2) This driver might have some issues that have been fixed in the IScsiDxe driver\r
+#     in NetworkPkg.\r
+#  3) This driver supports fewer features than the IScsiDxe driver in NetworkPkg\r
+#     (e.g. IPv6, Dns support for target URL configuration, iSCSI keyword support).\r
+#  4) IScsiDxe driver in NetworkPkg is recommended for use instead of this one even\r
+#     though both of them can be used.\r
 #\r
 #  Copyright (c) 2004 - 2018, Intel Corporation. All rights reserved.<BR>\r
 #  This program and the accompanying materials\r