SignedCapsulePkg: Fix various typos

Fix various typos in comments and documentation.

Cc: Jiewen Yao <jiewen.yao@intel.com>
Cc: Chao Zhang <chao.b.zhang@intel.com>
Signed-off-by: Antoine Coeur <coeur@gmx.fr>
Reviewed-by: Philippe Mathieu-Daude <philmd@redhat.com>
Reviewed-by: Jiewen Yao <jiewen.yao@intel.com>
Signed-off-by: Philippe Mathieu-Daude <philmd@redhat.com>
Message-Id: <20200207010831.9046-70-philmd@redhat.com>

diff --git a/SignedCapsulePkg/Include/Guid/EdkiiSystemFmpCapsule.h b/SignedCapsulePkg/Include/Guid/EdkiiSystemFmpCapsule.h
index 1129d715ae257b6f0600167a4c8202fbf8aee963..8295f92a7341225033c5a6974e6a4b5c1b849a50 100644 (file)
--- a/SignedCapsulePkg/Include/Guid/EdkiiSystemFmpCapsule.h
+++ b/SignedCapsulePkg/Include/Guid/EdkiiSystemFmpCapsule.h
@@ -60,7 +60,7 @@
   ImageOffset = <ImageOffset>    # Fv offset of this SystemFirmware image (HEX)\r
   FileGuid    = XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX  # PcdEdkiiSystemFirmwareFileGuid\r
 \r
   ImageOffset = <ImageOffset>    # Fv offset of this SystemFirmware image (HEX)\r
   FileGuid    = XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX  # PcdEdkiiSystemFirmwareFileGuid\r
 \r

-  NOTE: The [Name?] entry may have differnt FileGuid.\r
+  NOTE: The [Name?] entry may have different FileGuid.\r

   Only the one, whose FileGuid matches PcdEdkiiSystemFirmwareFileGuid, takes effect.\r
   The other entry is ignored.\r
 \r
   Only the one, whose FileGuid matches PcdEdkiiSystemFirmwareFileGuid, takes effect.\r
   The other entry is ignored.\r
 \r


@@ -80,7 +80,7 @@
   ImageOffset = <ImageOffset>    # Image offset of this SystemFirmware image (HEX)\r
   FileGuid    = XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX  # PcdEdkiiSystemFirmwareFileGuid\r
 \r
   ImageOffset = <ImageOffset>    # Image offset of this SystemFirmware image (HEX)\r
   FileGuid    = XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX  # PcdEdkiiSystemFirmwareFileGuid\r
 \r

-  NOTE: The [Name?] entry may have differnt FileGuid.\r
+  NOTE: The [Name?] entry may have different FileGuid.\r

   Only the one, whose FileGuid matches PcdEdkiiSystemFirmwareFileGuid, takes effect.\r
   The other entry is ignored.\r
 \r
   Only the one, whose FileGuid matches PcdEdkiiSystemFirmwareFileGuid, takes effect.\r
   The other entry is ignored.\r
 \r

diff --git a/SignedCapsulePkg/Include/Library/IniParsingLib.h b/SignedCapsulePkg/Include/Library/IniParsingLib.h
index 26d100ffde0a412cfafbd8388774d203dfa91182..edfdde7e8d32c79cc1e075c567d6c41f8090c3e7 100644 (file)
--- a/SignedCapsulePkg/Include/Library/IniParsingLib.h
+++ b/SignedCapsulePkg/Include/Library/IniParsingLib.h
@@ -14,7 +14,7 @@
          3.1) an ASCII String. The valid format is [A-Za-z0-9_]+\r
          3.2) a GUID. The valid format is xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx, where x is [A-Fa-f0-9]\r
          3.3) a decimal value. The valid format is [0-9]+\r
          3.1) an ASCII String. The valid format is [A-Za-z0-9_]+\r
          3.2) a GUID. The valid format is xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx, where x is [A-Fa-f0-9]\r
          3.3) a decimal value. The valid format is [0-9]+\r

-         3.4) a heximal value. The valid format is 0x[A-Fa-f0-9]+\r
+         3.4) a hexadecimal value. The valid format is 0x[A-Fa-f0-9]+\r

       4) '#' or ';' can be used as comment at anywhere.\r
       5) TAB(0x20) or SPACE(0x9) can be used as separator.\r
       6) LF(\n, 0xA) or CR(\r, 0xD) can be used as line break.\r
       4) '#' or ';' can be used as comment at anywhere.\r
       5) TAB(0x20) or SPACE(0x9) can be used as separator.\r
       6) LF(\n, 0xA) or CR(\r, 0xD) can be used as line break.\r


