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
This commit is contained in:
xli24 2009-07-09 07:22:06 +00:00
parent d46f36324f
commit 56fd2fa44c
1 changed files with 5 additions and 2 deletions

View File

@ -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;