summaryrefslogtreecommitdiffstats
path: root/IntelFrameworkPkg/Include
diff options
context:
space:
mode:
authorxli24 <xli24@6f19259b-4bc3-4df7-8a09-765794883524>2009-07-09 07:22:06 +0000
committerxli24 <xli24@6f19259b-4bc3-4df7-8a09-765794883524>2009-07-09 07:22:06 +0000
commit56fd2fa44cc5de7db102e1daa9d994e262d48df5 (patch)
treea96c2e766ac9af985f866cd4f4ea33681f7a1c6f /IntelFrameworkPkg/Include
parentd46f36324fa86c08386f57c2675c45e4c1e888ec (diff)
downloadedk2-56fd2fa44cc5de7db102e1daa9d994e262d48df5.tar.gz
edk2-56fd2fa44cc5de7db102e1daa9d994e262d48df5.tar.bz2
edk2-56fd2fa44cc5de7db102e1daa9d994e262d48df5.zip
Refine the comments to describe inconsistency between code and spec.
git-svn-id: https://edk2.svn.sourceforge.net/svnroot/edk2/trunk/edk2@8830 6f19259b-4bc3-4df7-8a09-765794883524
Diffstat (limited to 'IntelFrameworkPkg/Include')
-rw-r--r--IntelFrameworkPkg/Include/Ppi/BlockIo.h7
1 files changed, 5 insertions, 2 deletions
diff --git a/IntelFrameworkPkg/Include/Ppi/BlockIo.h b/IntelFrameworkPkg/Include/Ppi/BlockIo.h
index 7b5d4dc183..0134776ced 100644
--- a/IntelFrameworkPkg/Include/Ppi/BlockIo.h
+++ b/IntelFrameworkPkg/Include/Ppi/BlockIo.h
@@ -52,8 +52,11 @@ typedef enum {
///
/// Inconsistent with specification here:
-/// PEI_BLOCK_IO_MEDIA has been changed to EFI_PEI_BLOCK_IO_MEDIA, because
-/// "EFI_" prefix is missing in spec due to typo.
+/// PEI_BLOCK_IO_MEDIA has been changed to EFI_PEI_BLOCK_IO_MEDIA.
+/// Inconsistency exists in Framework Recovery Specification, where all referrences to this
+/// structure name are with the "EFI_" prefix, except for the definition which is without "EFI_".
+/// So the name of PEI_BLOCK_IO_MEDIA is taken as the exception caused by mistake, and
+/// EFI_PEI_BLOCK_IO_MEDIA is used to comply with most part of the specification.
///
typedef struct {
EFI_PEI_BLOCK_DEVICE_TYPE DeviceType;