@@ -106,14 +106,14 @@ GetDecimalUintnFromDataFile (
   );\r
 \r
 /**\r
   );\r
 \r
 /**\r

-  Get section entry heximal UINTN value.\r
+  Get section entry hexadecimal UINTN value.\r

 \r
   @param[in]  Context         INI Config file context.\r
   @param[in]  SectionName     Section name.\r
   @param[in]  EntryName       Section entry name.\r
 \r
   @param[in]  Context         INI Config file context.\r
   @param[in]  SectionName     Section name.\r
   @param[in]  EntryName       Section entry name.\r

-  @param[out] Data            Point to the got heximal UINTN value.\r
+  @param[out] Data            Point to the got hexadecimal UINTN value.\r

 \r
 \r

-  @retval EFI_SUCCESS    Section entry heximal UINTN value is got.\r
+  @retval EFI_SUCCESS    Section entry hexadecimal UINTN value is got.\r

   @retval EFI_NOT_FOUND  Section is not found.\r
 **/\r
 EFI_STATUS\r
   @retval EFI_NOT_FOUND  Section is not found.\r
 **/\r
 EFI_STATUS\r


@@ -126,14 +126,14 @@ GetHexUintnFromDataFile (
   );\r
 \r
 /**\r
   );\r
 \r
 /**\r

-  Get section entry heximal UINT64 value.\r
+  Get section entry hexadecimal UINT64 value.\r

 \r
   @param[in]  Context         INI Config file context.\r
   @param[in]  SectionName     Section name.\r
   @param[in]  EntryName       Section entry name.\r
 \r
   @param[in]  Context         INI Config file context.\r
   @param[in]  SectionName     Section name.\r
   @param[in]  EntryName       Section entry name.\r

-  @param[out] Data            Point to the got heximal UINT64 value.\r
+  @param[out] Data            Point to the got hexadecimal UINT64 value.\r

 \r
 \r

-  @retval EFI_SUCCESS    Section entry heximal UINT64 value is got.\r
+  @retval EFI_SUCCESS    Section entry hexadecimal UINT64 value is got.\r

   @retval EFI_NOT_FOUND  Section is not found.\r
 **/\r
 EFI_STATUS\r
   @retval EFI_NOT_FOUND  Section is not found.\r
 **/\r
 EFI_STATUS\r

diff --git a/SignedCapsulePkg/Library/IniParsingLib/IniParsingLib.c b/SignedCapsulePkg/Library/IniParsingLib/IniParsingLib.c
index 757d65a20647fc58243f06db357c2a3de66a16c7..bea45e0d3be3f0f8c662c46d85436e9246066101 100644 (file)
--- a/SignedCapsulePkg/Library/IniParsingLib/IniParsingLib.c
+++ b/SignedCapsulePkg/Library/IniParsingLib/IniParsingLib.c
@@ -14,7 +14,7 @@
          3.1) an ASCII String. The valid format is [A-Za-z0-9_]+\r
          3.2) a GUID. The valid format is xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx, where x is [A-Fa-f0-9]\r
          3.3) a decimal value. The valid format is [0-9]+\r
          3.1) an ASCII String. The valid format is [A-Za-z0-9_]+\r
          3.2) a GUID. The valid format is xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx, where x is [A-Fa-f0-9]\r
          3.3) a decimal value. The valid format is [0-9]+\r

-         3.4) a heximal value. The valid format is 0x[A-Fa-f0-9]+\r
+         3.4) a hexadecimal value. The valid format is 0x[A-Fa-f0-9]+\r

       4) '#' or ';' can be used as comment at anywhere.\r
       5) TAB(0x20) or SPACE(0x9) can be used as separator.\r
       6) LF(\n, 0xA) or CR(\r, 0xD) can be used as line break.\r
       4) '#' or ';' can be used as comment at anywhere.\r
       5) TAB(0x20) or SPACE(0x9) can be used as separator.\r
       6) LF(\n, 0xA) or CR(\r, 0xD) can be used as line break.\r


