Refine the comments to describe inconsistency between code and spec.

[mirror_edk2.git] / IntelFrameworkPkg / Include / Ppi / BlockIo.h

diff --git a/IntelFrameworkPkg/Include/Ppi/BlockIo.h b/IntelFrameworkPkg/Include/Ppi/BlockIo.h
index 7b5d4dc183f74f7136a71841e6b2e5c45677c397..0134776cede3208bf222e500bdd6412078a54968 100644 (file)
--- a/IntelFrameworkPkg/Include/Ppi/BlockIo.h
+++ b/IntelFrameworkPkg/Include/Ppi/BlockIo.h
@@ -52,8 +52,11 @@ typedef enum {
 \r
 ///\r
 /// Inconsistent with specification here: \r
-/// PEI_BLOCK_IO_MEDIA has been changed to EFI_PEI_BLOCK_IO_MEDIA, because\r
-/// "EFI_" prefix is missing in spec due to typo.\r
+/// PEI_BLOCK_IO_MEDIA has been changed to EFI_PEI_BLOCK_IO_MEDIA.\r
+/// Inconsistency exists in Framework Recovery Specification, where all referrences to this\r
+/// structure name are with the "EFI_" prefix, except for the definition which is without "EFI_".\r
+/// So the name of PEI_BLOCK_IO_MEDIA is taken as the exception caused by mistake, and\r
+/// EFI_PEI_BLOCK_IO_MEDIA is used to comply with most part of the specification.\r
 ///\r
 typedef struct {\r
   EFI_PEI_BLOCK_DEVICE_TYPE  DeviceType;\r