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

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

This patch is to add the driver usage/difference clarification
compared to UefiPxeBcDxe 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/UefiPxeBcDxe/UefiPxeBcDxe.inf b/MdeModulePkg/Universal/Network/UefiPxeBcDxe/UefiPxeBcDxe.inf
index b5b9e807108db69e0fead9cf0c536bdc430aabd6..0424019929459b81bf352c8add53ab05a9b9073b 100644 (file)
--- a/MdeModulePkg/Universal/Network/UefiPxeBcDxe/UefiPxeBcDxe.inf
+++ b/MdeModulePkg/Universal/Network/UefiPxeBcDxe/UefiPxeBcDxe.inf
@@ -4,7 +4,16 @@
 #  This module produces EFI PXE Base Code Protocol upon EFI MMP Protocl and IPv4\r
 #  network stack, used to control PXE-compatible devices. It produces EFI Load File\r
 #  Protocol to provide one clean way to otain control from the boot manager if the\r
-#  boot patch is from the remote device.\r
+#  boot patch is from the remote device. This driver only supports IPv4 network stack.\r
+#\r
+#  Notes:\r
+#  1) This driver can't co-work with the UefiPxeBcDxe driver in NetworkPkg.\r
+#  2) This driver might have some issues that have been fixed in the UefiPxeBcDxe\r
+#     driver in NetworkPkg.\r
+#  3) This driver supports fewer features than the UefiPxeBcDxe driver in NetworkPkg\r
+#     (e.g. IPv6, MTFTP windowsize).\r
+#  4) UefiPxeBcDxe driver in NetworkPkg is recommended for use instead of this one even\r
+#     though both of them can be used.\r
 #\r
 #  Copyright (c) 2007 - 2018, Intel Corporation. All rights reserved.<BR>\r
 #  This program and the accompanying materials\r