]> git.proxmox.com Git - mirror_edk2.git/commitdiff
MdePkg: Clarification to the return status of EFI_PEIM_NOTIFY_ENTRY_POINT
authorStar Zeng <star.zeng@intel.com>
Wed, 18 May 2016 09:04:23 +0000 (17:04 +0800)
committerStar Zeng <star.zeng@intel.com>
Fri, 20 May 2016 07:30:18 +0000 (15:30 +0800)
In Previous PI spec (< PI1.4a) Volume 1, Section 7.4.1, the callback
EFI_PEIM_NOTIFY_ENTRY_POINT is defined. A description for the arguments
are provided but not for the EFI_STATUS return value.

PI1.4a updated EFI_PEIM_NOTIFY_ENTRY_POINT definition to include a new
paragraph with this sentence after the arguments:

"The status code returned from this function is ignored"

This patch is to follow PI1.4a spec to update the code.

Cc: Liming Gao <liming.gao@intel.com>
Contributed-under: TianoCore Contribution Agreement 1.0
Signed-off-by: Star Zeng <star.zeng@intel.com>
Reviewed-by: Liming Gao <liming.gao@intel.com>
MdePkg/Include/Pi/PiPeiCis.h

index f57f3331b14ac91d9672c2dc3c36843ca2890530..7cd525512f3d7507a7937f12e3caa129fe30b78b 100644 (file)
@@ -1,7 +1,7 @@
 /** @file\r
   PI PEI master include file. This file should match the PI spec.\r
 \r
-Copyright (c) 2006 - 2015, Intel Corporation. All rights reserved.<BR>\r
+Copyright (c) 2006 - 2016, Intel Corporation. All rights reserved.<BR>\r
 This program and the accompanying materials are licensed and made available under \r
 the terms and conditions of the BSD License that accompanies this distribution.  \r
 The full text of the license may be found at\r
@@ -12,7 +12,7 @@ THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,
 WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.             \r
 \r
   @par Revision Reference:\r
-  PI Version 1.4.\r
+  PI Version 1.4a.\r
 \r
 **/\r
 \r
@@ -73,6 +73,7 @@ EFI_STATUS
   @param  Ppi              Address of the PPI that was installed.\r
 \r
   @return Status of the notification.\r
+          The status code returned from this function is ignored.\r
 **/\r
 typedef\r
 EFI_STATUS\r