Re: [PATCH v2 69/78] SignedCapsulePkg: Fix various typos

["Yao, Jiewen" <jiewen.yao@intel.com>]

Reviewed-by: jiewen.yao@intel.com

> -----Original Message-----
> From: Philippe Mathieu-Daude <philmd@redhat.com>
> Sent: Friday, January 3, 2020 5:08 PM
> To: devel@edk2.groups.io
> Cc: Antoine Coeur <coeur@gmx.fr>; Yao, Jiewen <jiewen.yao@intel.com>;
> Zhang, Chao B <chao.b.zhang@intel.com>; Philippe Mathieu-Daude
> <philmd@redhat.com>
> Subject: [PATCH v2 69/78] SignedCapsulePkg: Fix various typos
> 
> From: Antoine Coeur <coeur@gmx.fr>
> 
> 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>
> Signed-off-by: Philippe Mathieu-Daude <philmd@redhat.com>
> ---
>  SignedCapsulePkg/SignedCapsulePkg.dec         |  4 +--
>  .../Include/Guid/EdkiiSystemFmpCapsule.h      |  4 +--
>  .../Include/Library/IniParsingLib.h           | 14 +++++-----
>  .../Library/IniParsingLib/IniParsingLib.c     | 26 +++++++++----------
>  4 files changed, 24 insertions(+), 24 deletions(-)
> 
> diff --git a/SignedCapsulePkg/SignedCapsulePkg.dec
> b/SignedCapsulePkg/SignedCapsulePkg.dec
> index 3492de6c8b9e..04dbf62af42a 100644
> --- a/SignedCapsulePkg/SignedCapsulePkg.dec
> +++ b/SignedCapsulePkg/SignedCapsulePkg.dec
> @@ -53,7 +53,7 @@ [PcdsFixedAtBuild, PcdsPatchableInModule, PcdsDynamic,
> PcdsDynamicEx]
>  [PcdsDynamicEx]
>    ## This dynamic PCD holds the EDKII system firmware image descriptor.
>    #  This information can be used for version check in EDKII system FMP capsule.
> -  #  Only if the new EdkiiSystemFrimwareImageDescriptor.Version is not less
> than
> +  #  Only if the new EdkiiSystemFirmwareImageDescriptor.Version is not less
> than
>    #  the current
> PcdEdkiiSystemFirmwareImageDescriptor.LowestSupportedVersion,
>    #  the EDKII system FmpCapsule will be processed.
>    #  The data structure of this PCD is
> EDKII_SYSTEM_FIRMWARE_IMAGE_DESCRIPTOR,
> @@ -65,7 +65,7 @@ [PcdsDynamicEx]
> 
>    ## This dynamic PCD hold the GUID of a firmware FFS which includes EDKII
>    #  system firmware image.
> -  #  An EDKII system firmware udpate module need consume this PCD to extract
> +  #  An EDKII system firmware update module need consume this PCD to extract
>    #  the EDKII system firmware from the capsule image.
>    #  It must be in [PcdsDynamicEx], because the EDKII system firmware update
> module may
>    #  consume the PCD produced in current system firmware image.
> diff --git a/SignedCapsulePkg/Include/Guid/EdkiiSystemFmpCapsule.h
> b/SignedCapsulePkg/Include/Guid/EdkiiSystemFmpCapsule.h
> index 1129d715ae25..8295f92a7341 100644
> --- 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)
>    FileGuid    = XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX  #
> PcdEdkiiSystemFirmwareFileGuid
> 
> -  NOTE: The [Name?] entry may have differnt FileGuid.
> +  NOTE: The [Name?] entry may have different FileGuid.
>    Only the one, whose FileGuid matches PcdEdkiiSystemFirmwareFileGuid, takes
> effect.
>    The other entry is ignored.
> 
> @@ -80,7 +80,7 @@
>    ImageOffset = <ImageOffset>    # Image offset of this SystemFirmware image
> (HEX)
>    FileGuid    = XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX  #
> PcdEdkiiSystemFirmwareFileGuid
> 
> -  NOTE: The [Name?] entry may have differnt FileGuid.
> +  NOTE: The [Name?] entry may have different FileGuid.
>    Only the one, whose FileGuid matches PcdEdkiiSystemFirmwareFileGuid, takes
> effect.
>    The other entry is ignored.
> 
> diff --git a/SignedCapsulePkg/Include/Library/IniParsingLib.h
> b/SignedCapsulePkg/Include/Library/IniParsingLib.h
> index 26d100ffde0a..edfdde7e8d32 100644
> --- 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_]+
>           3.2) a GUID. The valid format is xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx,
> where x is [A-Fa-f0-9]
>           3.3) a decimal value. The valid format is [0-9]+
> -         3.4) a heximal value. The valid format is 0x[A-Fa-f0-9]+
> +         3.4) a hexadecimal value. The valid format is 0x[A-Fa-f0-9]+
>        4) '#' or ';' can be used as comment at anywhere.
>        5) TAB(0x20) or SPACE(0x9) can be used as separator.
>        6) LF(\n, 0xA) or CR(\r, 0xD) can be used as line break.
> @@ -106,14 +106,14 @@ GetDecimalUintnFromDataFile (
>    );
> 
>  /**
> -  Get section entry heximal UINTN value.
> +  Get section entry hexadecimal UINTN value.
> 
>    @param[in]  Context         INI Config file context.
>    @param[in]  SectionName     Section name.
>    @param[in]  EntryName       Section entry name.
> -  @param[out] Data            Point to the got heximal UINTN value.
> +  @param[out] Data            Point to the got hexadecimal UINTN value.
> 
> -  @retval EFI_SUCCESS    Section entry heximal UINTN value is got.
> +  @retval EFI_SUCCESS    Section entry hexadecimal UINTN value is got.
>    @retval EFI_NOT_FOUND  Section is not found.
>  **/
>  EFI_STATUS
> @@ -126,14 +126,14 @@ GetHexUintnFromDataFile (
>    );
> 
>  /**
> -  Get section entry heximal UINT64 value.
> +  Get section entry hexadecimal UINT64 value.
> 
>    @param[in]  Context         INI Config file context.
>    @param[in]  SectionName     Section name.
>    @param[in]  EntryName       Section entry name.
> -  @param[out] Data            Point to the got heximal UINT64 value.
> +  @param[out] Data            Point to the got hexadecimal UINT64 value.
> 
> -  @retval EFI_SUCCESS    Section entry heximal UINT64 value is got.
> +  @retval EFI_SUCCESS    Section entry hexadecimal UINT64 value is got.
>    @retval EFI_NOT_FOUND  Section is not found.
>  **/
>  EFI_STATUS
> diff --git a/SignedCapsulePkg/Library/IniParsingLib/IniParsingLib.c
> b/SignedCapsulePkg/Library/IniParsingLib/IniParsingLib.c
> index 757d65a20647..bea45e0d3be3 100644
> --- 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_]+
>           3.2) a GUID. The valid format is xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx,
> where x is [A-Fa-f0-9]
>           3.3) a decimal value. The valid format is [0-9]+
> -         3.4) a heximal value. The valid format is 0x[A-Fa-f0-9]+
> +         3.4) a hexadecimal value. The valid format is 0x[A-Fa-f0-9]+
>        4) '#' or ';' can be used as comment at anywhere.
>        5) TAB(0x20) or SPACE(0x9) can be used as separator.
>        6) LF(\n, 0xA) or CR(\r, 0xD) can be used as line break.
> @@ -165,13 +165,13 @@ IsValidDecimalString (
>  }
> 
>  /**
> -  Return if the heximal string is valid.
> +  Return if the hexadecimal string is valid.
> 
> -  @param[in] Hex     The heximal string to be checked.
> -  @param[in] Length  The length of heximal string in bytes.
> +  @param[in] Hex     The hexadecimal string to be checked.
> +  @param[in] Length  The length of hexadecimal string in bytes.
> 
> -  @retval TRUE   The heximal string is valid.
> -  @retval FALSE  The heximal string is invalid.
> +  @retval TRUE   The hexadecimal string is valid.
> +  @retval FALSE  The hexadecimal string is invalid.
>  **/
>  BOOLEAN
>  IsValidHexString (
> @@ -388,7 +388,7 @@ ProfileGetLine (
>  /**
>    Trim Buffer by removing all CR, LF, TAB, and SPACE chars in its head and tail.
> 
> -  @param[in, out] Buffer          On input,  buffer data to be trimed.
> +  @param[in, out] Buffer          On input,  buffer data to be trimmed.
>                                    On output, the trimmed buffer.
>    @param[in, out] BufferSize      On input,  size of original buffer data.
>                                    On output, size of the trimmed buffer.
> @@ -1166,14 +1166,14 @@ GetDecimalUintnFromDataFile (
>  }
> 
>  /**
> -  Get section entry heximal UINTN value.
> +  Get section entry hexadecimal UINTN value.
> 
>    @param[in]  Context         INI Config file context.
>    @param[in]  SectionName     Section name.
>    @param[in]  EntryName       Section entry name.
> -  @param[out] Data            Point to the got heximal UINTN value.
> +  @param[out] Data            Point to the got hexadecimal UINTN value.
> 
> -  @retval EFI_SUCCESS    Section entry heximal UINTN value is got.
> +  @retval EFI_SUCCESS    Section entry hexadecimal UINTN value is got.
>    @retval EFI_NOT_FOUND  Section is not found.
>  **/
>  EFI_STATUS
> @@ -1210,14 +1210,14 @@ GetHexUintnFromDataFile (
>  }
> 
>  /**
> -  Get section entry heximal UINT64 value.
> +  Get section entry hexadecimal UINT64 value.
> 
>    @param[in]  Context         INI Config file context.
>    @param[in]  SectionName     Section name.
>    @param[in]  EntryName       Section entry name.
> -  @param[out] Data            Point to the got heximal UINT64 value.
> +  @param[out] Data            Point to the got hexadecimal UINT64 value.
> 
> -  @retval EFI_SUCCESS    Section entry heximal UINT64 value is got.
> +  @retval EFI_SUCCESS    Section entry hexadecimal UINT64 value is got.
>    @retval EFI_NOT_FOUND  Section is not found.
>  **/
>  EFI_STATUS
> --
> 2.21.0