NetworkPkg/DxeNetLib: Update misleading comment

Commit 6862b9d538d96363635677198899e1669e591259 makes
more explicit the previous logic of the code anyway, which is that
it is (and was) only a fatal error if all secure algorithms fail.

However the comment updated by this commit seems somewhat
incompatible with that change, and even with the previous code
(which operated as now, just logging different error messages).

This updates the comment to be more compatible with how the
code operates.

Signed-off-by: Mike Beaton <mjsbeaton@gmail.com>

diff --git a/NetworkPkg/Library/DxeNetLib/DxeNetLib.c b/NetworkPkg/Library/DxeNetLib/DxeNetLib.c
index 4dfbe91a5554621dfdc088101c8a50f3aaeea787..cf875d7af3508799b3e87b44811bf6a492edf477 100644 (file)
--- a/NetworkPkg/Library/DxeNetLib/DxeNetLib.c
+++ b/NetworkPkg/Library/DxeNetLib/DxeNetLib.c
@@ -133,10 +133,16 @@ GLOBAL_REMOVE_IF_UNREFERENCED VLAN_DEVICE_PATH  mNetVlanDevicePathTemplate = {
 // These represent UEFI SPEC defined algorithms that should be supported by\r
 // the RNG protocol and are generally considered secure.\r
 //\r
-// The order of the algorithms in this array is important. This order is the order\r
-// in which the algorithms will be tried by the RNG protocol.\r
-// If your platform needs to use a specific algorithm for the random number generator,\r
-// then you should place that algorithm first in the array.\r
+// Assuming that PcdEnforceSecureRngAlgorithms is TRUE (the default) then\r
+// only the algorithms defined here will be used by the network stack, and\r
+// none of these being available will result in an error condition (even if\r
+// some other RNG implementation is available).\r
+//\r
+// If PcdEnforceSecureRngAlgorithms is FALSE this list is not consulted,\r
+// and the first available RNG algorithm is used.\r
+//\r
+// If your platform needs to use a specific algorithm for the random number\r
+// generator, then you should modify this array.\r
 //\r
 GLOBAL_REMOVE_IF_UNREFERENCED EFI_GUID  *mSecureHashAlgorithms[] = {\r
   &gEfiRngAlgorithmSp80090Ctr256Guid,  // SP800-90A DRBG CTR using AES-256\r