Reviewed the description of ECP in the .dec file for clarity and completeness, and...

git-svn-id: https://edk2.svn.sourceforge.net/svnroot/edk2/trunk/edk2@8599 6f19259b-4bc3-4df7-8a09-765794883524

diff --git a/EdkCompatibilityPkg/Compatibility/Include/Library/LanguageLib.h b/EdkCompatibilityPkg/Compatibility/Include/Library/LanguageLib.h
index cc9a5d36eaae3cf26f48edf13625aa9a6d9e46f3..bb8c4c6c6dc1b31cd86f9fd01a470384f73f1a65 100644 (file)
--- a/EdkCompatibilityPkg/Compatibility/Include/Library/LanguageLib.h
+++ b/EdkCompatibilityPkg/Compatibility/Include/Library/LanguageLib.h
@@ -16,24 +16,24 @@ WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
 #define __LANGUAGE_LIB__\r
 \r
 /**\r
-  Convert an ISO 639-2 language code to a RFC 4646 language code.\r
-  If the ISO 639-2 language code has a corresponding ISO 639-1 code, then the ISO 639-1\r
-  code is returned. Else the original ISO 639-2 code is returned. The returned RFC 4646\r
+  Converts an ISO 639-2 language code to an RFC 4646 language code.\r
+  If the ISO 639-2 language code has a corresponding ISO 639-1 code, then that ISO 639-1\r
+  code is returned in the out parameter. Else the original ISO 639-2 code is returned. The returned RFC 4646\r
   language code is composed of only a primary language subtag.\r
 \r
-  If Iso639Language is NULL, then ASSERT.\r
-  If Rfc4646Language is NULL, then ASSERT.\r
+  If Iso639Language is NULL, then ASSERT().\r
+  If Rfc4646Language is NULL, then ASSERT().\r
 \r
   @param[out] Rfc4646Language  Pointers to a buffer large enough for an ASCII string\r
-                               which reprsents a RFC 4646 language code containging only\r
+                               representing an RFC 4646 language code containing only\r
                                either a ISO 639-1 or ISO 639-2 primary language subtag.\r
                                This string is Null-terminated.\r
-  @param[in]  Iso639Language   Pointer to a 3-letter ASCII string which represents\r
+  @param[in]  Iso639Language   Pointer to a 3-letter ASCII string that represents\r
                                an ISO 639-2 language code. This string is not required\r
                                to be Null-terminated.\r
 \r
-  @retval TRUE                 The ISO 639-2 language code was converted to a ISO 639-1 code.\r
-  @retval FALSE                The language code does not have corresponding ISO 639-1 code.\r
+  @retval TRUE                 The ISO 639-2 language code was converted to an ISO 639-1 code.\r
+  @retval FALSE                The language code does not have a corresponding ISO 639-1 code.\r
 \r
 **/\r
 BOOLEAN\r
