Change the behavior of the HII Library function HiiGetHiiHandles() when the PackageLi...

[mirror_edk2.git] / MdeModulePkg / Include / Library / S3Lib.h

diff --git a/MdeModulePkg/Include/Library/S3Lib.h b/MdeModulePkg/Include/Library/S3Lib.h
index c8fa22aabac53d275b60684e68ef525462f8e38f..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 do S3 boot mode.\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
@@ -18,8 +20,8 @@ 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 Others       Fail to restore config from S3.\r
+  @retval EFI_SUCESS   Successfully restored config from S3.\r
+  @retval Others       Failed to restore config from S3.\r
 \r
 **/\r
 EFI_STATUS\r