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

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

This patch is to add the driver usage/difference clarification
compared to UefiPxeBcDxe in MdeModulePkg.

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/NetworkPkg/UefiPxeBcDxe/UefiPxeBcDxe.inf b/NetworkPkg/UefiPxeBcDxe/UefiPxeBcDxe.inf
index e2a0eb44b1fcfb16640c9c8ea232357bd30cbc01..130a5456e2c18736e35868b9352c4ab7169ae9d9 100644 (file)
--- a/NetworkPkg/UefiPxeBcDxe/UefiPxeBcDxe.inf
+++ b/NetworkPkg/UefiPxeBcDxe/UefiPxeBcDxe.inf
@@ -2,9 +2,14 @@
 #  Access PXE-compatible devices for network access and network booting.\r
 #\r
 #  This driver provides PXE Base Code Protocol which is used to accessing\r
-#  PXE-compatible device for network access or booting. It could work together\r
-#  with an IPv4 stack, an IPv6 stack or both.\r
+#  PXE-compatible device for network access or booting. This driver supports\r
+#  both IPv4 and IPv6 network stack.\r
 #\r
+#  Notes:\r
+#  1) This driver can't co-work with the UefiPxeBcDxe driver in MdeModulePkg.\r
+#  2) This driver includes more bug fixes and supports more features (e.g. IPv6,\r
+#     MTFTP windowsize) than the UefiPxeBcDxe driver in MdeModulePkg. So, we\r
+#     recommend using this driver even though both of them can be used.\r
 #\r
 #  Copyright (c) 2007 - 2018, Intel Corporation. All rights reserved.<BR>\r
 #\r