Grammatical and disclaimer changes (does not follow internal C coding stds.)

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

diff --git a/IntelFrameworkPkg/Include/Ppi/ReadOnlyVariable.h b/IntelFrameworkPkg/Include/Ppi/ReadOnlyVariable.h
index 87d2dc35e665d17b7b04cf76ad5102f8cd87dcb7..0cdd61266b0794f43759e055074b76f50196c24d 100644 (file)
--- a/IntelFrameworkPkg/Include/Ppi/ReadOnlyVariable.h
+++ b/IntelFrameworkPkg/Include/Ppi/ReadOnlyVariable.h
@@ -4,17 +4,17 @@
   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 - 2009, Intel Corporation\r
-  All rights reserved. This program and the accompanying materials\r
-  are licensed and made available under the terms and conditions of the BSD License\r
-  which accompanies this distribution.  The full text of the license may be found at\r
-  http://opensource.org/licenses/bsd-license.php\r
-\r
-  THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,\r
-  WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.\r
+  storage. As such, a write command to certain technologies would alter the contents of the entire part,\r
+  making the PEIM execution in the original position not follow the required flow.\r
+\r
+Copyright (c) 2006 - 2010, 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
+http://opensource.org/licenses/bsd-license.php.                                          \r
+    \r
+THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,                     \r
+WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.\r
 \r
   @par Revision Reference:\r
   This PPI is defined in PEI CIS\r
@@ -32,7 +32,7 @@
 typedef struct _EFI_PEI_READ_ONLY_VARIABLE_PPI  EFI_PEI_READ_ONLY_VARIABLE_PPI;\r
 \r
 ///\r
-/// Variable attributes\r
+/// Variable attributes.\r
 ///@{\r
 #define EFI_VARIABLE_NON_VOLATILE       0x00000001\r
 #define EFI_VARIABLE_BOOTSERVICE_ACCESS 0x00000002\r
@@ -46,9 +46,10 @@ typedef struct _EFI_PEI_READ_ONLY_VARIABLE_PPI  EFI_PEI_READ_ONLY_VARIABLE_PPI;
 ///@}\r
 \r
 /**\r
-  Get Variable value by Name and GUID pair\r
+  Get Variable value by Name and GUID pair.\r
 \r
-  @param[in]  PeiServices    An indirect pointer to the PEI Services Table published by the PEI Foundation.\r
+  @param[in]  PeiServices    An indirect pointer to the PEI Services Table published \r
+                             by the PEI Foundation.\r
   @param[in]  VariableName   A NULL-terminated Unicode string that is the name of the vendor's variable.\r
   @param[in]  VendorGuid     A unique identifier for the vendor.\r
   @param[out] Attributes     This OPTIONAL parameter may be either NULL or\r
@@ -83,20 +84,23 @@ EFI_STATUS
   and on output the interface returns the next variable name data.  When the\r
   entire variable list has been returned, the error EFI_NOT_FOUND is returned.\r
 \r
-  @param[in]  PeiServices       An indirect pointer to the PEI Services Table published by the PEI Foundation.\r
+  @param[in]  PeiServices       An indirect pointer to the PEI Services Table \r
+                                published by the PEI Foundation.\r
   @param[in]  VariableNameSize  The size of the VariableName buffer.\r
   @param[in]  VariableName      On input, supplies the last VariableName that was\r
-                                returned by GetNextVariableName(). On output, returns the Null-terminated\r
-                                Unicode string of the current variable.\r
+                                returned by GetNextVariableName(). On output, \r
+                                returns the Null-terminated Unicode string of the \r
+                                current variable.\r
   @param[in]  VendorGuid        On input, supplies the last VendorGuid that was\r
-                                returned by GetNextVariableName(). On output, returns the VendorGuid\r
-                                of the current variable.\r
+                                returned by GetNextVariableName(). On output, \r
+                                returns the VendorGuid of the current variable.\r
 \r
   @retval EFI_SUCCESS           The function completed successfully.\r
   @retval EFI_NOT_FOUND         The next variable was not found.\r
   @retval EFI_BUFFER_TOO_SMALL  The VariableNameSize is too small for the result.\r
   @retval EFI_INVALID_PARAMETER One of the parameters has an invalid value.\r
-  @retval EFI_DEVICE_ERROR      The variable name could not be retrieved due to a hardware error.\r
+  @retval EFI_DEVICE_ERROR      The variable name could not be retrieved due to \r
+                                a hardware error.\r
 \r
 **/\r
 typedef\r
@@ -116,7 +120,7 @@ struct _EFI_PEI_READ_ONLY_VARIABLE_PPI {
        ///\r
   /// Inconsistent with specification here: \r
   /// In Framework Spec, PeiCis0.91, the field is named as GetVariable and GetNextVariableName.\r
-  /// Keeping this inconsistance is for backward compatibility.\r
+  /// Keeping this inconsistancy for backward compatibility.\r
        /// \r
   EFI_PEI_GET_VARIABLE            PeiGetVariable;         ///< A service to ascertain a given variable name.\r
   EFI_PEI_GET_NEXT_VARIABLE_NAME  PeiGetNextVariableName; ///< A service to ascertain a variable based upon a given, known variable\r