@@ -44,16 +44,16 @@ ConvertIso639ToRfc4646 (
   );\r
 \r
 /**\r
-  Convert a RFC 4646 language code to an ISO 639-2 language code. The primary language\r
+  Converts an RFC 4646 language code to an ISO 639-2 language code. The primary language\r
   subtag of the RFC 4646 code must be either an ISO 639-1 or 639-2 code. If the primary\r
   language subtag is an ISO 639-1 code, then it is converted to its corresponding ISO 639-2\r
   code (T code if applies). Else the ISO 639-2 code is returned.\r
 \r
-  If Rfc4646Language is NULL, then ASSERT.\r
-  If Iso639Language is NULL, then ASSERT.\r
+  If Rfc4646Language is NULL, then ASSERT().\r
+  If Iso639Language is NULL, then ASSERT().\r
 \r
   @param[out] Iso639Language   Pointers to a buffer large enough for a 3-letter ASCII string\r
-                               which reprsents an ISO 639-2 language code. The string is Null-terminated.\r
+                               representing an ISO 639-2 language code. The string is Null-terminated.\r
   @param[in]  Rfc4646Language  Pointer to a RFC 4646 language code string. This string is terminated\r
                                by a NULL or a ';' character.\r
 \r
@@ -69,12 +69,12 @@ ConvertRfc4646ToIso639 (
   );\r
 \r
 /**\r
-  Convert ISO 639-2 language codes to RFC 4646 codes and return the converted codes.\r
+  Converts ISO 639-2 language codes to RFC 4646 codes and returns the converted codes.\r
   Caller is responsible for freeing the allocated buffer.\r
 \r
   If Iso639Languages is NULL, then ASSERT.\r
 \r
-  @param[in] Iso639Languages  Pointers to a Null-terminated ISO 639-2 language codes string containing\r
+  @param[in] Iso639Languages  Pointers to Null-terminated ISO 639-2 language code strings containing\r
                               one or more ISO 639-2 3-letter language codes.\r
   \r
   @retval NULL                Invalid ISO 639-2 language code found.\r
@@ -91,7 +91,7 @@ ConvertLanguagesIso639ToRfc4646 (
   );\r
 \r
 /**\r
-  Convert RFC 4646 language codes to ISO 639-2 codes and return the converted codes.\r
+  Converts RFC 4646 language codes to ISO 639-2 codes and returns the converted codes.\r
   The primary language subtag of the RFC 4646 code must be either an ISO 639-1 or 639-2 code.\r
   Caller is responsible for freeing the allocated buffer.\r
 \r

diff --git a/EdkCompatibilityPkg/Compatibility/Include/Ppi/EcpPciCfg.h b/EdkCompatibilityPkg/Compatibility/Include/Ppi/EcpPciCfg.h
index a58c9dc7643327f0af26fc268d8270f8ffaec993..662319d0d8dcbab0e06a7e234dbf75ca97342ac7 100644 (file)
--- a/EdkCompatibilityPkg/Compatibility/Include/Ppi/EcpPciCfg.h
+++ b/EdkCompatibilityPkg/Compatibility/Include/Ppi/EcpPciCfg.h
@@ -1,5 +1,5 @@
 /** @file\r
-This PPI which is same with PciCfg PPI. But Modify API is removed.\r
+This PPI is the same as the PPI in the framework PciCfg, with one exception: this PPI does not include a modify API, while the PPI in the framework PciCfg does. \r
 \r
 Copyright (c) 2008, Intel Corporation                                                         \r
 All rights reserved. This program and the accompanying materials                          \r
@@ -25,15 +25,15 @@ typedef struct _ECP_PEI_PCI_CFG_PPI ECP_PEI_PCI_CFG_PPI;
 /**\r
   PCI read and write operation.\r
   \r
-  Write to/read from a given location in the PCI configuration space.\r
+  Writes to or reads from a given location in the PCI configuration space.\r
 \r
   @param  PeiServices                   An indirect pointer to the PEI Services Table published by the PEI Foundation.\r
   @param  This                              Pointer to local data for the interface.\r
   @param  Width                            The width of the access. Enumerated in bytes.\r
-                                                    See EFI_PEI_PCI_CFG_PPI_WIDTH above.\r
+                                                    See EFI_PEI_PCI_CFG_PPI_WIDTH in MDEPkg.\r
   @param  Address                         The physical address of the access. The format of\r
                                                     the address is described by EFI_PEI_PCI_CFG_PPI_PCI_ADDRESS.\r
-  @param  Buffer                            A pointer to the buffer of data..\r
+  @param  Buffer                            A pointer to the buffer of data.\r
   @retval EFI_SUCCESS                   The function completed successfully.\r
   @retval EFI_DEVICE_ERROR          There was a problem with the transaction.\r
   @retval EFI_DEVICE_NOT_READY  The device is not capable of supporting the operation at this\r

diff --git a/EdkCompatibilityPkg/EdkCompatibilityPkg.dec b/EdkCompatibilityPkg/EdkCompatibilityPkg.dec
index 2b57da8ec9e591158f75ef118f414f201184ac3f..81159a8e2e78b6d484fbea8b387a66c41d84a645 100644 (file)
--- a/EdkCompatibilityPkg/EdkCompatibilityPkg.dec
+++ b/EdkCompatibilityPkg/EdkCompatibilityPkg.dec
@@ -1,8 +1,10 @@
 #/** @file\r
-# EDK Compatibility Package\r
-#\r
-# This Package provides headers and libraries that allow a EDK Module (https://edk.tianocore.org)\r
-# to be used in the context of EDK II environment.\r
+# The EdkCompatibilityPkg provides header files and libraries that enable you to build the EDK module \r
+# in UEFI 2.0 + Framework 0.9x mode. This package also provides Thunk modules that enable Framework 0.9x modules to work with UEFI2.1/PI1.0 EDK II Cores.\r
+# EdkCompatibilityPkg is based on the EDK 1.01 release, found at http://edk.tianocore.org. This package only \r
+# contains the header files and libraries found in the original EDK. EdkCompatibilityPkg code is ANSI C compliant, so the modules can be built with GCC tool-chains. \r
+# This package also incorporates bug fixes released in EDK 1.04.\r
+# \r
 #\r
 # All rights reserved.\r
 #    This program and the accompanying materials are licensed and made available under\r