tyler.durden
/
audk
mirror of https://github.com/acidanthera/audk.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

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>
This commit is contained in:
Antoine Coeur 2020-02-07 02:08:22 +01:00 committed by mergify[bot]
parent f16bd39441
commit 582b6cdd08
4 changed files with 24 additions and 24 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

4
SignedCapsulePkg/Include/Guid/EdkiiSystemFmpCapsule.h
View File

@ -60,7 +60,7 @@
ImageOffset = <ImageOffset> # Fv offset of this SystemFirmware image (HEX) ImageOffset = <ImageOffset> # Fv offset of this SystemFirmware image (HEX)
FileGuid = XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX # PcdEdkiiSystemFirmwareFileGuid 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. Only the one, whose FileGuid matches PcdEdkiiSystemFirmwareFileGuid, takes effect.
The other entry is ignored. The other entry is ignored.
@ -80,7 +80,7 @@
ImageOffset = <ImageOffset> # Image offset of this SystemFirmware image (HEX) ImageOffset = <ImageOffset> # Image offset of this SystemFirmware image (HEX)
FileGuid = XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX # PcdEdkiiSystemFirmwareFileGuid 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. Only the one, whose FileGuid matches PcdEdkiiSystemFirmwareFileGuid, takes effect.
The other entry is ignored. The other entry is ignored.

14
SignedCapsulePkg/Include/Library/IniParsingLib.h
View File

@ -14,7 +14,7 @@
3.1) an ASCII String. The valid format is [A-Za-z0-9_]+ 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.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.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. 4) '#' or ';' can be used as comment at anywhere.
5) TAB(0x20) or SPACE(0x9) can be used as separator. 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. 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] Context INI Config file context.
@param[in] SectionName Section name. @param[in] SectionName Section name.
@param[in] EntryName Section entry 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. @retval EFI_NOT_FOUND Section is not found.
**/ **/
EFI_STATUS 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] Context INI Config file context.
@param[in] SectionName Section name. @param[in] SectionName Section name.
@param[in] EntryName Section entry 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. @retval EFI_NOT_FOUND Section is not found.
**/ **/
EFI_STATUS EFI_STATUS

26
SignedCapsulePkg/Library/IniParsingLib/IniParsingLib.c
View File

@ -14,7 +14,7 @@
3.1) an ASCII String. The valid format is [A-Za-z0-9_]+ 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.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.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. 4) '#' or ';' can be used as comment at anywhere.
5) TAB(0x20) or SPACE(0x9) can be used as separator. 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. 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] Hex The hexadecimal string to be checked.
@param[in] Length The length of heximal string in bytes. @param[in] Length The length of hexadecimal string in bytes.
@retval TRUE The heximal string is valid. @retval TRUE The hexadecimal string is valid.
@retval FALSE The heximal string is invalid. @retval FALSE The hexadecimal string is invalid.
**/ **/
BOOLEAN BOOLEAN
IsValidHexString ( IsValidHexString (
@ -388,7 +388,7 @@ ProfileGetLine (
/** /**
Trim Buffer by removing all CR, LF, TAB, and SPACE chars in its head and tail. 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. On output, the trimmed buffer.
@param[in, out] BufferSize On input, size of original buffer data. @param[in, out] BufferSize On input, size of original buffer data.
On output, size of the trimmed buffer. 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] Context INI Config file context.
@param[in] SectionName Section name. @param[in] SectionName Section name.
@param[in] EntryName Section entry 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. @retval EFI_NOT_FOUND Section is not found.
**/ **/
EFI_STATUS 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] Context INI Config file context.
@param[in] SectionName Section name. @param[in] SectionName Section name.
@param[in] EntryName Section entry 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. @retval EFI_NOT_FOUND Section is not found.
**/ **/
EFI_STATUS EFI_STATUS

4
SignedCapsulePkg/SignedCapsulePkg.dec
View File

@ -53,7 +53,7 @@
[PcdsDynamicEx] [PcdsDynamicEx]
## This dynamic PCD holds the EDKII system firmware image descriptor. ## This dynamic PCD holds the EDKII system firmware image descriptor.
# This information can be used for version check in EDKII system FMP capsule. # 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 current PcdEdkiiSystemFirmwareImageDescriptor.LowestSupportedVersion,
# the EDKII system FmpCapsule will be processed. # the EDKII system FmpCapsule will be processed.
# The data structure of this PCD is EDKII_SYSTEM_FIRMWARE_IMAGE_DESCRIPTOR, # The data structure of this PCD is EDKII_SYSTEM_FIRMWARE_IMAGE_DESCRIPTOR,
@ -65,7 +65,7 @@
## This dynamic PCD hold the GUID of a firmware FFS which includes EDKII ## This dynamic PCD hold the GUID of a firmware FFS which includes EDKII
# system firmware image. # 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. # the EDKII system firmware from the capsule image.
# It must be in [PcdsDynamicEx], because the EDKII system firmware update module may # It must be in [PcdsDynamicEx], because the EDKII system firmware update module may
# consume the PCD produced in current system firmware image. # consume the PCD produced in current system firmware image.