Add more comments for IntelFramework's header files.

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

diff --git a/IntelFrameworkPkg/Include/Ppi/ReadOnlyVariable.h b/IntelFrameworkPkg/Include/Ppi/ReadOnlyVariable.h
index 7c1c65470d8e8fd36aff7437a854b2ec06ffbcd0..6e6c0873a52764e49f656ecbe71d78d50347abb9 100644 (file)
--- a/IntelFrameworkPkg/Include/Ppi/ReadOnlyVariable.h
+++ b/IntelFrameworkPkg/Include/Ppi/ReadOnlyVariable.h
@@ -1,5 +1,10 @@
 /** @file\r
   This file declares Read-only Variable Service PPI\r
+  These services provide a lightweight, read-only variant of the full EFI variable services. The\r
+  reason that these services are read-only is to reduce the complexity of flash management. Also,\r
+  some implementation of the PEI may use the same physical flash part for variable and PEIM\r
+  storage; as such, a write command to certain technologies would alter the contents of the entire part,\r
+  thus making the in situ PEIM execution not follow the required flow.\r
 \r
   Copyright (c) 2006, Intel Corporation\r
   All rights reserved. This program and the accompanying materials\r