@@ -165,13 +165,13 @@ IsValidDecimalString (
 }\r
 \r
 /**\r
 }\r
 \r
 /**\r

-  Return if the heximal string is valid.\r
+  Return if the hexadecimal string is valid.\r

 \r
 \r

-  @param[in] Hex     The heximal string to be checked.\r
-  @param[in] Length  The length of heximal string in bytes.\r
+  @param[in] Hex     The hexadecimal string to be checked.\r
+  @param[in] Length  The length of hexadecimal string in bytes.\r

 \r
 \r

-  @retval TRUE   The heximal string is valid.\r
-  @retval FALSE  The heximal string is invalid.\r
+  @retval TRUE   The hexadecimal string is valid.\r
+  @retval FALSE  The hexadecimal string is invalid.\r

 **/\r
 BOOLEAN\r
 IsValidHexString (\r
 **/\r
 BOOLEAN\r
 IsValidHexString (\r


@@ -388,7 +388,7 @@ ProfileGetLine (
 /**\r
   Trim Buffer by removing all CR, LF, TAB, and SPACE chars in its head and tail.\r
 \r
 /**\r
   Trim Buffer by removing all CR, LF, TAB, and SPACE chars in its head and tail.\r
 \r

-  @param[in, out] Buffer          On input,  buffer data to be trimed.\r
+  @param[in, out] Buffer          On input,  buffer data to be trimmed.\r

                                   On output, the trimmed buffer.\r
   @param[in, out] BufferSize      On input,  size of original buffer data.\r
                                   On output, size of the trimmed buffer.\r
                                   On output, the trimmed buffer.\r
   @param[in, out] BufferSize      On input,  size of original buffer data.\r
                                   On output, size of the trimmed buffer.\r


@@ -1166,14 +1166,14 @@ GetDecimalUintnFromDataFile (
 }\r
 \r
 /**\r
 }\r
 \r
 /**\r

-  Get section entry heximal UINTN value.\r
+  Get section entry hexadecimal UINTN value.\r

 \r
   @param[in]  Context         INI Config file context.\r
   @param[in]  SectionName     Section name.\r
   @param[in]  EntryName       Section entry name.\r
 \r
   @param[in]  Context         INI Config file context.\r
   @param[in]  SectionName     Section name.\r
   @param[in]  EntryName       Section entry name.\r

-  @param[out] Data            Point to the got heximal UINTN value.\r
+  @param[out] Data            Point to the got hexadecimal UINTN value.\r

 \r
 \r

-  @retval EFI_SUCCESS    Section entry heximal UINTN value is got.\r
+  @retval EFI_SUCCESS    Section entry hexadecimal UINTN value is got.\r

   @retval EFI_NOT_FOUND  Section is not found.\r
 **/\r
 EFI_STATUS\r
   @retval EFI_NOT_FOUND  Section is not found.\r
 **/\r
 EFI_STATUS\r


@@ -1210,14 +1210,14 @@ GetHexUintnFromDataFile (
 }\r
 \r
 /**\r
 }\r
 \r
 /**\r

-  Get section entry heximal UINT64 value.\r
+  Get section entry hexadecimal UINT64 value.\r

 \r
   @param[in]  Context         INI Config file context.\r
   @param[in]  SectionName     Section name.\r
   @param[in]  EntryName       Section entry name.\r
 \r
   @param[in]  Context         INI Config file context.\r
   @param[in]  SectionName     Section name.\r
   @param[in]  EntryName       Section entry name.\r

-  @param[out] Data            Point to the got heximal UINT64 value.\r
+  @param[out] Data            Point to the got hexadecimal UINT64 value.\r

 \r
 \r

-  @retval EFI_SUCCESS    Section entry heximal UINT64 value is got.\r
+  @retval EFI_SUCCESS    Section entry hexadecimal UINT64 value is got.\r

   @retval EFI_NOT_FOUND  Section is not found.\r
 **/\r
 EFI_STATUS\r
   @retval EFI_NOT_FOUND  Section is not found.\r
 **/\r
 EFI_STATUS\r

diff --git a/SignedCapsulePkg/SignedCapsulePkg.dec b/SignedCapsulePkg/SignedCapsulePkg.dec
index 3492de6c8b9eb75fb80af5061281ca948314315b..04dbf62af42a4c09fed52b9f6fcb989f9b7e23d1 100644 (file)
--- a/SignedCapsulePkg/SignedCapsulePkg.dec
+++ b/SignedCapsulePkg/SignedCapsulePkg.dec
@@ -53,7 +53,7 @@
 [PcdsDynamicEx]\r
   ## This dynamic PCD holds the EDKII system firmware image descriptor.\r
   #  This information can be used for version check in EDKII system FMP capsule.\r
 [PcdsDynamicEx]\r
   ## This dynamic PCD holds the EDKII system firmware image descriptor.\r
   #  This information can be used for version check in EDKII system FMP capsule.\r

-  #  Only if the new EdkiiSystemFrimwareImageDescriptor.Version is not less than\r
+  #  Only if the new EdkiiSystemFirmwareImageDescriptor.Version is not less than\r

   #  the current PcdEdkiiSystemFirmwareImageDescriptor.LowestSupportedVersion,\r
   #  the EDKII system FmpCapsule will be processed.\r
   #  The data structure of this PCD is EDKII_SYSTEM_FIRMWARE_IMAGE_DESCRIPTOR,\r
   #  the current PcdEdkiiSystemFirmwareImageDescriptor.LowestSupportedVersion,\r
   #  the EDKII system FmpCapsule will be processed.\r
   #  The data structure of this PCD is EDKII_SYSTEM_FIRMWARE_IMAGE_DESCRIPTOR,\r


@@ -65,7 +65,7 @@
 \r
   ## This dynamic PCD hold the GUID of a firmware FFS which includes EDKII\r
   #  system firmware image.\r
 \r
   ## This dynamic PCD hold the GUID of a firmware FFS which includes EDKII\r
   #  system firmware image.\r

-  #  An EDKII system firmware udpate module need consume this PCD to extract\r
+  #  An EDKII system firmware update module need consume this PCD to extract\r

   #  the EDKII system firmware from the capsule image.\r
   #  It must be in [PcdsDynamicEx], because the EDKII system firmware update module may\r
   #  consume the PCD produced in current system firmware image.\r
   #  the EDKII system firmware from the capsule image.\r
   #  It must be in [PcdsDynamicEx], because the EDKII system firmware update module may\r
   #  consume the PCD produced in current system firmware image.\r