Reviewed the description of ECP in the .dec file for clarity and completeness, and reviewed comments in the Compatibility/Include folder.

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

3 files changed, 26 insertions, 24 deletions

diff --git a/EdkCompatibilityPkg/Compatibility/Include/Library/LanguageLib.h b/EdkCompatibilityPkg/Compatibility/Include/Library/LanguageLib.h
index cc9a5d3..bb8c4c6 100644
--- 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__

 

 /**

-  Convert an ISO 639-2 language code to a RFC 4646 language code.

-  If the ISO 639-2 language code has a corresponding ISO 639-1 code, then the ISO 639-1

-  code is returned. Else the original ISO 639-2 code is returned. The returned RFC 4646

+  Converts an ISO 639-2 language code to an RFC 4646 language code.

+  If the ISO 639-2 language code has a corresponding ISO 639-1 code, then that ISO 639-1

+  code is returned in the out parameter. Else the original ISO 639-2 code is returned. The returned RFC 4646

   language code is composed of only a primary language subtag.

 

-  If Iso639Language is NULL, then ASSERT.

-  If Rfc4646Language is NULL, then ASSERT.

+  If Iso639Language is NULL, then ASSERT().

+  If Rfc4646Language is NULL, then ASSERT().

 

   @param[out] Rfc4646Language  Pointers to a buffer large enough for an ASCII string

-                               which reprsents a RFC 4646 language code containging only

+                               representing an RFC 4646 language code containing only

                                either a ISO 639-1 or ISO 639-2 primary language subtag.

                                This string is Null-terminated.

-  @param[in]  Iso639Language   Pointer to a 3-letter ASCII string which represents

+  @param[in]  Iso639Language   Pointer to a 3-letter ASCII string that represents

                                an ISO 639-2 language code. This string is not required

                                to be Null-terminated.

 

-  @retval TRUE                 The ISO 639-2 language code was converted to a ISO 639-1 code.

-  @retval FALSE                The language code does not have corresponding ISO 639-1 code.

+  @retval TRUE                 The ISO 639-2 language code was converted to an ISO 639-1 code.

+  @retval FALSE                The language code does not have a corresponding ISO 639-1 code.

 

 **/

 BOOLEAN

@@ -44,16 +44,16 @@ ConvertIso639ToRfc4646 (
   );

 

 /**

-  Convert a RFC 4646 language code to an ISO 639-2 language code. The primary language

+  Converts an RFC 4646 language code to an ISO 639-2 language code. The primary language

   subtag of the RFC 4646 code must be either an ISO 639-1 or 639-2 code. If the primary

   language subtag is an ISO 639-1 code, then it is converted to its corresponding ISO 639-2

   code (T code if applies). Else the ISO 639-2 code is returned.

 

-  If Rfc4646Language is NULL, then ASSERT.

-  If Iso639Language is NULL, then ASSERT.

+  If Rfc4646Language is NULL, then ASSERT().

+  If Iso639Language is NULL, then ASSERT().

 

   @param[out] Iso639Language   Pointers to a buffer large enough for a 3-letter ASCII string

-                               which reprsents an ISO 639-2 language code. The string is Null-terminated.

+                               representing an ISO 639-2 language code. The string is Null-terminated.

   @param[in]  Rfc4646Language  Pointer to a RFC 4646 language code string. This string is terminated

                                by a NULL or a ';' character.

 

@@ -69,12 +69,12 @@ ConvertRfc4646ToIso639 (
   );

 

 /**

-  Convert ISO 639-2 language codes to RFC 4646 codes and return the converted codes.

+  Converts ISO 639-2 language codes to RFC 4646 codes and returns the converted codes.

   Caller is responsible for freeing the allocated buffer.

 

   If Iso639Languages is NULL, then ASSERT.

 

-  @param[in] Iso639Languages  Pointers to a Null-terminated ISO 639-2 language codes string containing

+  @param[in] Iso639Languages  Pointers to Null-terminated ISO 639-2 language code strings containing

                               one or more ISO 639-2 3-letter language codes.

   

   @retval NULL                Invalid ISO 639-2 language code found.

@@ -91,7 +91,7 @@ ConvertLanguagesIso639ToRfc4646 (
   );

 

 /**

-  Convert RFC 4646 language codes to ISO 639-2 codes and return the converted codes.

+  Converts RFC 4646 language codes to ISO 639-2 codes and returns the converted codes.

   The primary language subtag of the RFC 4646 code must be either an ISO 639-1 or 639-2 code.

   Caller is responsible for freeing the allocated buffer.

 

diff --git a/EdkCompatibilityPkg/Compatibility/Include/Ppi/EcpPciCfg.h b/EdkCompatibilityPkg/Compatibility/Include/Ppi/EcpPciCfg.h
index a58c9dc..662319d 100644
--- a/EdkCompatibilityPkg/Compatibility/Include/Ppi/EcpPciCfg.h
+++ b/EdkCompatibilityPkg/Compatibility/Include/Ppi/EcpPciCfg.h
@@ -1,5 +1,5 @@
 /** @file

-This PPI which is same with PciCfg PPI. But Modify API is removed.

+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. 

 

 Copyright (c) 2008, Intel Corporation                                                         

 All rights reserved. This program and the accompanying materials                          

@@ -25,15 +25,15 @@ typedef struct _ECP_PEI_PCI_CFG_PPI ECP_PEI_PCI_CFG_PPI;
 /**

   PCI read and write operation.

   

-  Write to/read from a given location in the PCI configuration space.

+  Writes to or reads from a given location in the PCI configuration space.

 

   @param  PeiServices                   An indirect pointer to the PEI Services Table published by the PEI Foundation.

   @param  This                              Pointer to local data for the interface.

   @param  Width                            The width of the access. Enumerated in bytes.

-                                                    See EFI_PEI_PCI_CFG_PPI_WIDTH above.

+                                                    See EFI_PEI_PCI_CFG_PPI_WIDTH in MDEPkg.

   @param  Address                         The physical address of the access. The format of

                                                     the address is described by EFI_PEI_PCI_CFG_PPI_PCI_ADDRESS.

-  @param  Buffer                            A pointer to the buffer of data..

+  @param  Buffer                            A pointer to the buffer of data.

   @retval EFI_SUCCESS                   The function completed successfully.

   @retval EFI_DEVICE_ERROR          There was a problem with the transaction.

   @retval EFI_DEVICE_NOT_READY  The device is not capable of supporting the operation at this

diff --git a/EdkCompatibilityPkg/EdkCompatibilityPkg.dec b/EdkCompatibilityPkg/EdkCompatibilityPkg.dec
index 2b57da8..81159a8 100644
--- a/EdkCompatibilityPkg/EdkCompatibilityPkg.dec
+++ b/EdkCompatibilityPkg/EdkCompatibilityPkg.dec
@@ -1,8 +1,10 @@
 #/** @file

-# EDK Compatibility Package

-#

-# This Package provides headers and libraries that allow a EDK Module (https://edk.tianocore.org)

-# to be used in the context of EDK II environment.

+# The EdkCompatibilityPkg provides header files and libraries that enable you to build the EDK module 

+# 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.

+# EdkCompatibilityPkg is based on the EDK 1.01 release, found at http://edk.tianocore.org. This package only 

+# 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. 

+# This package also incorporates bug fixes released in EDK 1.04.

+# 

 #

 # All rights reserved.

 #    This program and the accompanying materials are licensed and made available under