Update the comments for S3Lib and RecoveryLib class and instance to state that they...

git-svn-id: https://edk2.svn.sourceforge.net/svnroot/edk2/trunk/edk2@9047 6f19259b-4bc3-4df7-8a09-765794883524

diff --git a/MdeModulePkg/Include/Library/RecoveryLib.h b/MdeModulePkg/Include/Library/RecoveryLib.h
index 484ff76c3a1cd82cfa9d3ff756f5d86caffa8fb1..a04b19ab65645fc167ff02a0d130bb345482b15f 100644 (file)
--- a/MdeModulePkg/Include/Library/RecoveryLib.h
+++ b/MdeModulePkg/Include/Library/RecoveryLib.h
@@ -1,5 +1,7 @@
 /** @file\r
-  Recovery library class defines a set of methods related recovery boot mode.\r
+  Recovery library class defines a set of methods related recovery boot mode. \r
+  This library class is no longer used and modules using this library should\r
+  directly locate EFI_PEI_RECOVERY_MODULE_PPI defined in PI 1.2 specification.\r
 \r
 Copyright (c) 2005 - 2008, Intel Corporation. <BR>\r
 All rights reserved. This program and the accompanying materials\r

diff --git a/MdeModulePkg/Include/Library/S3Lib.h b/MdeModulePkg/Include/Library/S3Lib.h
index f97b6b5460a0c45bb99cb99038f8333be3b3a972..6eda9f60222556b42002cf67fc9c3867599e960c 100644 (file)
--- a/MdeModulePkg/Include/Library/S3Lib.h
+++ b/MdeModulePkg/Include/Library/S3Lib.h
@@ -1,5 +1,7 @@
 /** @file\r
   S3 library class defines a set of methods related to S3 boot mode.\r
+  This library class is no longer used and modules using this library should\r
+  directly locate EFI_PEI_S3_RESUME_PPI defined in PI 1.2 specification.\r
 \r
 Copyright (c) 2005 - 2008, Intel Corporation. <BR>\r
 All rights reserved. This program and the accompanying materials\r

diff --git a/MdeModulePkg/Library/PeiRecoveryLibNull/PeiRecoveryLibNull.c b/MdeModulePkg/Library/PeiRecoveryLibNull/PeiRecoveryLibNull.c
index 1f60871a662767845ec8edbcb8bc6d0283c1be28..62d629577ef819e6a153821dfa1efde06b73052b 100644 (file)
--- a/MdeModulePkg/Library/PeiRecoveryLibNull/PeiRecoveryLibNull.c
+++ b/MdeModulePkg/Library/PeiRecoveryLibNull/PeiRecoveryLibNull.c
@@ -1,5 +1,9 @@
 /** @file\r
-  Null Recovery Library instance does nothing and returns unsupport status.\r
+  Null Recovery Library instance does nothing and returns unsupported status.\r
+\r
+  This library instance is no longer used and module using this library\r
+  class should update to directly locate EFI_PEI_RECOVERY_MODULE_PPI defined\r
+  in PI 1.2 specification. \r
 \r
 Copyright (c) 2006 - 2008, Intel Corporation. <BR>\r
 All rights reserved. This program and the accompanying materials\r

diff --git a/MdeModulePkg/Library/PeiRecoveryLibNull/PeiRecoveryLibNull.inf b/MdeModulePkg/Library/PeiRecoveryLibNull/PeiRecoveryLibNull.inf
index cdfbb49af5c548ffa08ae4915d3552015a0e3212..d169fabb0919b0ac4a76ab17207d9c3ba8564f8a 100644 (file)
--- a/MdeModulePkg/Library/PeiRecoveryLibNull/PeiRecoveryLibNull.inf
+++ b/MdeModulePkg/Library/PeiRecoveryLibNull/PeiRecoveryLibNull.inf
@@ -1,7 +1,9 @@
 #/** @file\r
 #  \r
 #  Null Recovery library instance for PEIM module\r
-#  It can make core modules pass package level build.\r
+#  This library instance is no longer used and module using this library\r
+#  class should update to directly locate EFI_PEI_RECOVERY_MODULE_PPI defined\r
+#  in PI 1.2 specification. \r
 #  \r
 #  Copyright (c) 2006 - 2008, Intel Corporation. <BR>\r
 #  All rights reserved. This program and the accompanying materials\r

diff --git a/MdeModulePkg/Library/PeiS3LibNull/PeiS3LibNull.c b/MdeModulePkg/Library/PeiS3LibNull/PeiS3LibNull.c
index 096a6af885ece8196d472673bfbc3d9d63955acf..51f618d7693a7a5a0cf9c303d2a71987983f5787 100644 (file)
--- a/MdeModulePkg/Library/PeiS3LibNull/PeiS3LibNull.c
+++ b/MdeModulePkg/Library/PeiS3LibNull/PeiS3LibNull.c
@@ -1,5 +1,9 @@
 /** @file\r
-  Null S3 Library instance does nothing and returns unsupport status.\r
+  Null S3 Library instance does nothing and returns unsupported status.\r
+\r
+  This library instance is no longer used and module using this library\r
+  class should update to directly locate EFI_PEI_S3_RESUME_PPI defined\r
+  in PI 1.2 specification. \r
 \r
 Copyright (c) 2006 - 2008, Intel Corporation. <BR>\r
 All rights reserved. This program and the accompanying materials\r
@@ -17,7 +21,7 @@ WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
 /**\r
   This function is responsible for calling the S3 resume vector in the ACPI Tables.\r
   \r
-  @retval EFI_SUCESS   Sucess to restore config from S3.\r
+  @retval EFI_SUCESS   Success to restore config from S3.\r
   @retval Others       Fail to restore config from S3.\r
 **/\r
 EFI_STATUS\r

diff --git a/MdeModulePkg/Library/PeiS3LibNull/PeiS3LibNull.inf b/MdeModulePkg/Library/PeiS3LibNull/PeiS3LibNull.inf
index df99874b38afa58e55855d66ad15438c59d26ceb..eff10d1d010f1b48190bbe258ee33837efb91a58 100644 (file)
--- a/MdeModulePkg/Library/PeiS3LibNull/PeiS3LibNull.inf
+++ b/MdeModulePkg/Library/PeiS3LibNull/PeiS3LibNull.inf
@@ -1,7 +1,9 @@
 #/** @file\r
 #  \r
-#  Null S3 library instance for PEIM module\r
-#  It can make core modules pass package level build.\r
+#  Null S3 library instance for PEIM module.\r
+#  This library instance is no longer used and module using this library\r
+#  class should update to directly locate EFI_PEI_S3_RESUME_PPI defined\r
+#  in PI 1.2 specification. \r
 #  \r
 #  Copyright (c) 2006 - 2008, Intel Corporation.\r
 #\r