* [PATCH v3 01/14] PrmPkg: Fix new typos reported
2022-12-14 22:52 [PATCH v3 00/14] Fix new typos reported Michael Kubacki
@ 2022-12-14 22:52 ` Michael Kubacki
2022-12-20 3:09 ` [edk2-devel] " Ankit Sinha
2022-12-14 22:52 ` [PATCH v3 02/14] StandaloneMmPkg: " Michael Kubacki
` (13 subsequent siblings)
14 siblings, 1 reply; 36+ messages in thread
From: Michael Kubacki @ 2022-12-14 22:52 UTC (permalink / raw)
To: devel; +Cc: Michael Kubacki, Nate DeSimone, Ankit Sinha
From: Michael Kubacki <michael.kubacki@microsoft.com>
The SpellCheck plugin began reporting new typos that were previously
missed. This change fixes those typos.
Cc: Michael Kubacki <mikuback@linux.microsoft.com>
Cc: Nate DeSimone <nathaniel.l.desimone@intel.com>
Cc: Ankit Sinha <ankit.sinha@intel.com>
Signed-off-by: Michael Kubacki <michael.kubacki@microsoft.com>
---
PrmPkg/Application/PrmInfo/PrmInfo.c | 2 +-
PrmPkg/Library/DxePrmModuleDiscoveryLib/DxePrmModuleDiscoveryLib.c | 2 +-
PrmPkg/PrmLoaderDxe/PrmLoaderDxe.c | 2 +-
UnitTestFrameworkPkg/Library/UnitTestUefiBootServicesTableLib/UnitTestUefiBootServicesTableLibImage.c | 2 +-
UnitTestFrameworkPkg/Library/UnitTestUefiBootServicesTableLib/UnitTestUefiBootServicesTableLibProtocol.c | 2 +-
PrmPkg/Include/Library/PrmModuleDiscoveryLib.h | 2 +-
PrmPkg/PrmLoaderDxe/PrmAcpiTable.h | 4 ++--
PrmPkg/PrmPkg.ci.yaml | 9 +++++++++
UnitTestFrameworkPkg/Library/UnitTestUefiBootServicesTableLib/UnitTestUefiBootServicesTableLib.h | 4 ++--
9 files changed, 19 insertions(+), 10 deletions(-)
diff --git a/PrmPkg/Application/PrmInfo/PrmInfo.c b/PrmPkg/Application/PrmInfo/PrmInfo.c
index 0cde2fad3b4b..178d4810f498 100644
--- a/PrmPkg/Application/PrmInfo/PrmInfo.c
+++ b/PrmPkg/Application/PrmInfo/PrmInfo.c
@@ -148,7 +148,7 @@ PrintMmioRuntimeRangeInfo (
Gathers the PRM handler (and by extension module) information discovered on this system.
This function must be called to build up the discovered context for other functions in the application. The
- function will optionally print results as determed by the value of the PrintInformation parameter.
+ function will optionally print results as determined by the value of the PrintInformation parameter.
@param[in] PrintInformation Indicates whether to print information as discovered in the function.
diff --git a/PrmPkg/Library/DxePrmModuleDiscoveryLib/DxePrmModuleDiscoveryLib.c b/PrmPkg/Library/DxePrmModuleDiscoveryLib/DxePrmModuleDiscoveryLib.c
index e6bea47bc583..34373effd4cd 100644
--- a/PrmPkg/Library/DxePrmModuleDiscoveryLib/DxePrmModuleDiscoveryLib.c
+++ b/PrmPkg/Library/DxePrmModuleDiscoveryLib/DxePrmModuleDiscoveryLib.c
@@ -149,7 +149,7 @@ IsAddressInMmram (
/**
Discovers all PRM Modules loaded during boot.
- Each PRM Module discovered is placed into a linked list so the list can br processsed in the future.
+ Each PRM Module discovered is placed into a linked list so the list can br processed in the future.
@param[out] ModuleCount An optional pointer parameter that, if provided, is set to the number
of PRM modules discovered.
diff --git a/PrmPkg/PrmLoaderDxe/PrmLoaderDxe.c b/PrmPkg/PrmLoaderDxe/PrmLoaderDxe.c
index 5a223d783d80..7b0042f133ef 100644
--- a/PrmPkg/PrmLoaderDxe/PrmLoaderDxe.c
+++ b/PrmPkg/PrmLoaderDxe/PrmLoaderDxe.c
@@ -295,7 +295,7 @@ PublishPrmAcpiTable (
time of this function invocation.
The main responsibilities of the PRM Loader are executed from this function which include 3 phases:
- 1.) Disover PRM Modules - Find all PRM modules loaded during DXE dispatch and insert a PRM Module
+ 1.) Discover PRM Modules - Find all PRM modules loaded during DXE dispatch and insert a PRM Module
Context entry into a linked list to be handed off to phase 2.
2.) Process PRM Modules - Build a GUID to PRM handler mapping for each module that is described in the
PRM ACPI table so the OS can resolve a PRM Handler GUID to the corresponding PRM Handler physical address.
diff --git a/UnitTestFrameworkPkg/Library/UnitTestUefiBootServicesTableLib/UnitTestUefiBootServicesTableLibImage.c b/UnitTestFrameworkPkg/Library/UnitTestUefiBootServicesTableLib/UnitTestUefiBootServicesTableLibImage.c
index 144cc33e25c0..7c1c4b854b65 100644
--- a/UnitTestFrameworkPkg/Library/UnitTestUefiBootServicesTableLib/UnitTestUefiBootServicesTableLibImage.c
+++ b/UnitTestFrameworkPkg/Library/UnitTestUefiBootServicesTableLib/UnitTestUefiBootServicesTableLibImage.c
@@ -130,7 +130,7 @@ UnitTestExit (
@retval EFI_SUCCESS The image has been unloaded.
@retval EFI_UNSUPPORTED The image has been started, and does not support
unload.
- @retval EFI_INVALID_PARAMPETER ImageHandle is not a valid image handle.
+ @retval EFI_INVALID_PARAMETER ImageHandle is not a valid image handle.
**/
EFI_STATUS
diff --git a/UnitTestFrameworkPkg/Library/UnitTestUefiBootServicesTableLib/UnitTestUefiBootServicesTableLibProtocol.c b/UnitTestFrameworkPkg/Library/UnitTestUefiBootServicesTableLib/UnitTestUefiBootServicesTableLibProtocol.c
index 437082d516ea..3d8110c8f8cd 100644
--- a/UnitTestFrameworkPkg/Library/UnitTestUefiBootServicesTableLib/UnitTestUefiBootServicesTableLibProtocol.c
+++ b/UnitTestFrameworkPkg/Library/UnitTestUefiBootServicesTableLib/UnitTestUefiBootServicesTableLibProtocol.c
@@ -723,7 +723,7 @@ UnitTestReinstallProtocolInterface (
}
/**
- Uninstalls all instances of a protocol:interfacer from a handle.
+ Uninstalls all instances of a protocol from a handle.
If the last protocol interface is remove from the handle, the
handle is freed.
diff --git a/PrmPkg/Include/Library/PrmModuleDiscoveryLib.h b/PrmPkg/Include/Library/PrmModuleDiscoveryLib.h
index 341b9b26a0f8..9df8d4d02370 100644
--- a/PrmPkg/Include/Library/PrmModuleDiscoveryLib.h
+++ b/PrmPkg/Include/Library/PrmModuleDiscoveryLib.h
@@ -34,7 +34,7 @@ GetNextPrmModuleEntry (
/**
Discovers all PRM Modules loaded during boot.
- Each PRM Module discovered is placed into a linked list so the list can br processsed in the future.
+ Each PRM Module discovered is placed into a linked list so the list can br processed in the future.
@param[out] ModuleCount An optional pointer parameter that, if provided, is set to the number
of PRM modules discovered.
diff --git a/PrmPkg/PrmLoaderDxe/PrmAcpiTable.h b/PrmPkg/PrmLoaderDxe/PrmAcpiTable.h
index e2034d4738bd..fdb708c2a112 100644
--- a/PrmPkg/PrmLoaderDxe/PrmAcpiTable.h
+++ b/PrmPkg/PrmLoaderDxe/PrmAcpiTable.h
@@ -72,7 +72,7 @@ typedef struct {
//
// Todo: Revisit whether to use; currently both macros are not used
//
-#define PRM_MODULE_INFORMATION_STRUCTURE(ModuleGuid, ModuleRevision, HandlerCount, PrmHanderInfoStructureArray) { \
+#define PRM_MODULE_INFORMATION_STRUCTURE(ModuleGuid, ModuleRevision, HandlerCount, PrmHandlerInfoStructureArray) { \
{ \
PRM_MODULE_INFORMATION_STRUCT_REVISION, /* UINT16 StructureRevision; */ \
(OFFSET_OF (PRM_MODULE_INFORMATION_STRUCT, HandlerInfoStructure) + (HandlerCount * sizeof (PRM_HANDLER_INFORMATION_STRUCT))) /* UINT16 StructureLength; */ \
@@ -80,7 +80,7 @@ typedef struct {
ModuleRevision, /* UINT16 ModuleRevision */ \
HandlerCount, /* UINT16 HandlerCount */ \
OFFSET_OF (PRM_MODULE_INFORMATION_STRUCT, HandlerInfoOffset), /* UINT32 HandlerInfoOffset */ \
- PrmHanderInfoStructureArray /* PRM_HANDLER_INFORMATION_STRUCT HandlerInfoStructure */ \
+ PrmHandlerInfoStructureArray /* PRM_HANDLER_INFORMATION_STRUCT HandlerInfoStructure */ \
} \
}
diff --git a/PrmPkg/PrmPkg.ci.yaml b/PrmPkg/PrmPkg.ci.yaml
index 2d4d12815d6b..521d95a2620f 100644
--- a/PrmPkg/PrmPkg.ci.yaml
+++ b/PrmPkg/PrmPkg.ci.yaml
@@ -94,10 +94,19 @@
# in matching files
"ExtendWords": [ # words to extend to the dictionary for this package
"buffe", # note: appears in buffer ascii dump in documentation
+ "dbgmsgid",
+ "devicepath",
"iptor", # note: appears in buffer ascii dump in documentation
"keepoptionalheader",
"odule", # note: appears in buffer ascii dump in documentation
"oemid",
+ "packagelist",
+ "pecoff",
+ "prmconfig",
+ "prmcontextbufferlib",
+ "prminfo",
+ "prmloader",
+ "prmmodulediscoverylib",
"prmopreg",
"prmpecofflib",
"prmpkg",
diff --git a/UnitTestFrameworkPkg/Library/UnitTestUefiBootServicesTableLib/UnitTestUefiBootServicesTableLib.h b/UnitTestFrameworkPkg/Library/UnitTestUefiBootServicesTableLib/UnitTestUefiBootServicesTableLib.h
index 82853bb61a1c..20958589b254 100644
--- a/UnitTestFrameworkPkg/Library/UnitTestUefiBootServicesTableLib/UnitTestUefiBootServicesTableLib.h
+++ b/UnitTestFrameworkPkg/Library/UnitTestUefiBootServicesTableLib/UnitTestUefiBootServicesTableLib.h
@@ -354,7 +354,7 @@ UnitTestReinstallProtocolInterface (
);
/**
- Uninstalls all instances of a protocol:interfacer from a handle.
+ Uninstalls all instances of a protocol from a handle.
If the last protocol interface is remove from the handle, the
handle is freed.
@@ -600,7 +600,7 @@ UnitTestExit (
@retval EFI_SUCCESS The image has been unloaded.
@retval EFI_UNSUPPORTED The image has been started, and does not support
unload.
- @retval EFI_INVALID_PARAMPETER ImageHandle is not a valid image handle.
+ @retval EFI_INVALID_PARAMETER ImageHandle is not a valid image handle.
**/
EFI_STATUS
--
2.28.0.windows.1
^ permalink raw reply related [flat|nested] 36+ messages in thread* Re: [edk2-devel] [PATCH v3 01/14] PrmPkg: Fix new typos reported
2022-12-14 22:52 ` [PATCH v3 01/14] PrmPkg: " Michael Kubacki
@ 2022-12-20 3:09 ` Ankit Sinha
2022-12-20 22:19 ` Michael Kubacki
0 siblings, 1 reply; 36+ messages in thread
From: Ankit Sinha @ 2022-12-20 3:09 UTC (permalink / raw)
To: devel@edk2.groups.io, mikuback@linux.microsoft.com; +Cc: Desimone, Nathaniel L
Hi Michael,
There is a typo that got missed in one of the modified comments. In file "b/PrmPkg/Include/Library/PrmModuleDiscoveryLib.h":
- Each PRM Module discovered is placed into a linked list so the list can br processsed in the future.
+ Each PRM Module discovered is placed into a linked list so the list can br processed in the future.
'br' should change to 'be'
Thank you,
Ankit
> -----Original Message-----
> From: devel@edk2.groups.io <devel@edk2.groups.io> On Behalf Of Michael
> Kubacki
> Sent: Wednesday, December 14, 2022 2:53 PM
> To: devel@edk2.groups.io
> Cc: Michael Kubacki <mikuback@linux.microsoft.com>; Desimone, Nathaniel
> L <nathaniel.l.desimone@intel.com>; Sinha, Ankit <ankit.sinha@intel.com>
> Subject: [edk2-devel] [PATCH v3 01/14] PrmPkg: Fix new typos reported
>
> From: Michael Kubacki <michael.kubacki@microsoft.com>
>
> The SpellCheck plugin began reporting new typos that were previously
> missed. This change fixes those typos.
>
> Cc: Michael Kubacki <mikuback@linux.microsoft.com>
> Cc: Nate DeSimone <nathaniel.l.desimone@intel.com>
> Cc: Ankit Sinha <ankit.sinha@intel.com>
> Signed-off-by: Michael Kubacki <michael.kubacki@microsoft.com>
> ---
> PrmPkg/Application/PrmInfo/PrmInfo.c
> | 2 +-
> PrmPkg/Library/DxePrmModuleDiscoveryLib/DxePrmModuleDiscoveryLib.c
> | 2 +-
> PrmPkg/PrmLoaderDxe/PrmLoaderDxe.c
> | 2 +-
>
> UnitTestFrameworkPkg/Library/UnitTestUefiBootServicesTableLib/UnitTestU
> efiBootServicesTableLibImage.c | 2 +-
>
> UnitTestFrameworkPkg/Library/UnitTestUefiBootServicesTableLib/UnitTestU
> efiBootServicesTableLibProtocol.c | 2 +-
> PrmPkg/Include/Library/PrmModuleDiscoveryLib.h
> | 2 +-
> PrmPkg/PrmLoaderDxe/PrmAcpiTable.h
> | 4 ++--
> PrmPkg/PrmPkg.ci.yaml | 9
> +++++++++
>
> UnitTestFrameworkPkg/Library/UnitTestUefiBootServicesTableLib/UnitTestU
> efiBootServicesTableLib.h | 4 ++--
> 9 files changed, 19 insertions(+), 10 deletions(-)
>
> diff --git a/PrmPkg/Application/PrmInfo/PrmInfo.c
> b/PrmPkg/Application/PrmInfo/PrmInfo.c
> index 0cde2fad3b4b..178d4810f498 100644
> --- a/PrmPkg/Application/PrmInfo/PrmInfo.c
> +++ b/PrmPkg/Application/PrmInfo/PrmInfo.c
> @@ -148,7 +148,7 @@ PrintMmioRuntimeRangeInfo (
> Gathers the PRM handler (and by extension module) information
> discovered on this system.
>
> This function must be called to build up the discovered context for other
> functions in the application. The
> - function will optionally print results as determed by the value of the
> PrintInformation parameter.
> + function will optionally print results as determined by the value of the
> PrintInformation parameter.
>
> @param[in] PrintInformation Indicates whether to print information
> as discovered in the function.
>
> diff --git
> a/PrmPkg/Library/DxePrmModuleDiscoveryLib/DxePrmModuleDiscoveryLib.
> c
> b/PrmPkg/Library/DxePrmModuleDiscoveryLib/DxePrmModuleDiscoveryLib.
> c
> index e6bea47bc583..34373effd4cd 100644
> ---
> a/PrmPkg/Library/DxePrmModuleDiscoveryLib/DxePrmModuleDiscoveryLib.
> c
> +++
> b/PrmPkg/Library/DxePrmModuleDiscoveryLib/DxePrmModuleDiscoveryLib.
> c
> @@ -149,7 +149,7 @@ IsAddressInMmram (
> /**
> Discovers all PRM Modules loaded during boot.
>
> - Each PRM Module discovered is placed into a linked list so the list can br
> processsed in the future.
> + Each PRM Module discovered is placed into a linked list so the list can br
> processed in the future.
>
> @param[out] ModuleCount An optional pointer parameter that, if
> provided, is set to the number
> of PRM modules discovered.
> diff --git a/PrmPkg/PrmLoaderDxe/PrmLoaderDxe.c
> b/PrmPkg/PrmLoaderDxe/PrmLoaderDxe.c
> index 5a223d783d80..7b0042f133ef 100644
> --- a/PrmPkg/PrmLoaderDxe/PrmLoaderDxe.c
> +++ b/PrmPkg/PrmLoaderDxe/PrmLoaderDxe.c
> @@ -295,7 +295,7 @@ PublishPrmAcpiTable (
> time of this function invocation.
>
> The main responsibilities of the PRM Loader are executed from this
> function which include 3 phases:
> - 1.) Disover PRM Modules - Find all PRM modules loaded during DXE
> dispatch and insert a PRM Module
> + 1.) Discover PRM Modules - Find all PRM modules loaded during DXE
> + dispatch and insert a PRM Module
> Context entry into a linked list to be handed off to phase 2.
> 2.) Process PRM Modules - Build a GUID to PRM handler mapping for each
> module that is described in the
> PRM ACPI table so the OS can resolve a PRM Handler GUID to the
> corresponding PRM Handler physical address.
> diff --git
> a/UnitTestFrameworkPkg/Library/UnitTestUefiBootServicesTableLib/UnitTest
> UefiBootServicesTableLibImage.c
> b/UnitTestFrameworkPkg/Library/UnitTestUefiBootServicesTableLib/UnitTest
> UefiBootServicesTableLibImage.c
> index 144cc33e25c0..7c1c4b854b65 100644
> ---
> a/UnitTestFrameworkPkg/Library/UnitTestUefiBootServicesTableLib/UnitTest
> UefiBootServicesTableLibImage.c
> +++ b/UnitTestFrameworkPkg/Library/UnitTestUefiBootServicesTableLib/Unit
> +++ TestUefiBootServicesTableLibImage.c
> @@ -130,7 +130,7 @@ UnitTestExit (
> @retval EFI_SUCCESS The image has been unloaded.
> @retval EFI_UNSUPPORTED The image has been started, and does not
> support
> unload.
> - @retval EFI_INVALID_PARAMPETER ImageHandle is not a valid image
> handle.
> + @retval EFI_INVALID_PARAMETER ImageHandle is not a valid image
> handle.
>
> **/
> EFI_STATUS
> diff --git
> a/UnitTestFrameworkPkg/Library/UnitTestUefiBootServicesTableLib/UnitTest
> UefiBootServicesTableLibProtocol.c
> b/UnitTestFrameworkPkg/Library/UnitTestUefiBootServicesTableLib/UnitTest
> UefiBootServicesTableLibProtocol.c
> index 437082d516ea..3d8110c8f8cd 100644
> ---
> a/UnitTestFrameworkPkg/Library/UnitTestUefiBootServicesTableLib/UnitTest
> UefiBootServicesTableLibProtocol.c
> +++ b/UnitTestFrameworkPkg/Library/UnitTestUefiBootServicesTableLib/Unit
> +++ TestUefiBootServicesTableLibProtocol.c
> @@ -723,7 +723,7 @@ UnitTestReinstallProtocolInterface ( }
>
> /**
> - Uninstalls all instances of a protocol:interfacer from a handle.
> + Uninstalls all instances of a protocol from a handle.
> If the last protocol interface is remove from the handle, the
> handle is freed.
>
> diff --git a/PrmPkg/Include/Library/PrmModuleDiscoveryLib.h
> b/PrmPkg/Include/Library/PrmModuleDiscoveryLib.h
> index 341b9b26a0f8..9df8d4d02370 100644
> --- a/PrmPkg/Include/Library/PrmModuleDiscoveryLib.h
> +++ b/PrmPkg/Include/Library/PrmModuleDiscoveryLib.h
> @@ -34,7 +34,7 @@ GetNextPrmModuleEntry (
> /**
> Discovers all PRM Modules loaded during boot.
>
> - Each PRM Module discovered is placed into a linked list so the list can br
> processsed in the future.
> + Each PRM Module discovered is placed into a linked list so the list can br
> processed in the future.
>
> @param[out] ModuleCount An optional pointer parameter that, if
> provided, is set to the number
> of PRM modules discovered.
> diff --git a/PrmPkg/PrmLoaderDxe/PrmAcpiTable.h
> b/PrmPkg/PrmLoaderDxe/PrmAcpiTable.h
> index e2034d4738bd..fdb708c2a112 100644
> --- a/PrmPkg/PrmLoaderDxe/PrmAcpiTable.h
> +++ b/PrmPkg/PrmLoaderDxe/PrmAcpiTable.h
> @@ -72,7 +72,7 @@ typedef struct {
> //
> // Todo: Revisit whether to use; currently both macros are not used //
> -#define PRM_MODULE_INFORMATION_STRUCTURE(ModuleGuid,
> ModuleRevision, HandlerCount, PrmHanderInfoStructureArray) {
> \
> +#define PRM_MODULE_INFORMATION_STRUCTURE(ModuleGuid,
> ModuleRevision, HandlerCount, PrmHandlerInfoStructureArray) {
> \
> { \
> PRM_MODULE_INFORMATION_STRUCT_REVISION,
> /* UINT16 StructureRevision; */ \
> (OFFSET_OF (PRM_MODULE_INFORMATION_STRUCT,
> HandlerInfoStructure) + (HandlerCount * sizeof
> (PRM_HANDLER_INFORMATION_STRUCT))) /* UINT16 StructureLength;
> */ \
> @@ -80,7 +80,7 @@ typedef struct {
> ModuleRevision,
> /* UINT16 ModuleRevision */ \
> HandlerCount,
> /* UINT16 HandlerCount */ \
> OFFSET_OF (PRM_MODULE_INFORMATION_STRUCT, HandlerInfoOffset),
> /* UINT32 HandlerInfoOffset */ \
> - PrmHanderInfoStructureArray
> /* PRM_HANDLER_INFORMATION_STRUCT HandlerInfoStructure */ \
> + PrmHandlerInfoStructureArray
> /* PRM_HANDLER_INFORMATION_STRUCT HandlerInfoStructure */ \
> } \
> }
>
> diff --git a/PrmPkg/PrmPkg.ci.yaml b/PrmPkg/PrmPkg.ci.yaml index
> 2d4d12815d6b..521d95a2620f 100644
> --- a/PrmPkg/PrmPkg.ci.yaml
> +++ b/PrmPkg/PrmPkg.ci.yaml
> @@ -94,10 +94,19 @@
> # in matching files
> "ExtendWords": [ # words to extend to the dictionary for this
> package
> "buffe", # note: appears in buffer ascii dump in
> documentation
> + "dbgmsgid",
> + "devicepath",
> "iptor", # note: appears in buffer ascii dump in
> documentation
> "keepoptionalheader",
> "odule", # note: appears in buffer ascii dump in
> documentation
> "oemid",
> + "packagelist",
> + "pecoff",
> + "prmconfig",
> + "prmcontextbufferlib",
> + "prminfo",
> + "prmloader",
> + "prmmodulediscoverylib",
> "prmopreg",
> "prmpecofflib",
> "prmpkg",
> diff --git
> a/UnitTestFrameworkPkg/Library/UnitTestUefiBootServicesTableLib/UnitTest
> UefiBootServicesTableLib.h
> b/UnitTestFrameworkPkg/Library/UnitTestUefiBootServicesTableLib/UnitTest
> UefiBootServicesTableLib.h
> index 82853bb61a1c..20958589b254 100644
> ---
> a/UnitTestFrameworkPkg/Library/UnitTestUefiBootServicesTableLib/UnitTest
> UefiBootServicesTableLib.h
> +++ b/UnitTestFrameworkPkg/Library/UnitTestUefiBootServicesTableLib/Unit
> +++ TestUefiBootServicesTableLib.h
> @@ -354,7 +354,7 @@ UnitTestReinstallProtocolInterface (
> );
>
> /**
> - Uninstalls all instances of a protocol:interfacer from a handle.
> + Uninstalls all instances of a protocol from a handle.
> If the last protocol interface is remove from the handle, the
> handle is freed.
>
> @@ -600,7 +600,7 @@ UnitTestExit (
> @retval EFI_SUCCESS The image has been unloaded.
> @retval EFI_UNSUPPORTED The image has been started, and does not
> support
> unload.
> - @retval EFI_INVALID_PARAMPETER ImageHandle is not a valid image
> handle.
> + @retval EFI_INVALID_PARAMETER ImageHandle is not a valid image
> handle.
>
> **/
> EFI_STATUS
> --
> 2.28.0.windows.1
>
>
>
> -=-=-=-=-=-=
> Groups.io Links: You receive all messages sent to this group.
> View/Reply Online (#97382): https://edk2.groups.io/g/devel/message/97382
> Mute This Topic: https://groups.io/mt/95678199/1772825
> Group Owner: devel+owner@edk2.groups.io
> Unsubscribe: https://edk2.groups.io/g/devel/unsub [ankit.sinha@intel.com]
> -=-=-=-=-=-=
>
^ permalink raw reply [flat|nested] 36+ messages in thread* Re: [edk2-devel] [PATCH v3 01/14] PrmPkg: Fix new typos reported
2022-12-20 3:09 ` [edk2-devel] " Ankit Sinha
@ 2022-12-20 22:19 ` Michael Kubacki
0 siblings, 0 replies; 36+ messages in thread
From: Michael Kubacki @ 2022-12-20 22:19 UTC (permalink / raw)
To: devel, ankit.sinha; +Cc: Desimone, Nathaniel L
Thanks Ankit
On 12/19/2022 10:09 PM, Ankit Sinha wrote:
> Hi Michael,
>
> There is a typo that got missed in one of the modified comments. In file "b/PrmPkg/Include/Library/PrmModuleDiscoveryLib.h":
>
> - Each PRM Module discovered is placed into a linked list so the list can br processsed in the future.
> + Each PRM Module discovered is placed into a linked list so the list can br processed in the future.
>
> 'br' should change to 'be'
>
> Thank you,
> Ankit
>
>> -----Original Message-----
>> From: devel@edk2.groups.io <devel@edk2.groups.io> On Behalf Of Michael
>> Kubacki
>> Sent: Wednesday, December 14, 2022 2:53 PM
>> To: devel@edk2.groups.io
>> Cc: Michael Kubacki <mikuback@linux.microsoft.com>; Desimone, Nathaniel
>> L <nathaniel.l.desimone@intel.com>; Sinha, Ankit <ankit.sinha@intel.com>
>> Subject: [edk2-devel] [PATCH v3 01/14] PrmPkg: Fix new typos reported
>>
>> From: Michael Kubacki <michael.kubacki@microsoft.com>
>>
>> The SpellCheck plugin began reporting new typos that were previously
>> missed. This change fixes those typos.
>>
>> Cc: Michael Kubacki <mikuback@linux.microsoft.com>
>> Cc: Nate DeSimone <nathaniel.l.desimone@intel.com>
>> Cc: Ankit Sinha <ankit.sinha@intel.com>
>> Signed-off-by: Michael Kubacki <michael.kubacki@microsoft.com>
>> ---
>> PrmPkg/Application/PrmInfo/PrmInfo.c
>> | 2 +-
>> PrmPkg/Library/DxePrmModuleDiscoveryLib/DxePrmModuleDiscoveryLib.c
>> | 2 +-
>> PrmPkg/PrmLoaderDxe/PrmLoaderDxe.c
>> | 2 +-
>>
>> UnitTestFrameworkPkg/Library/UnitTestUefiBootServicesTableLib/UnitTestU
>> efiBootServicesTableLibImage.c | 2 +-
>>
>> UnitTestFrameworkPkg/Library/UnitTestUefiBootServicesTableLib/UnitTestU
>> efiBootServicesTableLibProtocol.c | 2 +-
>> PrmPkg/Include/Library/PrmModuleDiscoveryLib.h
>> | 2 +-
>> PrmPkg/PrmLoaderDxe/PrmAcpiTable.h
>> | 4 ++--
>> PrmPkg/PrmPkg.ci.yaml | 9
>> +++++++++
>>
>> UnitTestFrameworkPkg/Library/UnitTestUefiBootServicesTableLib/UnitTestU
>> efiBootServicesTableLib.h | 4 ++--
>> 9 files changed, 19 insertions(+), 10 deletions(-)
>>
>> diff --git a/PrmPkg/Application/PrmInfo/PrmInfo.c
>> b/PrmPkg/Application/PrmInfo/PrmInfo.c
>> index 0cde2fad3b4b..178d4810f498 100644
>> --- a/PrmPkg/Application/PrmInfo/PrmInfo.c
>> +++ b/PrmPkg/Application/PrmInfo/PrmInfo.c
>> @@ -148,7 +148,7 @@ PrintMmioRuntimeRangeInfo (
>> Gathers the PRM handler (and by extension module) information
>> discovered on this system.
>>
>> This function must be called to build up the discovered context for other
>> functions in the application. The
>> - function will optionally print results as determed by the value of the
>> PrintInformation parameter.
>> + function will optionally print results as determined by the value of the
>> PrintInformation parameter.
>>
>> @param[in] PrintInformation Indicates whether to print information
>> as discovered in the function.
>>
>> diff --git
>> a/PrmPkg/Library/DxePrmModuleDiscoveryLib/DxePrmModuleDiscoveryLib.
>> c
>> b/PrmPkg/Library/DxePrmModuleDiscoveryLib/DxePrmModuleDiscoveryLib.
>> c
>> index e6bea47bc583..34373effd4cd 100644
>> ---
>> a/PrmPkg/Library/DxePrmModuleDiscoveryLib/DxePrmModuleDiscoveryLib.
>> c
>> +++
>> b/PrmPkg/Library/DxePrmModuleDiscoveryLib/DxePrmModuleDiscoveryLib.
>> c
>> @@ -149,7 +149,7 @@ IsAddressInMmram (
>> /**
>> Discovers all PRM Modules loaded during boot.
>>
>> - Each PRM Module discovered is placed into a linked list so the list can br
>> processsed in the future.
>> + Each PRM Module discovered is placed into a linked list so the list can br
>> processed in the future.
>>
>> @param[out] ModuleCount An optional pointer parameter that, if
>> provided, is set to the number
>> of PRM modules discovered.
>> diff --git a/PrmPkg/PrmLoaderDxe/PrmLoaderDxe.c
>> b/PrmPkg/PrmLoaderDxe/PrmLoaderDxe.c
>> index 5a223d783d80..7b0042f133ef 100644
>> --- a/PrmPkg/PrmLoaderDxe/PrmLoaderDxe.c
>> +++ b/PrmPkg/PrmLoaderDxe/PrmLoaderDxe.c
>> @@ -295,7 +295,7 @@ PublishPrmAcpiTable (
>> time of this function invocation.
>>
>> The main responsibilities of the PRM Loader are executed from this
>> function which include 3 phases:
>> - 1.) Disover PRM Modules - Find all PRM modules loaded during DXE
>> dispatch and insert a PRM Module
>> + 1.) Discover PRM Modules - Find all PRM modules loaded during DXE
>> + dispatch and insert a PRM Module
>> Context entry into a linked list to be handed off to phase 2.
>> 2.) Process PRM Modules - Build a GUID to PRM handler mapping for each
>> module that is described in the
>> PRM ACPI table so the OS can resolve a PRM Handler GUID to the
>> corresponding PRM Handler physical address.
>> diff --git
>> a/UnitTestFrameworkPkg/Library/UnitTestUefiBootServicesTableLib/UnitTest
>> UefiBootServicesTableLibImage.c
>> b/UnitTestFrameworkPkg/Library/UnitTestUefiBootServicesTableLib/UnitTest
>> UefiBootServicesTableLibImage.c
>> index 144cc33e25c0..7c1c4b854b65 100644
>> ---
>> a/UnitTestFrameworkPkg/Library/UnitTestUefiBootServicesTableLib/UnitTest
>> UefiBootServicesTableLibImage.c
>> +++ b/UnitTestFrameworkPkg/Library/UnitTestUefiBootServicesTableLib/Unit
>> +++ TestUefiBootServicesTableLibImage.c
>> @@ -130,7 +130,7 @@ UnitTestExit (
>> @retval EFI_SUCCESS The image has been unloaded.
>> @retval EFI_UNSUPPORTED The image has been started, and does not
>> support
>> unload.
>> - @retval EFI_INVALID_PARAMPETER ImageHandle is not a valid image
>> handle.
>> + @retval EFI_INVALID_PARAMETER ImageHandle is not a valid image
>> handle.
>>
>> **/
>> EFI_STATUS
>> diff --git
>> a/UnitTestFrameworkPkg/Library/UnitTestUefiBootServicesTableLib/UnitTest
>> UefiBootServicesTableLibProtocol.c
>> b/UnitTestFrameworkPkg/Library/UnitTestUefiBootServicesTableLib/UnitTest
>> UefiBootServicesTableLibProtocol.c
>> index 437082d516ea..3d8110c8f8cd 100644
>> ---
>> a/UnitTestFrameworkPkg/Library/UnitTestUefiBootServicesTableLib/UnitTest
>> UefiBootServicesTableLibProtocol.c
>> +++ b/UnitTestFrameworkPkg/Library/UnitTestUefiBootServicesTableLib/Unit
>> +++ TestUefiBootServicesTableLibProtocol.c
>> @@ -723,7 +723,7 @@ UnitTestReinstallProtocolInterface ( }
>>
>> /**
>> - Uninstalls all instances of a protocol:interfacer from a handle.
>> + Uninstalls all instances of a protocol from a handle.
>> If the last protocol interface is remove from the handle, the
>> handle is freed.
>>
>> diff --git a/PrmPkg/Include/Library/PrmModuleDiscoveryLib.h
>> b/PrmPkg/Include/Library/PrmModuleDiscoveryLib.h
>> index 341b9b26a0f8..9df8d4d02370 100644
>> --- a/PrmPkg/Include/Library/PrmModuleDiscoveryLib.h
>> +++ b/PrmPkg/Include/Library/PrmModuleDiscoveryLib.h
>> @@ -34,7 +34,7 @@ GetNextPrmModuleEntry (
>> /**
>> Discovers all PRM Modules loaded during boot.
>>
>> - Each PRM Module discovered is placed into a linked list so the list can br
>> processsed in the future.
>> + Each PRM Module discovered is placed into a linked list so the list can br
>> processed in the future.
>>
>> @param[out] ModuleCount An optional pointer parameter that, if
>> provided, is set to the number
>> of PRM modules discovered.
>> diff --git a/PrmPkg/PrmLoaderDxe/PrmAcpiTable.h
>> b/PrmPkg/PrmLoaderDxe/PrmAcpiTable.h
>> index e2034d4738bd..fdb708c2a112 100644
>> --- a/PrmPkg/PrmLoaderDxe/PrmAcpiTable.h
>> +++ b/PrmPkg/PrmLoaderDxe/PrmAcpiTable.h
>> @@ -72,7 +72,7 @@ typedef struct {
>> //
>> // Todo: Revisit whether to use; currently both macros are not used //
>> -#define PRM_MODULE_INFORMATION_STRUCTURE(ModuleGuid,
>> ModuleRevision, HandlerCount, PrmHanderInfoStructureArray) {
>> \
>> +#define PRM_MODULE_INFORMATION_STRUCTURE(ModuleGuid,
>> ModuleRevision, HandlerCount, PrmHandlerInfoStructureArray) {
>> \
>> { \
>> PRM_MODULE_INFORMATION_STRUCT_REVISION,
>> /* UINT16 StructureRevision; */ \
>> (OFFSET_OF (PRM_MODULE_INFORMATION_STRUCT,
>> HandlerInfoStructure) + (HandlerCount * sizeof
>> (PRM_HANDLER_INFORMATION_STRUCT))) /* UINT16 StructureLength;
>> */ \
>> @@ -80,7 +80,7 @@ typedef struct {
>> ModuleRevision,
>> /* UINT16 ModuleRevision */ \
>> HandlerCount,
>> /* UINT16 HandlerCount */ \
>> OFFSET_OF (PRM_MODULE_INFORMATION_STRUCT, HandlerInfoOffset),
>> /* UINT32 HandlerInfoOffset */ \
>> - PrmHanderInfoStructureArray
>> /* PRM_HANDLER_INFORMATION_STRUCT HandlerInfoStructure */ \
>> + PrmHandlerInfoStructureArray
>> /* PRM_HANDLER_INFORMATION_STRUCT HandlerInfoStructure */ \
>> } \
>> }
>>
>> diff --git a/PrmPkg/PrmPkg.ci.yaml b/PrmPkg/PrmPkg.ci.yaml index
>> 2d4d12815d6b..521d95a2620f 100644
>> --- a/PrmPkg/PrmPkg.ci.yaml
>> +++ b/PrmPkg/PrmPkg.ci.yaml
>> @@ -94,10 +94,19 @@
>> # in matching files
>> "ExtendWords": [ # words to extend to the dictionary for this
>> package
>> "buffe", # note: appears in buffer ascii dump in
>> documentation
>> + "dbgmsgid",
>> + "devicepath",
>> "iptor", # note: appears in buffer ascii dump in
>> documentation
>> "keepoptionalheader",
>> "odule", # note: appears in buffer ascii dump in
>> documentation
>> "oemid",
>> + "packagelist",
>> + "pecoff",
>> + "prmconfig",
>> + "prmcontextbufferlib",
>> + "prminfo",
>> + "prmloader",
>> + "prmmodulediscoverylib",
>> "prmopreg",
>> "prmpecofflib",
>> "prmpkg",
>> diff --git
>> a/UnitTestFrameworkPkg/Library/UnitTestUefiBootServicesTableLib/UnitTest
>> UefiBootServicesTableLib.h
>> b/UnitTestFrameworkPkg/Library/UnitTestUefiBootServicesTableLib/UnitTest
>> UefiBootServicesTableLib.h
>> index 82853bb61a1c..20958589b254 100644
>> ---
>> a/UnitTestFrameworkPkg/Library/UnitTestUefiBootServicesTableLib/UnitTest
>> UefiBootServicesTableLib.h
>> +++ b/UnitTestFrameworkPkg/Library/UnitTestUefiBootServicesTableLib/Unit
>> +++ TestUefiBootServicesTableLib.h
>> @@ -354,7 +354,7 @@ UnitTestReinstallProtocolInterface (
>> );
>>
>> /**
>> - Uninstalls all instances of a protocol:interfacer from a handle.
>> + Uninstalls all instances of a protocol from a handle.
>> If the last protocol interface is remove from the handle, the
>> handle is freed.
>>
>> @@ -600,7 +600,7 @@ UnitTestExit (
>> @retval EFI_SUCCESS The image has been unloaded.
>> @retval EFI_UNSUPPORTED The image has been started, and does not
>> support
>> unload.
>> - @retval EFI_INVALID_PARAMPETER ImageHandle is not a valid image
>> handle.
>> + @retval EFI_INVALID_PARAMETER ImageHandle is not a valid image
>> handle.
>>
>> **/
>> EFI_STATUS
>> --
>> 2.28.0.windows.1
>>
>>
>>
>> -=-=-=-=-=-=
>> Groups.io Links: You receive all messages sent to this group.
>> View/Reply Online (#97382): https://edk2.groups.io/g/devel/message/97382
>> Mute This Topic: https://groups.io/mt/95678199/1772825
>> Group Owner: devel+owner@edk2.groups.io
>> Unsubscribe: https://edk2.groups.io/g/devel/unsub [ankit.sinha@intel.com]
>> -=-=-=-=-=-=
>>
>
>
>
>
>
^ permalink raw reply [flat|nested] 36+ messages in thread
* [PATCH v3 02/14] StandaloneMmPkg: Fix new typos reported
2022-12-14 22:52 [PATCH v3 00/14] Fix new typos reported Michael Kubacki
2022-12-14 22:52 ` [PATCH v3 01/14] PrmPkg: " Michael Kubacki
@ 2022-12-14 22:52 ` Michael Kubacki
2022-12-14 22:52 ` [PATCH v3 03/14] DynamicTablesPkg: " Michael Kubacki
` (12 subsequent siblings)
14 siblings, 0 replies; 36+ messages in thread
From: Michael Kubacki @ 2022-12-14 22:52 UTC (permalink / raw)
To: devel; +Cc: Ard Biesheuvel, Sami Mujawar, Jiewen Yao, Supreeth Venkatesh
From: Michael Kubacki <michael.kubacki@microsoft.com>
The SpellCheck plugin began reporting new typos that were previously
missed. This change fixes those typos.
Cc: Ard Biesheuvel <ardb+tianocore@kernel.org>
Cc: Sami Mujawar <sami.mujawar@arm.com>
Cc: Jiewen Yao <jiewen.yao@intel.com>
Cc: Supreeth Venkatesh <supreeth.venkatesh@arm.com>
Signed-off-by: Michael Kubacki <michael.kubacki@microsoft.com>
Reviewed-by: Sami Mujawar <sami.mujawar@arm.com>
---
StandaloneMmPkg/Core/Dependency.c | 2 +-
StandaloneMmPkg/Core/Dispatcher.c | 18 +++++++++---------
StandaloneMmPkg/Core/Handle.c | 2 +-
StandaloneMmPkg/Core/StandaloneMmCore.h | 2 +-
StandaloneMmPkg/Include/Guid/MmCoreData.h | 2 +-
StandaloneMmPkg/StandaloneMmPkg.ci.yaml | 8 ++++++++
6 files changed, 21 insertions(+), 13 deletions(-)
diff --git a/StandaloneMmPkg/Core/Dependency.c b/StandaloneMmPkg/Core/Dependency.c
index 440fe3e45238..0e9c0e96a276 100644
--- a/StandaloneMmPkg/Core/Dependency.c
+++ b/StandaloneMmPkg/Core/Dependency.c
@@ -38,7 +38,7 @@ BOOLEAN *mDepexEvaluationStackPointer = NULL;
/**
Grow size of the Depex stack
- @retval EFI_SUCCESS Stack successfully growed.
+ @retval EFI_SUCCESS Stack successfully grew.
@retval EFI_OUT_OF_RESOURCES There is not enough system memory to grow the stack.
**/
diff --git a/StandaloneMmPkg/Core/Dispatcher.c b/StandaloneMmPkg/Core/Dispatcher.c
index b1ccba15b060..01da395be3c4 100644
--- a/StandaloneMmPkg/Core/Dispatcher.c
+++ b/StandaloneMmPkg/Core/Dispatcher.c
@@ -17,7 +17,7 @@
and After dependencies. This is done recursively as the call to add
to the mScheduledQueue checks for Before Depexes and recursively
adds all Before Depexes. It then adds the item that was passed in
- and then processess the After dependencies by recursively calling
+ and then processes the After dependencies by recursively calling
the routine.
Dispatcher Rules:
@@ -93,29 +93,29 @@ LIST_ENTRY mScheduledQueue = INITIALIZE_LIST_HEAD_VARIABLE (mScheduledQueue);
LIST_ENTRY mFwVolList = INITIALIZE_LIST_HEAD_VARIABLE (mFwVolList);
//
-// Flag for the MM Dispacher. TRUE if dispatcher is executing.
+// Flag for the MM Dispatcher. TRUE if dispatcher is executing.
//
BOOLEAN gDispatcherRunning = FALSE;
//
-// Flag for the MM Dispacher. TRUE if there is one or more MM drivers ready to be dispatched
+// Flag for the MM Dispatcher. TRUE if there is one or more MM drivers ready to be dispatched
//
BOOLEAN gRequestDispatch = FALSE;
//
// The global variable is defined for Loading modules at fixed address feature to track the MM code
-// memory range usage. It is a bit mapped array in which every bit indicates the correspoding
+// memory range usage. It is a bit mapped array in which every bit indicates the corresponding
// memory page available or not.
//
GLOBAL_REMOVE_IF_UNREFERENCED UINT64 *mMmCodeMemoryRangeUsageBitMap = NULL;
/**
To check memory usage bit map array to figure out if the memory range in which the image will be loaded
- is available or not. If memory range is avaliable, the function will mark the corresponding bits to 1
+ is available or not. If memory range is available, the function will mark the corresponding bits to 1
which indicates the memory range is used. The function is only invoked when load modules at fixed address
feature is enabled.
- @param ImageBase The base addres the image will be loaded at.
+ @param ImageBase The base address the image will be loaded at.
@param ImageSize The size of the image
@retval EFI_SUCCESS The memory range the image will be loaded in is available
@@ -194,7 +194,7 @@ CheckAndMarkFixLoadingMemoryUsageBitMap (
@param ImageContext Pointer to the image context structure that describes the PE/COFF
image that needs to be examined by this function.
@retval EFI_SUCCESS An fixed loading address is assigned to this image by build tools .
- @retval EFI_NOT_FOUND The image has no assigned fixed loadding address.
+ @retval EFI_NOT_FOUND The image has no assigned fixed loading address.
**/
EFI_STATUS
@@ -513,7 +513,7 @@ MmPreProcessDepex (
@param DriverEntry Driver to work on.
- @retval EFI_SUCCESS Depex read and preprossesed
+ @retval EFI_SUCCESS Depex read and pre-processed
@retval EFI_PROTOCOL_ERROR The section extraction protocol returned an error
and Depex reading needs to be retried.
@retval Error DEPEX not found.
@@ -851,7 +851,7 @@ FvIsBeingProcessed (
The Discovered list is never freed and contains booleans that represent the
other possible MM driver states.
- @param [in] FwVolHeader Pointer to the formware volume header.
+ @param [in] FwVolHeader Pointer to the firmware volume header.
@param [in] Pe32Data Pointer to the PE data.
@param [in] Pe32DataSize Size of the PE data.
@param [in] Depex Pointer to the Depex info.
diff --git a/StandaloneMmPkg/Core/Handle.c b/StandaloneMmPkg/Core/Handle.c
index 7df4629cf291..bd0005fcb84d 100644
--- a/StandaloneMmPkg/Core/Handle.c
+++ b/StandaloneMmPkg/Core/Handle.c
@@ -347,7 +347,7 @@ MmInstallProtocolInterfaceNotify (
}
/**
- Uninstalls all instances of a protocol:interfacer from a handle.
+ Uninstalls all instances of a protocol interface from a handle.
If the last protocol interface is remove from the handle, the
handle is freed.
diff --git a/StandaloneMmPkg/Core/StandaloneMmCore.h b/StandaloneMmPkg/Core/StandaloneMmCore.h
index 822d95358c39..b5e2e4b9083b 100644
--- a/StandaloneMmPkg/Core/StandaloneMmCore.h
+++ b/StandaloneMmPkg/Core/StandaloneMmCore.h
@@ -426,7 +426,7 @@ MmInstallProtocolInterfaceNotify (
);
/**
- Uninstalls all instances of a protocol:interfacer from a handle.
+ Uninstalls all instances of a protocol interface from a handle.
If the last protocol interface is remove from the handle, the
handle is freed.
diff --git a/StandaloneMmPkg/Include/Guid/MmCoreData.h b/StandaloneMmPkg/Include/Guid/MmCoreData.h
index b8be92c6abfd..0f58f41d8060 100644
--- a/StandaloneMmPkg/Include/Guid/MmCoreData.h
+++ b/StandaloneMmPkg/Include/Guid/MmCoreData.h
@@ -70,7 +70,7 @@ typedef struct {
///
/// The MM Foundation Entry Point. The MM Core fills in this field when the
- /// MM Core is initialized. The MM IPL is responsbile for registering this entry
+ /// MM Core is initialized. The MM IPL is responsible for registering this entry
/// point with the MM Configuration Protocol. The MM Configuration Protocol may
/// not be available at the time the MM IPL and MM Core are started, so the MM IPL
/// sets up a protocol notification on the MM Configuration Protocol and registers
diff --git a/StandaloneMmPkg/StandaloneMmPkg.ci.yaml b/StandaloneMmPkg/StandaloneMmPkg.ci.yaml
index 4777532a7ede..c91e79f4b865 100644
--- a/StandaloneMmPkg/StandaloneMmPkg.ci.yaml
+++ b/StandaloneMmPkg/StandaloneMmPkg.ci.yaml
@@ -81,12 +81,20 @@
"IgnoreFiles": [], # use gitignore syntax to ignore errors
# in matching files
"ExtendWords": [
+ "bootinformation",
"Bsymbolic",
+ "bugbug",
+ "combineable",
+ "depexes",
"FwVol",
+ "hoblist",
+ "imagehandle",
"mpidr",
"mstrict",
"schedulable",
"StandaloneMMCore",
+ "systemtable",
+ "uncacheable"
], # words to extend to the dictionary for this package
"IgnoreStandardPaths": [], # Standard Plugin defined paths that
# should be ignore
--
2.28.0.windows.1
^ permalink raw reply related [flat|nested] 36+ messages in thread* [PATCH v3 03/14] DynamicTablesPkg: Fix new typos reported
2022-12-14 22:52 [PATCH v3 00/14] Fix new typos reported Michael Kubacki
2022-12-14 22:52 ` [PATCH v3 01/14] PrmPkg: " Michael Kubacki
2022-12-14 22:52 ` [PATCH v3 02/14] StandaloneMmPkg: " Michael Kubacki
@ 2022-12-14 22:52 ` Michael Kubacki
2022-12-14 22:52 ` [PATCH v3 04/14] UnitTestFrameworkPkg: " Michael Kubacki
` (11 subsequent siblings)
14 siblings, 0 replies; 36+ messages in thread
From: Michael Kubacki @ 2022-12-14 22:52 UTC (permalink / raw)
To: devel; +Cc: Sami Mujawar, Alexei Fedorov, Pierre Gondois, Sami Mujawar
From: Michael Kubacki <michael.kubacki@microsoft.com>
The SpellCheck plugin began reporting new typos that were previously
missed. This change fixes those typos.
Cc: Sami Mujawar <Sami.Mujawar@arm.com>
Cc: Alexei Fedorov <Alexei.Fedorov@arm.com>
Cc: Pierre Gondois <pierre.gondois@arm.com>
Signed-off-by: Michael Kubacki <michael.kubacki@microsoft.com>
Reviewed-by: Sami Mujawar <sami.mujawar@arm.com>
---
DynamicTablesPkg/Library/Acpi/Arm/AcpiPpttLibArm/PpttGenerator.c | 2 +-
DynamicTablesPkg/Library/Acpi/Arm/AcpiSsdtCmn600LibArm/SsdtCmn600Generator.c | 2 +-
DynamicTablesPkg/Library/Common/AmlLib/Parser/AmlMethodParser.c | 2 +-
DynamicTablesPkg/Library/Common/AmlLib/Parser/AmlParser.c | 2 +-
DynamicTablesPkg/Library/Common/AmlLib/Tree/AmlNode.c | 2 +-
DynamicTablesPkg/Library/Common/DynamicPlatRepoLib/DynamicPlatRepo.c | 4 +--
DynamicTablesPkg/Library/FdtHwInfoParserLib/Gic/ArmGicDispatcher.c | 2 +-
DynamicTablesPkg/Library/FdtHwInfoParserLib/Serial/ArmSerialPortParser.c | 2 +-
DynamicTablesPkg/DynamicTablesPkg.ci.yaml | 31 +++++++++++++++-----
DynamicTablesPkg/Include/Library/DynamicPlatRepoLib.h | 4 +--
DynamicTablesPkg/Library/Common/AmlLib/Parser/AmlMethodParser.h | 2 +-
DynamicTablesPkg/Library/FdtHwInfoParserLib/Gic/ArmGicDispatcher.h | 2 +-
DynamicTablesPkg/Library/FdtHwInfoParserLib/Serial/ArmSerialPortParser.h | 2 +-
DynamicTablesPkg/Readme.md | 4 +--
14 files changed, 40 insertions(+), 23 deletions(-)
diff --git a/DynamicTablesPkg/Library/Acpi/Arm/AcpiPpttLibArm/PpttGenerator.c b/DynamicTablesPkg/Library/Acpi/Arm/AcpiPpttLibArm/PpttGenerator.c
index 78fa63ff47e5..4dde84d9f6b7 100644
--- a/DynamicTablesPkg/Library/Acpi/Arm/AcpiPpttLibArm/PpttGenerator.c
+++ b/DynamicTablesPkg/Library/Acpi/Arm/AcpiPpttLibArm/PpttGenerator.c
@@ -352,7 +352,7 @@ AddPrivateResources (
return Status;
}
- // The Node indexer has the Processor hierarchy nodes at the begining
+ // The Node indexer has the Processor hierarchy nodes at the beginning
// followed by the cache structs. Therefore we can skip the Processor
// hierarchy nodes in the node indexer search.
Status = GetPpttNodeReferencedByToken (
diff --git a/DynamicTablesPkg/Library/Acpi/Arm/AcpiSsdtCmn600LibArm/SsdtCmn600Generator.c b/DynamicTablesPkg/Library/Acpi/Arm/AcpiSsdtCmn600LibArm/SsdtCmn600Generator.c
index b990686d40a3..321a08d41837 100644
--- a/DynamicTablesPkg/Library/Acpi/Arm/AcpiSsdtCmn600LibArm/SsdtCmn600Generator.c
+++ b/DynamicTablesPkg/Library/Acpi/Arm/AcpiSsdtCmn600LibArm/SsdtCmn600Generator.c
@@ -377,7 +377,7 @@ FixupCmn600Info (
goto error_handler;
}
- // Serialise the definition block
+ // Serialize the definition block
Status = AmlSerializeDefinitionBlock (
RootNodeHandle,
Table
diff --git a/DynamicTablesPkg/Library/Common/AmlLib/Parser/AmlMethodParser.c b/DynamicTablesPkg/Library/Common/AmlLib/Parser/AmlMethodParser.c
index 8c77716dab80..60694819fb4c 100644
--- a/DynamicTablesPkg/Library/Common/AmlLib/Parser/AmlMethodParser.c
+++ b/DynamicTablesPkg/Library/Common/AmlLib/Parser/AmlMethodParser.c
@@ -1284,7 +1284,7 @@ AmlAddNameSpaceReference (
When computing the size of a tree or serializing it, the additional data is
not taken into account (i.e. the MethodInvocationOp and the ArgumentCount).
- Method invocation nodes have the AML_METHOD_INVOVATION attribute.
+ Method invocation nodes have the AML_METHOD_INVOCATION attribute.
@param [in] NameSpaceRefNode NameSpaceRef node pointing to the
the definition of the invoked
diff --git a/DynamicTablesPkg/Library/Common/AmlLib/Parser/AmlParser.c b/DynamicTablesPkg/Library/Common/AmlLib/Parser/AmlParser.c
index 8e584d49307a..6f80725bf13d 100644
--- a/DynamicTablesPkg/Library/Common/AmlLib/Parser/AmlParser.c
+++ b/DynamicTablesPkg/Library/Common/AmlLib/Parser/AmlParser.c
@@ -331,7 +331,7 @@ AmlParseString (
StrSize = 0;
// AML String is NULL terminated.
do {
- // Reading the stream moves the stream forward aswell.
+ // Reading the stream moves the stream forward as well.
Status = AmlStreamReadByte (FStream, &Byte);
if (EFI_ERROR (Status)) {
ASSERT (0);
diff --git a/DynamicTablesPkg/Library/Common/AmlLib/Tree/AmlNode.c b/DynamicTablesPkg/Library/Common/AmlLib/Tree/AmlNode.c
index 1404a2182b65..0a744f1ff3fa 100644
--- a/DynamicTablesPkg/Library/Common/AmlLib/Tree/AmlNode.c
+++ b/DynamicTablesPkg/Library/Common/AmlLib/Tree/AmlNode.c
@@ -573,7 +573,7 @@ AmlIsMethodDefinitionNode (
{
AML_DATA_NODE *ObjectType;
- // Node is checked to be an object node aswell.
+ // Node is checked to be an object node as well.
if (AmlNodeCompareOpCode (Node, AML_METHOD_OP, 0)) {
return TRUE;
} else if (AmlNodeCompareOpCode (Node, AML_EXTERNAL_OP, 0)) {
diff --git a/DynamicTablesPkg/Library/Common/DynamicPlatRepoLib/DynamicPlatRepo.c b/DynamicTablesPkg/Library/Common/DynamicPlatRepoLib/DynamicPlatRepo.c
index bc713f30b2fe..1244bbda702d 100644
--- a/DynamicTablesPkg/Library/Common/DynamicPlatRepoLib/DynamicPlatRepo.c
+++ b/DynamicTablesPkg/Library/Common/DynamicPlatRepoLib/DynamicPlatRepo.c
@@ -294,9 +294,9 @@ GroupCmObjNodes (
return Status;
}
-/** Finalise the dynamic repository.
+/** Finalize the dynamic repository.
- Finalising means:
+ Finalizing means:
- Preventing any further objects from being added.
- Allowing to get objects from the dynamic repository
(not possible before a call to this function).
diff --git a/DynamicTablesPkg/Library/FdtHwInfoParserLib/Gic/ArmGicDispatcher.c b/DynamicTablesPkg/Library/FdtHwInfoParserLib/Gic/ArmGicDispatcher.c
index 1f3af1f968a9..2442003651ff 100644
--- a/DynamicTablesPkg/Library/FdtHwInfoParserLib/Gic/ArmGicDispatcher.c
+++ b/DynamicTablesPkg/Library/FdtHwInfoParserLib/Gic/ArmGicDispatcher.c
@@ -88,7 +88,7 @@ GetGicVersion (
/** Gic dispatcher.
- This disptacher populates the following structures:
+ This dispatcher populates the following structures:
- CM_ARM_GICC_INFO
- CM_ARM_GICD_INFO
- CM_ARM_GIC_MSI_FRAME_INFO
diff --git a/DynamicTablesPkg/Library/FdtHwInfoParserLib/Serial/ArmSerialPortParser.c b/DynamicTablesPkg/Library/FdtHwInfoParserLib/Serial/ArmSerialPortParser.c
index cfd032df4d74..e89344291800 100644
--- a/DynamicTablesPkg/Library/FdtHwInfoParserLib/Serial/ArmSerialPortParser.c
+++ b/DynamicTablesPkg/Library/FdtHwInfoParserLib/Serial/ArmSerialPortParser.c
@@ -447,7 +447,7 @@ ArmSerialPortInfoParser (
/** SerialPort dispatcher.
- This disptacher populates the CM_ARM_SERIAL_PORT_INFO structure for
+ This dispatcher populates the CM_ARM_SERIAL_PORT_INFO structure for
the following CM_OBJ_ID:
- EArmObjSerialConsolePortInfo
- EArmObjSerialDebugPortInfo
diff --git a/DynamicTablesPkg/DynamicTablesPkg.ci.yaml b/DynamicTablesPkg/DynamicTablesPkg.ci.yaml
index 5addf8626841..78f038ce088f 100644
--- a/DynamicTablesPkg/DynamicTablesPkg.ci.yaml
+++ b/DynamicTablesPkg/DynamicTablesPkg.ci.yaml
@@ -92,36 +92,53 @@
"IgnoreFiles": [], # use gitignore syntax to ignore errors
# in matching files
"ExtendWords": [
+ "aaaabbbbcccc",
+ "AMLDBG",
"ARMHB", # ARMHB000
"ARMHC", # ARMHC600
"ARMLTD",
- "AMLDBG",
- "EISAID",
+ "bytecodes",
+ "bytelist",
+ "bytestream",
"CCIDX",
"CCSIDR",
"countof",
+ "deregistering",
+ "devicetree",
"edynamic",
+ "EISAID",
"EOBJECT",
+ "etable",
+ "finalise",
+ "GTBLOCK",
"invoc",
"ITARGETSR",
- "GTBLOCK",
"lgreater",
"lless",
+ "mainpage",
+ "mismanipulation",
"MPIDR",
+ "nameseg",
+ "namespaceid",
+ "namespacestring",
+ "namestr",
"PASID",
"PERIPHBASE",
"phandle",
+ "pkglen",
+ "prefetchable",
"pytool",
"Rdword",
+ "redist",
"Roadmap",
"ROOTNODEBASE",
- "ssdtcmn",
- "ssdtserialporttemplate",
"SMMUV",
- "ssdtpcieosctemplate",
+ "ssdtcmn",
"SSDTPC",
- "standardised",
+ "ssdtpcieosctemplate",
+ "ssdtserialporttemplate",
"TABLEEX",
+ "tagsize",
"TNSID",
"Vatos",
"WBINVD"
diff --git a/DynamicTablesPkg/Include/Library/DynamicPlatRepoLib.h b/DynamicTablesPkg/Include/Library/DynamicPlatRepoLib.h
index bb18215b08bc..c3cd6b5728ff 100644
--- a/DynamicTablesPkg/Include/Library/DynamicPlatRepoLib.h
+++ b/DynamicTablesPkg/Include/Library/DynamicPlatRepoLib.h
@@ -38,9 +38,9 @@ DynPlatRepoAddObject (
OUT CM_OBJECT_TOKEN *Token OPTIONAL
);
-/** Finalise the dynamic repository.
+/** Finalize the dynamic repository.
- Finalising means:
+ Finalizing means:
- Preventing any further objects from being added.
- Allowing to get objects from the dynamic repository
(not possible before a call to this function).
diff --git a/DynamicTablesPkg/Library/Common/AmlLib/Parser/AmlMethodParser.h b/DynamicTablesPkg/Library/Common/AmlLib/Parser/AmlMethodParser.h
index ac3284d0311e..6e4837956f74 100644
--- a/DynamicTablesPkg/Library/Common/AmlLib/Parser/AmlMethodParser.h
+++ b/DynamicTablesPkg/Library/Common/AmlLib/Parser/AmlMethodParser.h
@@ -138,7 +138,7 @@ AmlAddNameSpaceReference (
When computing the size of a tree or serializing it, the additional data is
not taken into account (i.e. the MethodInvocationOp and the ArgumentCount).
- Method invocation nodes have the AML_METHOD_INVOVATION attribute.
+ Method invocation nodes have the AML_METHOD_INVOCATION attribute.
@param [in] NameSpaceRefNode NameSpaceRef node pointing to the
the definition of the invoked
diff --git a/DynamicTablesPkg/Library/FdtHwInfoParserLib/Gic/ArmGicDispatcher.h b/DynamicTablesPkg/Library/FdtHwInfoParserLib/Gic/ArmGicDispatcher.h
index aa942f7d1f49..65c5968baa57 100644
--- a/DynamicTablesPkg/Library/FdtHwInfoParserLib/Gic/ArmGicDispatcher.h
+++ b/DynamicTablesPkg/Library/FdtHwInfoParserLib/Gic/ArmGicDispatcher.h
@@ -40,7 +40,7 @@ GetGicVersion (
/** Gic dispatcher.
- This disptacher populates the following structures:
+ This dispatcher populates the following structures:
- CM_ARM_GICC_INFO
- CM_ARM_GICD_INFO
- CM_ARM_GIC_MSI_FRAME_INFO
diff --git a/DynamicTablesPkg/Library/FdtHwInfoParserLib/Serial/ArmSerialPortParser.h b/DynamicTablesPkg/Library/FdtHwInfoParserLib/Serial/ArmSerialPortParser.h
index de08e57e6c57..cec93d389240 100644
--- a/DynamicTablesPkg/Library/FdtHwInfoParserLib/Serial/ArmSerialPortParser.h
+++ b/DynamicTablesPkg/Library/FdtHwInfoParserLib/Serial/ArmSerialPortParser.h
@@ -14,7 +14,7 @@
/** SerialPort dispatcher.
- This disptacher populates the CM_ARM_SERIAL_PORT_INFO structure for
+ This dispatcher populates the CM_ARM_SERIAL_PORT_INFO structure for
the following CM_OBJ_ID:
- EArmObjSerialConsolePortInfo
- EArmObjSerialDebugPortInfo
diff --git a/DynamicTablesPkg/Readme.md b/DynamicTablesPkg/Readme.md
index 6b0a6c7a4001..4aaacf1bf40a 100644
--- a/DynamicTablesPkg/Readme.md
+++ b/DynamicTablesPkg/Readme.md
@@ -11,9 +11,9 @@ UEFI modules.
# Feature Summary
-The dynamic tables framework is designed to generate standardised
+The dynamic tables framework is designed to generate standardized
firmware tables that describe the hardware information at
-run-time. A goal of standardised firmware is to have a common
+run-time. A goal of standardized firmware is to have a common
firmware for a platform capable of booting both Windows and Linux
operating systems.
--
2.28.0.windows.1
^ permalink raw reply related [flat|nested] 36+ messages in thread* [PATCH v3 04/14] UnitTestFrameworkPkg: Fix new typos reported
2022-12-14 22:52 [PATCH v3 00/14] Fix new typos reported Michael Kubacki
` (2 preceding siblings ...)
2022-12-14 22:52 ` [PATCH v3 03/14] DynamicTablesPkg: " Michael Kubacki
@ 2022-12-14 22:52 ` Michael Kubacki
2022-12-14 23:05 ` Michael D Kinney
2022-12-14 22:52 ` [PATCH v3 05/14] FatPkg: " Michael Kubacki
` (10 subsequent siblings)
14 siblings, 1 reply; 36+ messages in thread
From: Michael Kubacki @ 2022-12-14 22:52 UTC (permalink / raw)
To: devel; +Cc: Michael D Kinney, Sean Brogan
From: Michael Kubacki <michael.kubacki@microsoft.com>
The SpellCheck plugin began reporting new typos that were previously
missed. This change fixes those typos.
Cc: Michael D Kinney <michael.d.kinney@intel.com>
Cc: Sean Brogan <sean.brogan@microsoft.com>
Signed-off-by: Michael Kubacki <michael.kubacki@microsoft.com>
---
UnitTestFrameworkPkg/Library/Posix/MemoryAllocationLibPosix/MemoryAllocationLibPosix.c | 18 ++++++------
UnitTestFrameworkPkg/Library/UnitTestBootLibNull/UnitTestBootLibNull.c | 2 +-
UnitTestFrameworkPkg/Library/UnitTestBootLibUsbClass/UnitTestBootLibUsbClass.c | 2 +-
UnitTestFrameworkPkg/Library/UnitTestLib/Log.c | 2 +-
UnitTestFrameworkPkg/Library/UnitTestLib/UnitTestLib.c | 2 +-
UnitTestFrameworkPkg/Test/UnitTest/Sample/SampleUnitTest/SampleUnitTest.c | 2 +-
UnitTestFrameworkPkg/PrivateInclude/Library/UnitTestBootLib.h | 2 +-
UnitTestFrameworkPkg/PrivateInclude/UnitTestFrameworkTypes.h | 2 +-
UnitTestFrameworkPkg/UnitTestFrameworkPkg.ci.yaml | 31 +++++++++++++-------
9 files changed, 37 insertions(+), 26 deletions(-)
diff --git a/UnitTestFrameworkPkg/Library/Posix/MemoryAllocationLibPosix/MemoryAllocationLibPosix.c b/UnitTestFrameworkPkg/Library/Posix/MemoryAllocationLibPosix/MemoryAllocationLibPosix.c
index 54029283fbbf..f85a05ec06ee 100644
--- a/UnitTestFrameworkPkg/Library/Posix/MemoryAllocationLibPosix/MemoryAllocationLibPosix.c
+++ b/UnitTestFrameworkPkg/Library/Posix/MemoryAllocationLibPosix/MemoryAllocationLibPosix.c
@@ -27,7 +27,7 @@
///
typedef struct {
UINT32 Signature;
- VOID *AllocatedBufffer;
+ VOID *AllocatedBuffer;
UINTN TotalPages;
VOID *AlignedBuffer;
UINTN AlignedPages;
@@ -165,16 +165,16 @@ AllocateAlignedPages (
//
// We need reserve Alignment pages for PAGE_HEAD, as meta data.
//
- PageHead.Signature = PAGE_HEAD_PRIVATE_SIGNATURE;
- PageHead.TotalPages = Pages + EFI_SIZE_TO_PAGES (Alignment) * 2;
- PageHead.AlignedPages = Pages;
- PageHead.AllocatedBufffer = malloc (EFI_PAGES_TO_SIZE (PageHead.TotalPages));
- if (PageHead.AllocatedBufffer == NULL) {
+ PageHead.Signature = PAGE_HEAD_PRIVATE_SIGNATURE;
+ PageHead.TotalPages = Pages + EFI_SIZE_TO_PAGES (Alignment) * 2;
+ PageHead.AlignedPages = Pages;
+ PageHead.AllocatedBuffer = malloc (EFI_PAGES_TO_SIZE (PageHead.TotalPages));
+ if (PageHead.AllocatedBuffer == NULL) {
return NULL;
}
- PageHead.AlignedBuffer = (VOID *)(((UINTN)PageHead.AllocatedBufffer + AlignmentMask) & ~AlignmentMask);
- if ((UINTN)PageHead.AlignedBuffer - (UINTN)PageHead.AllocatedBufffer < sizeof (PAGE_HEAD)) {
+ PageHead.AlignedBuffer = (VOID *)(((UINTN)PageHead.AllocatedBuffer + AlignmentMask) & ~AlignmentMask);
+ if ((UINTN)PageHead.AlignedBuffer - (UINTN)PageHead.AllocatedBuffer < sizeof (PAGE_HEAD)) {
PageHead.AlignedBuffer = (VOID *)((UINTN)PageHead.AlignedBuffer + Alignment);
}
@@ -279,7 +279,7 @@ FreeAlignedPages (
}
PageHeadPtr->Signature = 0;
- free (PageHeadPtr->AllocatedBufffer);
+ free (PageHeadPtr->AllocatedBuffer);
}
/**
diff --git a/UnitTestFrameworkPkg/Library/UnitTestBootLibNull/UnitTestBootLibNull.c b/UnitTestFrameworkPkg/Library/UnitTestBootLibNull/UnitTestBootLibNull.c
index a49aaefdb71f..7ff80850ff57 100644
--- a/UnitTestFrameworkPkg/Library/UnitTestBootLibNull/UnitTestBootLibNull.c
+++ b/UnitTestFrameworkPkg/Library/UnitTestBootLibNull/UnitTestBootLibNull.c
@@ -13,7 +13,7 @@
@retval EFI_SUCCESS Boot device for next boot was set.
@retval EFI_UNSUPPORTED Setting the boot device for the next boot is not
- supportted.
+ supported.
@retval Other Boot device for next boot can not be set.
**/
EFI_STATUS
diff --git a/UnitTestFrameworkPkg/Library/UnitTestBootLibUsbClass/UnitTestBootLibUsbClass.c b/UnitTestFrameworkPkg/Library/UnitTestBootLibUsbClass/UnitTestBootLibUsbClass.c
index ebb42186a534..8b03e7cd15fc 100644
--- a/UnitTestFrameworkPkg/Library/UnitTestBootLibUsbClass/UnitTestBootLibUsbClass.c
+++ b/UnitTestFrameworkPkg/Library/UnitTestBootLibUsbClass/UnitTestBootLibUsbClass.c
@@ -20,7 +20,7 @@
@retval EFI_SUCCESS Boot device for next boot was set.
@retval EFI_UNSUPPORTED Setting the boot device for the next boot is not
- supportted.
+ supported.
@retval Other Boot device for next boot can not be set.
**/
EFI_STATUS
diff --git a/UnitTestFrameworkPkg/Library/UnitTestLib/Log.c b/UnitTestFrameworkPkg/Library/UnitTestLib/Log.c
index 3998aafdf843..35544ff0659a 100644
--- a/UnitTestFrameworkPkg/Library/UnitTestLib/Log.c
+++ b/UnitTestFrameworkPkg/Library/UnitTestLib/Log.c
@@ -1,5 +1,5 @@
/**
- Implemnet UnitTestLib log services
+ Implement UnitTestLib log services
Copyright (c) Microsoft Corporation.<BR>
SPDX-License-Identifier: BSD-2-Clause-Patent
diff --git a/UnitTestFrameworkPkg/Library/UnitTestLib/UnitTestLib.c b/UnitTestFrameworkPkg/Library/UnitTestLib/UnitTestLib.c
index 5b442ed122ea..8c2ffa43d580 100644
--- a/UnitTestFrameworkPkg/Library/UnitTestLib/UnitTestLib.c
+++ b/UnitTestFrameworkPkg/Library/UnitTestLib/UnitTestLib.c
@@ -217,7 +217,7 @@ InitUnitTestFramework (
NewFramework = NULL;
//
- // First, check all pointers and make sure nothing's broked.
+ // First, check all pointers and make sure nothing is broken.
//
if ((FrameworkHandle == NULL) || (Title == NULL) ||
(ShortTitle == NULL) || (VersionString == NULL))
diff --git a/UnitTestFrameworkPkg/Test/UnitTest/Sample/SampleUnitTest/SampleUnitTest.c b/UnitTestFrameworkPkg/Test/UnitTest/Sample/SampleUnitTest/SampleUnitTest.c
index c02a2dba987d..dd010a75a5a6 100644
--- a/UnitTestFrameworkPkg/Test/UnitTest/Sample/SampleUnitTest/SampleUnitTest.c
+++ b/UnitTestFrameworkPkg/Test/UnitTest/Sample/SampleUnitTest/SampleUnitTest.c
@@ -1,5 +1,5 @@
/** @file
- This is a sample to demostrate the usage of the Unit Test Library that
+ This is a sample to demonstrate the usage of the Unit Test Library that
supports the PEI, DXE, SMM, UEFI SHell, and host execution environments.
Copyright (c) Microsoft Corporation.<BR>
diff --git a/UnitTestFrameworkPkg/PrivateInclude/Library/UnitTestBootLib.h b/UnitTestFrameworkPkg/PrivateInclude/Library/UnitTestBootLib.h
index d90bff0e4c1b..de4b9566837b 100644
--- a/UnitTestFrameworkPkg/PrivateInclude/Library/UnitTestBootLib.h
+++ b/UnitTestFrameworkPkg/PrivateInclude/Library/UnitTestBootLib.h
@@ -19,7 +19,7 @@
@retval EFI_SUCCESS Boot device for next boot was set.
@retval EFI_UNSUPPORTED Setting the boot device for the next boot is not
- supportted.
+ supported.
@retval Other Boot device for next boot can not be set.
**/
EFI_STATUS
diff --git a/UnitTestFrameworkPkg/PrivateInclude/UnitTestFrameworkTypes.h b/UnitTestFrameworkPkg/PrivateInclude/UnitTestFrameworkTypes.h
index adce413818a2..0c0e82de4003 100644
--- a/UnitTestFrameworkPkg/PrivateInclude/UnitTestFrameworkTypes.h
+++ b/UnitTestFrameworkPkg/PrivateInclude/UnitTestFrameworkTypes.h
@@ -18,7 +18,7 @@
#define UNIT_TEST_MAX_STRING_LENGTH (120)
///
-/// The size of a firngerprint used to save/resume execution of a unit test
+/// The size of a fingerprint used to save/resume execution of a unit test
/// framework. This is the size of a CRC32 value which is 32-bit value.
///
///
diff --git a/UnitTestFrameworkPkg/UnitTestFrameworkPkg.ci.yaml b/UnitTestFrameworkPkg/UnitTestFrameworkPkg.ci.yaml
index 072df6208c92..ce86e53ef59d 100644
--- a/UnitTestFrameworkPkg/UnitTestFrameworkPkg.ci.yaml
+++ b/UnitTestFrameworkPkg/UnitTestFrameworkPkg.ci.yaml
@@ -82,20 +82,31 @@
"Library/GoogleTestLib/googletest/**/*.*" # not going to spell check a submodule
],
"ExtendWords": [ # words to extend to the dictionary for this package
- "testcase",
- "testsuites",
- "cmocka",
+ "assertnotefierror",
+ "assertnotnull",
+ "assertstatusequal",
"buildmodule",
+ "cmocka",
+ "cmockery",
+ "corthon", # Contact GitHub account in Readme
"criterium",
+ "deadloop",
+ "devpath",
+ "DHAVE", # build flag for cmocka in the INF
+ "expectassert",
+ "failuretype",
+ "gtest", # file name in GoogleTestLib.inf
+ "mdkinney", # Contact GitHub account in Readme
+ "NOFAILURE",
+ "notefierror",
+ "notequal",
"pytool",
"pytools",
- "NOFAILURE",
- "cmockery",
- "DHAVE", # build flag for cmocka in the INF
- "gtest", # file name in GoogleTestLib.inf
- "corthon", # Contact GitHub account in Readme
- "mdkinney", # Contact GitHub account in Readme
- "spbrogan" # Contact GitHub account in Readme
+ "spbrogan", # Contact GitHub account in Readme
+ "statusequal",
+ "testcase",
+ "testfailuremsg",
+ "testsuites"
],
"IgnoreStandardPaths": [], # Standard Plugin defined paths that should be ignore
"AdditionalIncludePaths": [] # Additional paths to spell check (wildcards supported)
--
2.28.0.windows.1
^ permalink raw reply related [flat|nested] 36+ messages in thread* Re: [PATCH v3 04/14] UnitTestFrameworkPkg: Fix new typos reported
2022-12-14 22:52 ` [PATCH v3 04/14] UnitTestFrameworkPkg: " Michael Kubacki
@ 2022-12-14 23:05 ` Michael D Kinney
0 siblings, 0 replies; 36+ messages in thread
From: Michael D Kinney @ 2022-12-14 23:05 UTC (permalink / raw)
To: mikuback@linux.microsoft.com, devel@edk2.groups.io,
Kinney, Michael D
Cc: Sean Brogan
Reviewed-by: Michael D Kinney <michael.d.kinney@intel.com>
> -----Original Message-----
> From: mikuback@linux.microsoft.com <mikuback@linux.microsoft.com>
> Sent: Wednesday, December 14, 2022 2:53 PM
> To: devel@edk2.groups.io
> Cc: Kinney, Michael D <michael.d.kinney@intel.com>; Sean Brogan <sean.brogan@microsoft.com>
> Subject: [PATCH v3 04/14] UnitTestFrameworkPkg: Fix new typos reported
>
> From: Michael Kubacki <michael.kubacki@microsoft.com>
>
> The SpellCheck plugin began reporting new typos that were previously
> missed. This change fixes those typos.
>
> Cc: Michael D Kinney <michael.d.kinney@intel.com>
> Cc: Sean Brogan <sean.brogan@microsoft.com>
> Signed-off-by: Michael Kubacki <michael.kubacki@microsoft.com>
> ---
> UnitTestFrameworkPkg/Library/Posix/MemoryAllocationLibPosix/MemoryAllocationLibPosix.c | 18 ++++++------
> UnitTestFrameworkPkg/Library/UnitTestBootLibNull/UnitTestBootLibNull.c | 2 +-
> UnitTestFrameworkPkg/Library/UnitTestBootLibUsbClass/UnitTestBootLibUsbClass.c | 2 +-
> UnitTestFrameworkPkg/Library/UnitTestLib/Log.c | 2 +-
> UnitTestFrameworkPkg/Library/UnitTestLib/UnitTestLib.c | 2 +-
> UnitTestFrameworkPkg/Test/UnitTest/Sample/SampleUnitTest/SampleUnitTest.c | 2 +-
> UnitTestFrameworkPkg/PrivateInclude/Library/UnitTestBootLib.h | 2 +-
> UnitTestFrameworkPkg/PrivateInclude/UnitTestFrameworkTypes.h | 2 +-
> UnitTestFrameworkPkg/UnitTestFrameworkPkg.ci.yaml | 31 +++++++++++++-------
> 9 files changed, 37 insertions(+), 26 deletions(-)
>
> diff --git a/UnitTestFrameworkPkg/Library/Posix/MemoryAllocationLibPosix/MemoryAllocationLibPosix.c
> b/UnitTestFrameworkPkg/Library/Posix/MemoryAllocationLibPosix/MemoryAllocationLibPosix.c
> index 54029283fbbf..f85a05ec06ee 100644
> --- a/UnitTestFrameworkPkg/Library/Posix/MemoryAllocationLibPosix/MemoryAllocationLibPosix.c
> +++ b/UnitTestFrameworkPkg/Library/Posix/MemoryAllocationLibPosix/MemoryAllocationLibPosix.c
> @@ -27,7 +27,7 @@
> ///
> typedef struct {
> UINT32 Signature;
> - VOID *AllocatedBufffer;
> + VOID *AllocatedBuffer;
> UINTN TotalPages;
> VOID *AlignedBuffer;
> UINTN AlignedPages;
> @@ -165,16 +165,16 @@ AllocateAlignedPages (
> //
> // We need reserve Alignment pages for PAGE_HEAD, as meta data.
> //
> - PageHead.Signature = PAGE_HEAD_PRIVATE_SIGNATURE;
> - PageHead.TotalPages = Pages + EFI_SIZE_TO_PAGES (Alignment) * 2;
> - PageHead.AlignedPages = Pages;
> - PageHead.AllocatedBufffer = malloc (EFI_PAGES_TO_SIZE (PageHead.TotalPages));
> - if (PageHead.AllocatedBufffer == NULL) {
> + PageHead.Signature = PAGE_HEAD_PRIVATE_SIGNATURE;
> + PageHead.TotalPages = Pages + EFI_SIZE_TO_PAGES (Alignment) * 2;
> + PageHead.AlignedPages = Pages;
> + PageHead.AllocatedBuffer = malloc (EFI_PAGES_TO_SIZE (PageHead.TotalPages));
> + if (PageHead.AllocatedBuffer == NULL) {
> return NULL;
> }
>
> - PageHead.AlignedBuffer = (VOID *)(((UINTN)PageHead.AllocatedBufffer + AlignmentMask) & ~AlignmentMask);
> - if ((UINTN)PageHead.AlignedBuffer - (UINTN)PageHead.AllocatedBufffer < sizeof (PAGE_HEAD)) {
> + PageHead.AlignedBuffer = (VOID *)(((UINTN)PageHead.AllocatedBuffer + AlignmentMask) & ~AlignmentMask);
> + if ((UINTN)PageHead.AlignedBuffer - (UINTN)PageHead.AllocatedBuffer < sizeof (PAGE_HEAD)) {
> PageHead.AlignedBuffer = (VOID *)((UINTN)PageHead.AlignedBuffer + Alignment);
> }
>
> @@ -279,7 +279,7 @@ FreeAlignedPages (
> }
>
> PageHeadPtr->Signature = 0;
> - free (PageHeadPtr->AllocatedBufffer);
> + free (PageHeadPtr->AllocatedBuffer);
> }
>
> /**
> diff --git a/UnitTestFrameworkPkg/Library/UnitTestBootLibNull/UnitTestBootLibNull.c
> b/UnitTestFrameworkPkg/Library/UnitTestBootLibNull/UnitTestBootLibNull.c
> index a49aaefdb71f..7ff80850ff57 100644
> --- a/UnitTestFrameworkPkg/Library/UnitTestBootLibNull/UnitTestBootLibNull.c
> +++ b/UnitTestFrameworkPkg/Library/UnitTestBootLibNull/UnitTestBootLibNull.c
> @@ -13,7 +13,7 @@
>
> @retval EFI_SUCCESS Boot device for next boot was set.
> @retval EFI_UNSUPPORTED Setting the boot device for the next boot is not
> - supportted.
> + supported.
> @retval Other Boot device for next boot can not be set.
> **/
> EFI_STATUS
> diff --git a/UnitTestFrameworkPkg/Library/UnitTestBootLibUsbClass/UnitTestBootLibUsbClass.c
> b/UnitTestFrameworkPkg/Library/UnitTestBootLibUsbClass/UnitTestBootLibUsbClass.c
> index ebb42186a534..8b03e7cd15fc 100644
> --- a/UnitTestFrameworkPkg/Library/UnitTestBootLibUsbClass/UnitTestBootLibUsbClass.c
> +++ b/UnitTestFrameworkPkg/Library/UnitTestBootLibUsbClass/UnitTestBootLibUsbClass.c
> @@ -20,7 +20,7 @@
>
> @retval EFI_SUCCESS Boot device for next boot was set.
> @retval EFI_UNSUPPORTED Setting the boot device for the next boot is not
> - supportted.
> + supported.
> @retval Other Boot device for next boot can not be set.
> **/
> EFI_STATUS
> diff --git a/UnitTestFrameworkPkg/Library/UnitTestLib/Log.c b/UnitTestFrameworkPkg/Library/UnitTestLib/Log.c
> index 3998aafdf843..35544ff0659a 100644
> --- a/UnitTestFrameworkPkg/Library/UnitTestLib/Log.c
> +++ b/UnitTestFrameworkPkg/Library/UnitTestLib/Log.c
> @@ -1,5 +1,5 @@
> /**
> - Implemnet UnitTestLib log services
> + Implement UnitTestLib log services
>
> Copyright (c) Microsoft Corporation.<BR>
> SPDX-License-Identifier: BSD-2-Clause-Patent
> diff --git a/UnitTestFrameworkPkg/Library/UnitTestLib/UnitTestLib.c
> b/UnitTestFrameworkPkg/Library/UnitTestLib/UnitTestLib.c
> index 5b442ed122ea..8c2ffa43d580 100644
> --- a/UnitTestFrameworkPkg/Library/UnitTestLib/UnitTestLib.c
> +++ b/UnitTestFrameworkPkg/Library/UnitTestLib/UnitTestLib.c
> @@ -217,7 +217,7 @@ InitUnitTestFramework (
> NewFramework = NULL;
>
> //
> - // First, check all pointers and make sure nothing's broked.
> + // First, check all pointers and make sure nothing is broken.
> //
> if ((FrameworkHandle == NULL) || (Title == NULL) ||
> (ShortTitle == NULL) || (VersionString == NULL))
> diff --git a/UnitTestFrameworkPkg/Test/UnitTest/Sample/SampleUnitTest/SampleUnitTest.c
> b/UnitTestFrameworkPkg/Test/UnitTest/Sample/SampleUnitTest/SampleUnitTest.c
> index c02a2dba987d..dd010a75a5a6 100644
> --- a/UnitTestFrameworkPkg/Test/UnitTest/Sample/SampleUnitTest/SampleUnitTest.c
> +++ b/UnitTestFrameworkPkg/Test/UnitTest/Sample/SampleUnitTest/SampleUnitTest.c
> @@ -1,5 +1,5 @@
> /** @file
> - This is a sample to demostrate the usage of the Unit Test Library that
> + This is a sample to demonstrate the usage of the Unit Test Library that
> supports the PEI, DXE, SMM, UEFI SHell, and host execution environments.
>
> Copyright (c) Microsoft Corporation.<BR>
> diff --git a/UnitTestFrameworkPkg/PrivateInclude/Library/UnitTestBootLib.h
> b/UnitTestFrameworkPkg/PrivateInclude/Library/UnitTestBootLib.h
> index d90bff0e4c1b..de4b9566837b 100644
> --- a/UnitTestFrameworkPkg/PrivateInclude/Library/UnitTestBootLib.h
> +++ b/UnitTestFrameworkPkg/PrivateInclude/Library/UnitTestBootLib.h
> @@ -19,7 +19,7 @@
>
> @retval EFI_SUCCESS Boot device for next boot was set.
> @retval EFI_UNSUPPORTED Setting the boot device for the next boot is not
> - supportted.
> + supported.
> @retval Other Boot device for next boot can not be set.
> **/
> EFI_STATUS
> diff --git a/UnitTestFrameworkPkg/PrivateInclude/UnitTestFrameworkTypes.h
> b/UnitTestFrameworkPkg/PrivateInclude/UnitTestFrameworkTypes.h
> index adce413818a2..0c0e82de4003 100644
> --- a/UnitTestFrameworkPkg/PrivateInclude/UnitTestFrameworkTypes.h
> +++ b/UnitTestFrameworkPkg/PrivateInclude/UnitTestFrameworkTypes.h
> @@ -18,7 +18,7 @@
> #define UNIT_TEST_MAX_STRING_LENGTH (120)
>
> ///
> -/// The size of a firngerprint used to save/resume execution of a unit test
> +/// The size of a fingerprint used to save/resume execution of a unit test
> /// framework. This is the size of a CRC32 value which is 32-bit value.
> ///
> ///
> diff --git a/UnitTestFrameworkPkg/UnitTestFrameworkPkg.ci.yaml b/UnitTestFrameworkPkg/UnitTestFrameworkPkg.ci.yaml
> index 072df6208c92..ce86e53ef59d 100644
> --- a/UnitTestFrameworkPkg/UnitTestFrameworkPkg.ci.yaml
> +++ b/UnitTestFrameworkPkg/UnitTestFrameworkPkg.ci.yaml
> @@ -82,20 +82,31 @@
> "Library/GoogleTestLib/googletest/**/*.*" # not going to spell check a submodule
> ],
> "ExtendWords": [ # words to extend to the dictionary for this package
> - "testcase",
> - "testsuites",
> - "cmocka",
> + "assertnotefierror",
> + "assertnotnull",
> + "assertstatusequal",
> "buildmodule",
> + "cmocka",
> + "cmockery",
> + "corthon", # Contact GitHub account in Readme
> "criterium",
> + "deadloop",
> + "devpath",
> + "DHAVE", # build flag for cmocka in the INF
> + "expectassert",
> + "failuretype",
> + "gtest", # file name in GoogleTestLib.inf
> + "mdkinney", # Contact GitHub account in Readme
> + "NOFAILURE",
> + "notefierror",
> + "notequal",
> "pytool",
> "pytools",
> - "NOFAILURE",
> - "cmockery",
> - "DHAVE", # build flag for cmocka in the INF
> - "gtest", # file name in GoogleTestLib.inf
> - "corthon", # Contact GitHub account in Readme
> - "mdkinney", # Contact GitHub account in Readme
> - "spbrogan" # Contact GitHub account in Readme
> + "spbrogan", # Contact GitHub account in Readme
> + "statusequal",
> + "testcase",
> + "testfailuremsg",
> + "testsuites"
> ],
> "IgnoreStandardPaths": [], # Standard Plugin defined paths that should be ignore
> "AdditionalIncludePaths": [] # Additional paths to spell check (wildcards supported)
> --
> 2.28.0.windows.1
^ permalink raw reply [flat|nested] 36+ messages in thread
* [PATCH v3 05/14] FatPkg: Fix new typos reported
2022-12-14 22:52 [PATCH v3 00/14] Fix new typos reported Michael Kubacki
` (3 preceding siblings ...)
2022-12-14 22:52 ` [PATCH v3 04/14] UnitTestFrameworkPkg: " Michael Kubacki
@ 2022-12-14 22:52 ` Michael Kubacki
2022-12-14 23:07 ` [edk2-devel] " Michael D Kinney
2022-12-14 22:52 ` [PATCH v3 06/14] FmpDevicePkg: " Michael Kubacki
` (9 subsequent siblings)
14 siblings, 1 reply; 36+ messages in thread
From: Michael Kubacki @ 2022-12-14 22:52 UTC (permalink / raw)
To: devel; +Cc: Ray Ni
From: Michael Kubacki <michael.kubacki@microsoft.com>
The SpellCheck plugin began reporting new typos that were previously
missed. This change fixes those typos.
Cc: Ray Ni <ray.ni@intel.com>
Signed-off-by: Michael Kubacki <michael.kubacki@microsoft.com>
---
FatPkg/EnhancedFatDxe/FileSpace.c | 2 +-
FatPkg/EnhancedFatDxe/ReadWrite.c | 2 +-
FatPkg/EnhancedFatDxe/Fat.h | 2 +-
FatPkg/FatPkg.ci.yaml | 22 +++++++++++++++-----
4 files changed, 20 insertions(+), 8 deletions(-)
diff --git a/FatPkg/EnhancedFatDxe/FileSpace.c b/FatPkg/EnhancedFatDxe/FileSpace.c
index 909d4980d21a..1220e66598ea 100644
--- a/FatPkg/EnhancedFatDxe/FileSpace.c
+++ b/FatPkg/EnhancedFatDxe/FileSpace.c
@@ -347,7 +347,7 @@ FatSizeToClusters (
@param OFile - The open file.
- @retval EFI_SUCCESS - Shrinked successfully.
+ @retval EFI_SUCCESS - Shrunk successfully.
@retval EFI_VOLUME_CORRUPTED - There are errors in the file's clusters.
**/
diff --git a/FatPkg/EnhancedFatDxe/ReadWrite.c b/FatPkg/EnhancedFatDxe/ReadWrite.c
index 8f525044d1f1..6593e3aff79c 100644
--- a/FatPkg/EnhancedFatDxe/ReadWrite.c
+++ b/FatPkg/EnhancedFatDxe/ReadWrite.c
@@ -580,7 +580,7 @@ FatWriteZeroPool (
if (AppendedSize > FAT_MAX_ALLOCATE_SIZE) {
//
// If the appended size is larger, maybe we can not allocate the whole
- // memory once. So if the growed size is larger than 10M, we just
+ // memory once. So if the grown size is larger than 10M, we just
// allocate 10M memory (one healthy system should have 10M available
// memory), and then write the zerobuffer to the file several times.
//
diff --git a/FatPkg/EnhancedFatDxe/Fat.h b/FatPkg/EnhancedFatDxe/Fat.h
index 356cdbdb51af..e4aa8eac62c4 100644
--- a/FatPkg/EnhancedFatDxe/Fat.h
+++ b/FatPkg/EnhancedFatDxe/Fat.h
@@ -867,7 +867,7 @@ FatCleanupVolume (
@param OFile - The open file.
- @retval EFI_SUCCESS - Shrinked successfully.
+ @retval EFI_SUCCESS - Shrunk successfully.
@retval EFI_VOLUME_CORRUPTED - There are errors in the file's clusters.
**/
diff --git a/FatPkg/FatPkg.ci.yaml b/FatPkg/FatPkg.ci.yaml
index fe95f481b50c..247028c22921 100644
--- a/FatPkg/FatPkg.ci.yaml
+++ b/FatPkg/FatPkg.ci.yaml
@@ -51,15 +51,27 @@
},
"SpellCheck": {
"ExtendWords": [
+ "bootable",
+ "caseflag",
+ "CDVOL",
+ "checklink",
+ "childlink",
+ "clustersize",
+ "controll",
+ "datacache",
+ "dircachelink",
+ "DMDEPKG",
"ELTORITO",
+ "fatcache",
+ "fatfilesystem",
+ "fatname",
+ "FDISKed",
+ "FFFFFFFFL",
"FHAND",
"IFILE",
- "OFILE",
- "FDISKed",
"Lfnbuffer",
- "FFFFFFFFL",
- "CDVOL",
- "DMDEPKG"
+ "OFILE",
+ "zerobuffer"
]
}
}
--
2.28.0.windows.1
^ permalink raw reply related [flat|nested] 36+ messages in thread* Re: [edk2-devel] [PATCH v3 05/14] FatPkg: Fix new typos reported
2022-12-14 22:52 ` [PATCH v3 05/14] FatPkg: " Michael Kubacki
@ 2022-12-14 23:07 ` Michael D Kinney
0 siblings, 0 replies; 36+ messages in thread
From: Michael D Kinney @ 2022-12-14 23:07 UTC (permalink / raw)
To: devel@edk2.groups.io, mikuback@linux.microsoft.com,
Kinney, Michael D
Cc: Ni, Ray
One comment below
Mike
> -----Original Message-----
> From: devel@edk2.groups.io <devel@edk2.groups.io> On Behalf Of Michael Kubacki
> Sent: Wednesday, December 14, 2022 2:53 PM
> To: devel@edk2.groups.io
> Cc: Ni, Ray <ray.ni@intel.com>
> Subject: [edk2-devel] [PATCH v3 05/14] FatPkg: Fix new typos reported
>
> From: Michael Kubacki <michael.kubacki@microsoft.com>
>
> The SpellCheck plugin began reporting new typos that were previously
> missed. This change fixes those typos.
>
> Cc: Ray Ni <ray.ni@intel.com>
> Signed-off-by: Michael Kubacki <michael.kubacki@microsoft.com>
> ---
> FatPkg/EnhancedFatDxe/FileSpace.c | 2 +-
> FatPkg/EnhancedFatDxe/ReadWrite.c | 2 +-
> FatPkg/EnhancedFatDxe/Fat.h | 2 +-
> FatPkg/FatPkg.ci.yaml | 22 +++++++++++++++-----
> 4 files changed, 20 insertions(+), 8 deletions(-)
>
> diff --git a/FatPkg/EnhancedFatDxe/FileSpace.c b/FatPkg/EnhancedFatDxe/FileSpace.c
> index 909d4980d21a..1220e66598ea 100644
> --- a/FatPkg/EnhancedFatDxe/FileSpace.c
> +++ b/FatPkg/EnhancedFatDxe/FileSpace.c
> @@ -347,7 +347,7 @@ FatSizeToClusters (
>
> @param OFile - The open file.
>
> - @retval EFI_SUCCESS - Shrinked successfully.
> + @retval EFI_SUCCESS - Shrunk successfully.
> @retval EFI_VOLUME_CORRUPTED - There are errors in the file's clusters.
>
> **/
> diff --git a/FatPkg/EnhancedFatDxe/ReadWrite.c b/FatPkg/EnhancedFatDxe/ReadWrite.c
> index 8f525044d1f1..6593e3aff79c 100644
> --- a/FatPkg/EnhancedFatDxe/ReadWrite.c
> +++ b/FatPkg/EnhancedFatDxe/ReadWrite.c
> @@ -580,7 +580,7 @@ FatWriteZeroPool (
> if (AppendedSize > FAT_MAX_ALLOCATE_SIZE) {
> //
> // If the appended size is larger, maybe we can not allocate the whole
> - // memory once. So if the growed size is larger than 10M, we just
> + // memory once. So if the grown size is larger than 10M, we just
> // allocate 10M memory (one healthy system should have 10M available
> // memory), and then write the zerobuffer to the file several times.
> //
> diff --git a/FatPkg/EnhancedFatDxe/Fat.h b/FatPkg/EnhancedFatDxe/Fat.h
> index 356cdbdb51af..e4aa8eac62c4 100644
> --- a/FatPkg/EnhancedFatDxe/Fat.h
> +++ b/FatPkg/EnhancedFatDxe/Fat.h
> @@ -867,7 +867,7 @@ FatCleanupVolume (
>
> @param OFile - The open file.
>
> - @retval EFI_SUCCESS - Shrinked successfully.
> + @retval EFI_SUCCESS - Shrunk successfully.
> @retval EFI_VOLUME_CORRUPTED - There are errors in the file's clusters.
>
> **/
> diff --git a/FatPkg/FatPkg.ci.yaml b/FatPkg/FatPkg.ci.yaml
> index fe95f481b50c..247028c22921 100644
> --- a/FatPkg/FatPkg.ci.yaml
> +++ b/FatPkg/FatPkg.ci.yaml
> @@ -51,15 +51,27 @@
> },
> "SpellCheck": {
> "ExtendWords": [
> + "bootable",
> + "caseflag",
> + "CDVOL",
> + "checklink",
> + "childlink",
> + "clustersize",
> + "controll",
This looks like one that should be fixed in the code and removed from this list
> + "datacache",
> + "dircachelink",
> + "DMDEPKG",
> "ELTORITO",
> + "fatcache",
> + "fatfilesystem",
> + "fatname",
> + "FDISKed",
> + "FFFFFFFFL",
> "FHAND",
> "IFILE",
> - "OFILE",
> - "FDISKed",
> "Lfnbuffer",
> - "FFFFFFFFL",
> - "CDVOL",
> - "DMDEPKG"
> + "OFILE",
> + "zerobuffer"
> ]
> }
> }
> --
> 2.28.0.windows.1
>
>
>
> -=-=-=-=-=-=
> Groups.io Links: You receive all messages sent to this group.
> View/Reply Online (#97386): https://edk2.groups.io/g/devel/message/97386
> Mute This Topic: https://groups.io/mt/95678206/1643496
> Group Owner: devel+owner@edk2.groups.io
> Unsubscribe: https://edk2.groups.io/g/devel/unsub [michael.d.kinney@intel.com]
> -=-=-=-=-=-=
>
^ permalink raw reply [flat|nested] 36+ messages in thread
* [PATCH v3 06/14] FmpDevicePkg: Fix new typos reported
2022-12-14 22:52 [PATCH v3 00/14] Fix new typos reported Michael Kubacki
` (4 preceding siblings ...)
2022-12-14 22:52 ` [PATCH v3 05/14] FatPkg: " Michael Kubacki
@ 2022-12-14 22:52 ` Michael Kubacki
2022-12-14 23:05 ` Michael D Kinney
2022-12-14 22:52 ` [PATCH v3 07/14] ArmPkg: Ignore " Michael Kubacki
` (8 subsequent siblings)
14 siblings, 1 reply; 36+ messages in thread
From: Michael Kubacki @ 2022-12-14 22:52 UTC (permalink / raw)
To: devel; +Cc: Liming Gao, Michael D Kinney, Guomin Jiang, Wei6 Xu
From: Michael Kubacki <michael.kubacki@microsoft.com>
The SpellCheck plugin began reporting new typos that were previously
missed. This change fixes those typos.
Cc: Liming Gao <gaoliming@byosoft.com.cn>
Cc: Michael D Kinney <michael.d.kinney@intel.com>
Cc: Guomin Jiang <guomin.jiang@intel.com>
Cc: Wei6 Xu <wei6.xu@intel.com>
Signed-off-by: Michael Kubacki <michael.kubacki@microsoft.com>
---
FmpDevicePkg/Library/FmpDependencyLib/FmpDependencyLib.c | 2 +-
FmpDevicePkg/FmpDevicePkg.ci.yaml | 4 ++++
2 files changed, 5 insertions(+), 1 deletion(-)
diff --git a/FmpDevicePkg/Library/FmpDependencyLib/FmpDependencyLib.c b/FmpDevicePkg/Library/FmpDependencyLib/FmpDependencyLib.c
index 76a1ee3f40db..c5b6bd18ba44 100644
--- a/FmpDevicePkg/Library/FmpDependencyLib/FmpDependencyLib.c
+++ b/FmpDevicePkg/Library/FmpDependencyLib/FmpDependencyLib.c
@@ -56,7 +56,7 @@ DEPEX_ELEMENT *mDepexEvaluationStackPointer = NULL;
/**
Grow size of the Depex stack
- @retval EFI_SUCCESS Stack successfully growed.
+ @retval EFI_SUCCESS Stack successfully grown.
@retval EFI_OUT_OF_RESOURCES There is not enough system memory to grow the stack.
**/
diff --git a/FmpDevicePkg/FmpDevicePkg.ci.yaml b/FmpDevicePkg/FmpDevicePkg.ci.yaml
index 1b3e2187356d..81d564876cb4 100644
--- a/FmpDevicePkg/FmpDevicePkg.ci.yaml
+++ b/FmpDevicePkg/FmpDevicePkg.ci.yaml
@@ -60,6 +60,10 @@
"SpellCheck": {
"ExtendWords": [
"FMPSTATE",
+ "lastattemptstatus",
+ "lastattemptversion",
+ "lowestsupportedversion",
+ "updateable"
]
},
"Defines": {
--
2.28.0.windows.1
^ permalink raw reply related [flat|nested] 36+ messages in thread* Re: [PATCH v3 06/14] FmpDevicePkg: Fix new typos reported
2022-12-14 22:52 ` [PATCH v3 06/14] FmpDevicePkg: " Michael Kubacki
@ 2022-12-14 23:05 ` Michael D Kinney
0 siblings, 0 replies; 36+ messages in thread
From: Michael D Kinney @ 2022-12-14 23:05 UTC (permalink / raw)
To: mikuback@linux.microsoft.com, devel@edk2.groups.io,
Kinney, Michael D
Cc: Gao, Liming, Jiang, Guomin, Xu, Wei6
Reviewed-by: Michael D Kinney <michael.d.kinney@intel.com>
> -----Original Message-----
> From: mikuback@linux.microsoft.com <mikuback@linux.microsoft.com>
> Sent: Wednesday, December 14, 2022 2:53 PM
> To: devel@edk2.groups.io
> Cc: Gao, Liming <gaoliming@byosoft.com.cn>; Kinney, Michael D <michael.d.kinney@intel.com>; Jiang, Guomin
> <guomin.jiang@intel.com>; Xu, Wei6 <wei6.xu@intel.com>
> Subject: [PATCH v3 06/14] FmpDevicePkg: Fix new typos reported
>
> From: Michael Kubacki <michael.kubacki@microsoft.com>
>
> The SpellCheck plugin began reporting new typos that were previously
> missed. This change fixes those typos.
>
> Cc: Liming Gao <gaoliming@byosoft.com.cn>
> Cc: Michael D Kinney <michael.d.kinney@intel.com>
> Cc: Guomin Jiang <guomin.jiang@intel.com>
> Cc: Wei6 Xu <wei6.xu@intel.com>
> Signed-off-by: Michael Kubacki <michael.kubacki@microsoft.com>
> ---
> FmpDevicePkg/Library/FmpDependencyLib/FmpDependencyLib.c | 2 +-
> FmpDevicePkg/FmpDevicePkg.ci.yaml | 4 ++++
> 2 files changed, 5 insertions(+), 1 deletion(-)
>
> diff --git a/FmpDevicePkg/Library/FmpDependencyLib/FmpDependencyLib.c
> b/FmpDevicePkg/Library/FmpDependencyLib/FmpDependencyLib.c
> index 76a1ee3f40db..c5b6bd18ba44 100644
> --- a/FmpDevicePkg/Library/FmpDependencyLib/FmpDependencyLib.c
> +++ b/FmpDevicePkg/Library/FmpDependencyLib/FmpDependencyLib.c
> @@ -56,7 +56,7 @@ DEPEX_ELEMENT *mDepexEvaluationStackPointer = NULL;
> /**
> Grow size of the Depex stack
>
> - @retval EFI_SUCCESS Stack successfully growed.
> + @retval EFI_SUCCESS Stack successfully grown.
> @retval EFI_OUT_OF_RESOURCES There is not enough system memory to grow the stack.
>
> **/
> diff --git a/FmpDevicePkg/FmpDevicePkg.ci.yaml b/FmpDevicePkg/FmpDevicePkg.ci.yaml
> index 1b3e2187356d..81d564876cb4 100644
> --- a/FmpDevicePkg/FmpDevicePkg.ci.yaml
> +++ b/FmpDevicePkg/FmpDevicePkg.ci.yaml
> @@ -60,6 +60,10 @@
> "SpellCheck": {
> "ExtendWords": [
> "FMPSTATE",
> + "lastattemptstatus",
> + "lastattemptversion",
> + "lowestsupportedversion",
> + "updateable"
> ]
> },
> "Defines": {
> --
> 2.28.0.windows.1
^ permalink raw reply [flat|nested] 36+ messages in thread
* [PATCH v3 07/14] ArmPkg: Ignore new typos reported
2022-12-14 22:52 [PATCH v3 00/14] Fix new typos reported Michael Kubacki
` (5 preceding siblings ...)
2022-12-14 22:52 ` [PATCH v3 06/14] FmpDevicePkg: " Michael Kubacki
@ 2022-12-14 22:52 ` Michael Kubacki
2022-12-14 22:52 ` [PATCH v3 08/14] ArmVirtPkg: Add new ignored spelling errors Michael Kubacki
` (7 subsequent siblings)
14 siblings, 0 replies; 36+ messages in thread
From: Michael Kubacki @ 2022-12-14 22:52 UTC (permalink / raw)
To: devel; +Cc: Leif Lindholm, Ard Biesheuvel, Sami Mujawar
From: Michael Kubacki <michael.kubacki@microsoft.com>
REF:https://bugzilla.tianocore.org/show_bug.cgi?id=3929
The SpellCheck plugin began reporting new typos that were previously
missed. Due to the number of spelling errors in this package, no
errors are fixed in this change. They are ignored to unblock overall
edk2 CI.
The maintainers should visit the list of extended words for
SpellCheck in ArmPkg.ci.yaml and determine the best resolution for
each item.
The following BZ was filed to track that follow up:
https://bugzilla.tianocore.org/show_bug.cgi?id=3929
Cc: Leif Lindholm <quic_llindhol@quicinc.com>
Cc: Ard Biesheuvel <ardb+tianocore@kernel.org>
Cc: Sami Mujawar <sami.mujawar@arm.com>
Signed-off-by: Michael Kubacki <michael.kubacki@microsoft.com>
Reviewed-by: Sami Mujawar <sami.mujawar@arm.com>
---
ArmPkg/Library/ArmDisassemblerLib/ThumbDisassembler.c | 4 +-
ArmPkg/Library/SemiHostingSerialPortLib/SerialPortLib.c | 2 +-
ArmPkg/Library/StandaloneMmMmuLib/ArmMmuStandaloneMmLib.c | 6 +--
ArmPkg/Universal/Smbios/OemMiscLibNull/OemMiscLib.c | 2 +-
ArmPkg/ArmPkg.ci.yaml | 53 ++++++++++++++++++--
ArmPkg/Include/Library/OemMiscLib.h | 2 +-
6 files changed, 57 insertions(+), 12 deletions(-)
diff --git a/ArmPkg/Library/ArmDisassemblerLib/ThumbDisassembler.c b/ArmPkg/Library/ArmDisassemblerLib/ThumbDisassembler.c
index 6dae7a9121af..dbd1f6c211ab 100644
--- a/ArmPkg/Library/ArmDisassemblerLib/ThumbDisassembler.c
+++ b/ArmPkg/Library/ArmDisassemblerLib/ThumbDisassembler.c
@@ -202,7 +202,7 @@ THUMB_INSTRUCTIONS gOpThumb[] = {
};
THUMB_INSTRUCTIONS gOpThumb2[] = {
- // Instruct OpCode OpCode Mask Addressig Mode
+ // Instruct OpCode OpCode Mask Addressing Mode
{ "ADR", 0xf2af0000, 0xfbff8000, ADR_THUMB2 }, // ADDR <Rd>, <label> ;Needs to go before ADDW
{ "CMN", 0xf1100f00, 0xfff08f00, CMN_THUMB2 }, // CMN <Rn>, #<const> ;Needs to go before ADD
@@ -648,7 +648,7 @@ DisassembleThumbInstruction (
return;
case DATA_CBZ:
- // CB{N}Z <Rn>, <Lable>
+ // CB{N}Z <Rn>, <Label>
Target = ((OpCode >> 2) & 0x3e) | (((OpCode & BIT9) == BIT9) ? BIT6 : 0);
AsciiSPrint (&Buf[Offset], Size - Offset, " %a, %08x", gReg[Rd], Pc + 4 + Target);
return;
diff --git a/ArmPkg/Library/SemiHostingSerialPortLib/SerialPortLib.c b/ArmPkg/Library/SemiHostingSerialPortLib/SerialPortLib.c
index 5ff8a5b7a62e..9c9a0f1c2ef6 100644
--- a/ArmPkg/Library/SemiHostingSerialPortLib/SerialPortLib.c
+++ b/ArmPkg/Library/SemiHostingSerialPortLib/SerialPortLib.c
@@ -95,7 +95,7 @@ SerialPortWrite (
}
/**
- Read data from serial device and save the datas in buffer.
+ Read data from serial device and save the data in buffer.
@param Buffer Point of data buffer which need to be written.
@param NumberOfBytes Number of output bytes which are cached in Buffer.
diff --git a/ArmPkg/Library/StandaloneMmMmuLib/ArmMmuStandaloneMmLib.c b/ArmPkg/Library/StandaloneMmMmuLib/ArmMmuStandaloneMmLib.c
index d55aff76201e..c61d6f7b772d 100644
--- a/ArmPkg/Library/StandaloneMmMmuLib/ArmMmuStandaloneMmLib.c
+++ b/ArmPkg/Library/StandaloneMmMmuLib/ArmMmuStandaloneMmLib.c
@@ -31,7 +31,7 @@
return it contains the response parameters.
@param [out] RetVal Pointer to return the response value.
- @retval EFI_SUCCESS Request successfull.
+ @retval EFI_SUCCESS Request successful.
@retval EFI_INVALID_PARAMETER A parameter is invalid.
@retval EFI_NOT_READY Callee is busy or not in a state to handle
this request.
@@ -134,7 +134,7 @@ SendMemoryPermissionRequest (
@param [in] BaseAddress Base address for the memory region.
@param [out] MemoryAttributes Pointer to return the memory attributes.
- @retval EFI_SUCCESS Request successfull.
+ @retval EFI_SUCCESS Request successful.
@retval EFI_INVALID_PARAMETER A parameter is invalid.
@retval EFI_NOT_READY Callee is busy or not in a state to handle
this request.
@@ -193,7 +193,7 @@ GetMemoryPermissions (
@param [in] Length Length of the memory region.
@param [in] Permissions Memory access controls attributes.
- @retval EFI_SUCCESS Request successfull.
+ @retval EFI_SUCCESS Request successful.
@retval EFI_INVALID_PARAMETER A parameter is invalid.
@retval EFI_NOT_READY Callee is busy or not in a state to handle
this request.
diff --git a/ArmPkg/Universal/Smbios/OemMiscLibNull/OemMiscLib.c b/ArmPkg/Universal/Smbios/OemMiscLibNull/OemMiscLib.c
index a5d635da9e11..dd207a62f71f 100644
--- a/ArmPkg/Universal/Smbios/OemMiscLibNull/OemMiscLib.c
+++ b/ArmPkg/Universal/Smbios/OemMiscLibNull/OemMiscLib.c
@@ -39,7 +39,7 @@ OemGetCpuFreq (
@param ProcessorIndex Index of the processor to get the information for.
@param ProcessorStatus Processor status.
- @param ProcessorCharacteristics Processor characteritics.
+ @param ProcessorCharacteristics Processor characteristics.
@param MiscProcessorData Miscellaneous processor information.
@return TRUE on success, FALSE on failure.
diff --git a/ArmPkg/ArmPkg.ci.yaml b/ArmPkg/ArmPkg.ci.yaml
index 24db74250513..c8dface6821a 100644
--- a/ArmPkg/ArmPkg.ci.yaml
+++ b/ArmPkg/ArmPkg.ci.yaml
@@ -93,20 +93,32 @@
], # use gitignore syntax to ignore errors
# in matching files
"ExtendWords": [
- "api's",
"ackintid",
"actlr",
"aeabi",
+ "api's",
+ "armgic",
+ "armltd",
"asedis",
"ashldi",
"ashrdi",
+ "autoreload",
"baddr",
+ "batard",
+ "bootflow",
+ "bootup",
+ "cacheability",
+ "cachetype",
"ccidx",
"ccsidr",
"clidr",
"clrex",
"clzsi",
"cnthctl",
+ "codeview",
+ "commonlpiaff",
+ "comms",
+ "conout",
"cortexa",
"cpacr",
"cpuactlr",
@@ -114,18 +126,21 @@
"ctzsi",
"cygdrive",
"cygpaths",
- "datas",
"dcmpeq",
"dcmpge",
"dcmpgt",
"dcmple",
"dcmplt",
"ddisable",
+ "deadloop",
+ "devicepath",
+ "directlpi",
"divdi",
"divsi",
"dmdepkg",
"dpref",
"drsub",
+ "everyoneelse",
"fcmpeq",
"fcmpge",
"fcmpgt",
@@ -136,6 +151,7 @@
"hisilicon",
"iccabpr",
"iccbpr",
+ "icceior",
"icciar",
"iccicr",
"icciidr",
@@ -143,24 +159,32 @@
"iccpmr",
"iccrpr",
"icdabr",
+ "icddcr",
"icdicer",
"icdicfr",
"icdicpr",
"icdictr",
"icdiidr",
+ "icdipr",
+ "icdiptr",
"icdiser",
"icdisr",
"icdppisr",
"icdsgir",
"icdspr",
"icenabler",
+ "innershr",
"intid",
+ "invall",
"ipriority",
"irouter",
"isenabler",
"istatus",
"itargets",
- "lable",
+ "itstate",
+ "langcode",
+ "langcodes",
+ "largepage",
"ldivmod",
"ldmdb",
"ldmia",
@@ -174,25 +198,37 @@
"ldrsb",
"ldrsbt",
"ldrsh",
+ "ldrsht",
+ "littleendian",
"lshrdi",
+ "memclr",
"moddi",
"modsi",
"mpcore",
"mpidr",
"muldi",
"mullu",
+ "nonsecure",
"nonshareable",
"nsacr",
"nsasedis",
"nuvia",
"oldit",
+ "outershr",
+ "pagetable",
"pcten",
"plpis",
+ "postmem",
+ "premem",
"procno",
"readc",
+ "reglist",
"revsh",
"rfedb",
"sctlr",
+ "semihalf",
+ "setend",
+ "sharelvl",
"smccc",
"smlabb",
"smlabt",
@@ -218,7 +254,13 @@
"strexd",
"strexh",
"strht",
+ "subhierarchy",
+ "subtrack",
+ "subvendor",
+ "supersection",
"switchu",
+ "targetlist",
+ "tmpname",
"tpidrurw",
"ttbcr",
"typer",
@@ -232,7 +274,10 @@
"umodsi",
"usada",
"vlpis",
- "writec"
+ "watchdogtimer",
+ "writeback",
+ "writec",
+ "xectue"
], # words to extend to the dictionary for this package
"IgnoreStandardPaths": [ # Standard Plugin defined paths that
"*.asm", "*.s" # should be ignore
diff --git a/ArmPkg/Include/Library/OemMiscLib.h b/ArmPkg/Include/Library/OemMiscLib.h
index 541274999e5c..02af6afdc2ca 100644
--- a/ArmPkg/Include/Library/OemMiscLib.h
+++ b/ArmPkg/Include/Library/OemMiscLib.h
@@ -86,7 +86,7 @@ OemGetCpuFreq (
@param ProcessorIndex Index of the processor to get the information for.
@param ProcessorStatus Processor status.
- @param ProcessorCharacteristics Processor characteritics.
+ @param ProcessorCharacteristics Processor characteristics.
@param MiscProcessorData Miscellaneous processor information.
@return TRUE on success, FALSE on failure.
--
2.28.0.windows.1
^ permalink raw reply related [flat|nested] 36+ messages in thread* [PATCH v3 08/14] ArmVirtPkg: Add new ignored spelling errors
2022-12-14 22:52 [PATCH v3 00/14] Fix new typos reported Michael Kubacki
` (6 preceding siblings ...)
2022-12-14 22:52 ` [PATCH v3 07/14] ArmPkg: Ignore " Michael Kubacki
@ 2022-12-14 22:52 ` Michael Kubacki
2022-12-14 22:52 ` [PATCH v3 09/14] ArmPkg: Fix typos Michael Kubacki
` (6 subsequent siblings)
14 siblings, 0 replies; 36+ messages in thread
From: Michael Kubacki @ 2022-12-14 22:52 UTC (permalink / raw)
To: devel; +Cc: Ard Biesheuvel, Leif Lindholm, Sami Mujawar, Gerd Hoffmann
From: Michael Kubacki <michael.kubacki@microsoft.com>
The SpellCheck plugin began reporting new typos that were previously
missed. This change adds the new words reported to the extended
words list in ArmVirtPkg.ci.yaml.
Cc: Ard Biesheuvel <ardb+tianocore@kernel.org>
Cc: Leif Lindholm <quic_llindhol@quicinc.com>
Cc: Sami Mujawar <sami.mujawar@arm.com>
Cc: Gerd Hoffmann <kraxel@redhat.com>
Signed-off-by: Michael Kubacki <michael.kubacki@microsoft.com>
Reviewed-by: Sami Mujawar <sami.mujawar@arm.com>
---
ArmVirtPkg/ArmVirtPkg.ci.yaml | 25 ++++++++++++--------
1 file changed, 15 insertions(+), 10 deletions(-)
diff --git a/ArmVirtPkg/ArmVirtPkg.ci.yaml b/ArmVirtPkg/ArmVirtPkg.ci.yaml
index 1e799dc4e194..f22dde6d5718 100644
--- a/ArmVirtPkg/ArmVirtPkg.ci.yaml
+++ b/ArmVirtPkg/ArmVirtPkg.ci.yaml
@@ -101,27 +101,32 @@
"ExtendWords": [
"acpiview",
"armltd",
- "ssdts",
- "setjump",
- "plong",
- "lparam",
- "lpdword",
- "lpthread",
- "lresult",
"bootable",
"bsymbolic",
+ "cloudhv",
+ "devicepath",
"endiannness",
+ "finalise",
"fvmain",
+ "kvmtool",
+ "lparam",
+ "lpdword",
+ "lpthread",
+ "lresult",
"multiboot",
+ "periph",
+ "plong",
+ "prefetchable",
"qemu's",
"ramdisk",
"ramfb",
+ "redist",
+ "setjump",
+ "ssdts",
"unbootable",
"virt's",
"werror",
- "xenio",
- "kvmtool",
- "cloudhv"
+ "xenio"
], # words to extend to the dictionary for this package
"IgnoreStandardPaths": [], # Standard Plugin defined paths that should be ignore
"AdditionalIncludePaths": [] # Additional paths to spell check (wildcards supported)
--
2.28.0.windows.1
^ permalink raw reply related [flat|nested] 36+ messages in thread* [PATCH v3 09/14] ArmPkg: Fix typos
2022-12-14 22:52 [PATCH v3 00/14] Fix new typos reported Michael Kubacki
` (7 preceding siblings ...)
2022-12-14 22:52 ` [PATCH v3 08/14] ArmVirtPkg: Add new ignored spelling errors Michael Kubacki
@ 2022-12-14 22:52 ` Michael Kubacki
2022-12-14 22:52 ` [PATCH v3 10/14] ArmPlatformPkg: " Michael Kubacki
` (5 subsequent siblings)
14 siblings, 0 replies; 36+ messages in thread
From: Michael Kubacki @ 2022-12-14 22:52 UTC (permalink / raw)
To: devel; +Cc: Leif Lindholm, Ard Biesheuvel, Sami Mujawar
From: Dongdong Zhang <zhangdongdong@eswincomputing.com>
Fix some typos in ArmPkg directory.
Cc: Leif Lindholm <quic_llindhol@quicinc.com>
Cc: Ard Biesheuvel <ardb+tianocore@kernel.org>
Cc: Sami Mujawar <sami.mujawar@arm.com>
Signed-off-by: Dongdong Zhang <zhangdongdong@eswincomputing.com>
---
ArmPkg/Drivers/ArmScmiDxe/ScmiDxe.c | 2 +-
ArmPkg/Library/ArmDisassemblerLib/ThumbDisassembler.c | 6 +++---
ArmPkg/Universal/Smbios/ProcessorSubClassDxe/SmbiosProcessorArmCommon.c | 2 +-
ArmPkg/Library/ArmLib/AArch64/ArmLibSupport.S | 2 +-
ArmPkg/Library/ArmLib/AArch64/ArmLibSupportV8.S | 2 +-
ArmPkg/Library/SemihostLib/Arm/GccSemihost.S | 2 +-
6 files changed, 8 insertions(+), 8 deletions(-)
diff --git a/ArmPkg/Drivers/ArmScmiDxe/ScmiDxe.c b/ArmPkg/Drivers/ArmScmiDxe/ScmiDxe.c
index 1fc448b9bfa6..a9cff0c395b8 100644
--- a/ArmPkg/Drivers/ArmScmiDxe/ScmiDxe.c
+++ b/ArmPkg/Drivers/ArmScmiDxe/ScmiDxe.c
@@ -40,7 +40,7 @@ STATIC CONST SCMI_PROTOCOL_ENTRY Protocols[] = {
install Base, Clock and Performance protocols.
@param[in] SystemTable A pointer to boot time system table.
- @retval EFI_SUCCESS Driver initalized successfully.
+ @retval EFI_SUCCESS Driver initialized successfully.
@retval EFI_UNSUPPORTED If SCMI base protocol version is not supported.
@retval !(EFI_SUCCESS) Other errors.
**/
diff --git a/ArmPkg/Library/ArmDisassemblerLib/ThumbDisassembler.c b/ArmPkg/Library/ArmDisassemblerLib/ThumbDisassembler.c
index dbd1f6c211ab..06df0b9096e6 100644
--- a/ArmPkg/Library/ArmDisassemblerLib/ThumbDisassembler.c
+++ b/ArmPkg/Library/ArmDisassemblerLib/ThumbDisassembler.c
@@ -663,9 +663,9 @@ DisassembleThumbInstruction (
// ITSTATE = cond:mask OpCode[7:4]:OpCode[3:0]
// ITSTATE[7:5] == cond[3:1]
// ITSTATE[4] == 1st Instruction cond[0]
- // ITSTATE[3] == 2st Instruction cond[0]
- // ITSTATE[2] == 3st Instruction cond[0]
- // ITSTATE[1] == 4st Instruction cond[0]
+ // ITSTATE[3] == 2nd Instruction cond[0]
+ // ITSTATE[2] == 3rd Instruction cond[0]
+ // ITSTATE[1] == 4th Instruction cond[0]
// ITSTATE[0] == 1 4 instruction IT block. 0 means 0,1,2 or 3 instructions
// 1st one in ITSTATE low bits defines the number of instructions
Mask = (OpCode & 0xf);
diff --git a/ArmPkg/Universal/Smbios/ProcessorSubClassDxe/SmbiosProcessorArmCommon.c b/ArmPkg/Universal/Smbios/ProcessorSubClassDxe/SmbiosProcessorArmCommon.c
index b961be213358..8d83f0723d10 100644
--- a/ArmPkg/Universal/Smbios/ProcessorSubClassDxe/SmbiosProcessorArmCommon.c
+++ b/ArmPkg/Universal/Smbios/ProcessorSubClassDxe/SmbiosProcessorArmCommon.c
@@ -79,7 +79,7 @@ SmbiosProcessorHasSeparateCaches (
return SeparateCaches;
}
-/** Checks if ther ARM64 SoC ID SMC call is supported
+/** Checks if the ARM64 SoC ID SMC call is supported
@return Whether the ARM64 SoC ID call is supported.
**/
diff --git a/ArmPkg/Library/ArmLib/AArch64/ArmLibSupport.S b/ArmPkg/Library/ArmLib/AArch64/ArmLibSupport.S
index ba0ec5682b86..c402154e4cc1 100644
--- a/ArmPkg/Library/ArmLib/AArch64/ArmLibSupport.S
+++ b/ArmPkg/Library/ArmLib/AArch64/ArmLibSupport.S
@@ -20,7 +20,7 @@ ASM_FUNC(ArmReadMidr)
ret
ASM_FUNC(ArmCacheInfo)
- mrs x0, ctr_el0 // Read from Cache Type Regiter (CTR)
+ mrs x0, ctr_el0 // Read from Cache Type Register (CTR)
ret
ASM_FUNC(ArmGetInterruptState)
diff --git a/ArmPkg/Library/ArmLib/AArch64/ArmLibSupportV8.S b/ArmPkg/Library/ArmLib/AArch64/ArmLibSupportV8.S
index 0ae75e4cb9f9..6a64219f6779 100644
--- a/ArmPkg/Library/ArmLib/AArch64/ArmLibSupportV8.S
+++ b/ArmPkg/Library/ArmLib/AArch64/ArmLibSupportV8.S
@@ -23,7 +23,7 @@
ASM_FUNC(ArmIsMpCore)
- mrs x0, mpidr_el1 // Read EL1 Multiprocessor Affinty Reg (MPIDR)
+ mrs x0, mpidr_el1 // Read EL1 Multiprocessor Affinity Reg (MPIDR)
and x0, x0, #MPIDR_U_MASK // U Bit clear, the processor is part of a multiprocessor system
lsr x0, x0, #MPIDR_U_BIT
eor x0, x0, #1
diff --git a/ArmPkg/Library/SemihostLib/Arm/GccSemihost.S b/ArmPkg/Library/SemihostLib/Arm/GccSemihost.S
index d6f81ec2c957..b1992b605f89 100644
--- a/ArmPkg/Library/SemihostLib/Arm/GccSemihost.S
+++ b/ArmPkg/Library/SemihostLib/Arm/GccSemihost.S
@@ -16,7 +16,7 @@
BKPT 0xAB for ARMv7-M (Thumb-2 only)
R0 - operation type
- R1 - block containing all other parametes
+ R1 - block containing all other parameters
lr - must be saved as svc instruction will cause an svc exception and write
the svc lr register. That happens to be the one we are using, so we must
--
2.28.0.windows.1
^ permalink raw reply related [flat|nested] 36+ messages in thread* [PATCH v3 10/14] ArmPlatformPkg: Fix typos
2022-12-14 22:52 [PATCH v3 00/14] Fix new typos reported Michael Kubacki
` (8 preceding siblings ...)
2022-12-14 22:52 ` [PATCH v3 09/14] ArmPkg: Fix typos Michael Kubacki
@ 2022-12-14 22:52 ` Michael Kubacki
2022-12-14 22:52 ` [PATCH v3 11/14] ArmVirtPkg: " Michael Kubacki
` (4 subsequent siblings)
14 siblings, 0 replies; 36+ messages in thread
From: Michael Kubacki @ 2022-12-14 22:52 UTC (permalink / raw)
To: devel; +Cc: Leif Lindholm, Ard Biesheuvel
From: Dongdong Zhang <zhangdongdong@eswincomputing.com>
Fix some typos in ArmPlatformPkg directory.
Cc: Leif Lindholm <quic_llindhol@quicinc.com>
Cc: Ard Biesheuvel <ardb+tianocore@kernel.org>
Signed-off-by: Dongdong Zhang <zhangdongdong@eswincomputing.com>
---
ArmPlatformPkg/Library/ArmMaliDp/ArmMaliDp.c | 2 +-
ArmPlatformPkg/Library/PL111Lcd/PL111Lcd.c | 6 +++---
ArmPlatformPkg/ArmPlatformPkg.dec | 2 +-
ArmPlatformPkg/Include/Library/LcdPlatformLib.h | 2 +-
4 files changed, 6 insertions(+), 6 deletions(-)
diff --git a/ArmPlatformPkg/Library/ArmMaliDp/ArmMaliDp.c b/ArmPlatformPkg/Library/ArmMaliDp/ArmMaliDp.c
index d01c910f6edf..cea7ce2cc789 100644
--- a/ArmPlatformPkg/Library/ArmMaliDp/ArmMaliDp.c
+++ b/ArmPlatformPkg/Library/ArmMaliDp/ArmMaliDp.c
@@ -287,7 +287,7 @@ LcdInitialize (
return EFI_SUCCESS;
}
-/** Set ARM Mali DP in cofiguration mode.
+/** Set ARM Mali DP in configuration mode.
The ARM Mali DP must be in the configuration mode for
configuration of the H_INTERVALS, V_INTERVALS, SYNC_CONTROL
diff --git a/ArmPlatformPkg/Library/PL111Lcd/PL111Lcd.c b/ArmPlatformPkg/Library/PL111Lcd/PL111Lcd.c
index 07f9b0f6beb1..b0b0cd8a85c0 100644
--- a/ArmPlatformPkg/Library/PL111Lcd/PL111Lcd.c
+++ b/ArmPlatformPkg/Library/PL111Lcd/PL111Lcd.c
@@ -19,7 +19,7 @@
@retval EFI_SUCCESS Returns success if platform implements a
PL111 controller.
- @retval EFI_NOT_FOUND PL111 display controller not found the plaform.
+ @retval EFI_NOT_FOUND PL111 display controller not found the platform.
**/
EFI_STATUS
LcdIdentify (
@@ -71,9 +71,9 @@ LcdInitialize (
/** Set requested mode of the display.
- @param[in] ModeNumbe Display mode number.
+ @param[in] ModeNumber Display mode number.
- @retval EFI_SUCCESS Display mode set successfuly.
+ @retval EFI_SUCCESS Display mode set successfully.
@retval !(EFI_SUCCESS) Other errors.
**/
EFI_STATUS
diff --git a/ArmPlatformPkg/ArmPlatformPkg.dec b/ArmPlatformPkg/ArmPlatformPkg.dec
index 7b5d7e6cb520..c905f97d2c78 100644
--- a/ArmPlatformPkg/ArmPlatformPkg.dec
+++ b/ArmPlatformPkg/ArmPlatformPkg.dec
@@ -97,7 +97,7 @@ [PcdsFixedAtBuild.common]
gArmPlatformTokenSpaceGuid.PcdPL111LcdBase|0x0|UINT32|0x00000026
gArmPlatformTokenSpaceGuid.PcdArmHdLcdBase|0x0|UINT32|0x00000027
- ## Default size for display modes upto 1920x1080 (1920 * 1080 * 4 Bytes Per Pixel)
+ ## Default size for display modes up to 1920x1080 (1920 * 1080 * 4 Bytes Per Pixel)
gArmPlatformTokenSpaceGuid.PcdArmLcdDdrFrameBufferSize|0x7E9000|UINT32|0x00000043
## If set, framebuffer memory will be reserved and mapped in the system RAM
gArmPlatformTokenSpaceGuid.PcdArmLcdDdrFrameBufferBase|0x0|UINT64|0x00000044
diff --git a/ArmPlatformPkg/Include/Library/LcdPlatformLib.h b/ArmPlatformPkg/Include/Library/LcdPlatformLib.h
index b5628ece56d9..2049e5ef6012 100644
--- a/ArmPlatformPkg/Include/Library/LcdPlatformLib.h
+++ b/ArmPlatformPkg/Include/Library/LcdPlatformLib.h
@@ -220,7 +220,7 @@ typedef struct {
@param[in] Handle Handle to the LCD device instance.
- @retval EFI_SUCCESS Plaform library initialized successfully.
+ @retval EFI_SUCCESS Platform library initialized successfully.
@retval !(EFI_SUCCESS) Other errors.
**/
EFI_STATUS
--
2.28.0.windows.1
^ permalink raw reply related [flat|nested] 36+ messages in thread* [PATCH v3 11/14] ArmVirtPkg: Fix typos
2022-12-14 22:52 [PATCH v3 00/14] Fix new typos reported Michael Kubacki
` (9 preceding siblings ...)
2022-12-14 22:52 ` [PATCH v3 10/14] ArmPlatformPkg: " Michael Kubacki
@ 2022-12-14 22:52 ` Michael Kubacki
2022-12-14 22:52 ` [PATCH v3 12/14] .azurepipelines: Update cspell version to 5.21.0 Michael Kubacki
` (3 subsequent siblings)
14 siblings, 0 replies; 36+ messages in thread
From: Michael Kubacki @ 2022-12-14 22:52 UTC (permalink / raw)
To: devel; +Cc: Ard Biesheuvel, Leif Lindholm, Sami Mujawar, Gerd Hoffmann
From: Dongdong Zhang <zhangdongdong@eswincomputing.com>
Fix some typos in ArmVirtPkg directory.
Cc: Ard Biesheuvel <ardb+tianocore@kernel.org>
Cc: Leif Lindholm <quic_llindhol@quicinc.com>
Cc: Sami Mujawar <sami.mujawar@arm.com>
Cc: Gerd Hoffmann <kraxel@redhat.com>
Signed-off-by: Dongdong Zhang <zhangdongdong@eswincomputing.com>
---
ArmVirtPkg/Library/CloudHvVirtMemInfoLib/CloudHvVirtMemInfoLib.c | 2 +-
ArmVirtPkg/Library/QemuVirtMemInfoLib/QemuVirtMemInfoLib.c | 2 +-
ArmVirtPkg/ArmVirt.dsc.inc | 2 +-
3 files changed, 3 insertions(+), 3 deletions(-)
diff --git a/ArmVirtPkg/Library/CloudHvVirtMemInfoLib/CloudHvVirtMemInfoLib.c b/ArmVirtPkg/Library/CloudHvVirtMemInfoLib/CloudHvVirtMemInfoLib.c
index 28a0c0b0785f..107ebbf3cd98 100644
--- a/ArmVirtPkg/Library/CloudHvVirtMemInfoLib/CloudHvVirtMemInfoLib.c
+++ b/ArmVirtPkg/Library/CloudHvVirtMemInfoLib/CloudHvVirtMemInfoLib.c
@@ -103,7 +103,7 @@ CloudHvVirtMemInfoPeiLibConstructor (
CurBase + CurSize - 1
));
- // We should build Hob seperately for the memory node except the first one
+ // We should build Hob separately for the memory node except the first one
if (CurBase != MemBase) {
BuildResourceDescriptorHob (
EFI_RESOURCE_SYSTEM_MEMORY,
diff --git a/ArmVirtPkg/Library/QemuVirtMemInfoLib/QemuVirtMemInfoLib.c b/ArmVirtPkg/Library/QemuVirtMemInfoLib/QemuVirtMemInfoLib.c
index 9cf43f06c073..464e7a6d0464 100644
--- a/ArmVirtPkg/Library/QemuVirtMemInfoLib/QemuVirtMemInfoLib.c
+++ b/ArmVirtPkg/Library/QemuVirtMemInfoLib/QemuVirtMemInfoLib.c
@@ -27,7 +27,7 @@
#define MACH_VIRT_PERIPH_SIZE SIZE_128MB
/**
- Default library constructur that obtains the memory size from a PCD.
+ Default library constructor that obtains the memory size from a PCD.
@return Always returns RETURN_SUCCESS
diff --git a/ArmVirtPkg/ArmVirt.dsc.inc b/ArmVirtPkg/ArmVirt.dsc.inc
index 462073517a22..f1aa51c89640 100644
--- a/ArmVirtPkg/ArmVirt.dsc.inc
+++ b/ArmVirtPkg/ArmVirt.dsc.inc
@@ -93,7 +93,7 @@ [LibraryClasses.common]
#
# It is not possible to prevent the ARM compiler from inserting calls to intrinsic functions.
- # This library provides the instrinsic functions such a compiler may generate calls to.
+ # This library provides the intrinsic functions such a compiler may generate calls to.
#
NULL|ArmPkg/Library/CompilerIntrinsicsLib/CompilerIntrinsicsLib.inf
--
2.28.0.windows.1
^ permalink raw reply related [flat|nested] 36+ messages in thread* [PATCH v3 12/14] .azurepipelines: Update cspell version to 5.21.0
2022-12-14 22:52 [PATCH v3 00/14] Fix new typos reported Michael Kubacki
` (10 preceding siblings ...)
2022-12-14 22:52 ` [PATCH v3 11/14] ArmVirtPkg: " Michael Kubacki
@ 2022-12-14 22:52 ` Michael Kubacki
2022-12-14 23:06 ` [edk2-devel] " Michael D Kinney
2022-12-14 22:52 ` [PATCH v3 13/14] ArmPkg: Turn off spellcheck audit mode Michael Kubacki
` (2 subsequent siblings)
14 siblings, 1 reply; 36+ messages in thread
From: Michael Kubacki @ 2022-12-14 22:52 UTC (permalink / raw)
To: devel; +Cc: Sean Brogan, Michael D Kinney, Liming Gao
From: Michael Kubacki <michael.kubacki@microsoft.com>
- Updates node from 14.x to 19.x to keep current.
- Updates the cspell module used in CI from 5.20.0 to 5.21.0.
Cc: Sean Brogan <sean.brogan@microsoft.com>
Cc: Michael D Kinney <michael.d.kinney@intel.com>
Cc: Liming Gao <gaoliming@byosoft.com.cn>
Signed-off-by: Michael Kubacki <michael.kubacki@microsoft.com>
---
.azurepipelines/templates/spell-check-prereq-steps.yml | 4 ++--
1 file changed, 2 insertions(+), 2 deletions(-)
diff --git a/.azurepipelines/templates/spell-check-prereq-steps.yml b/.azurepipelines/templates/spell-check-prereq-steps.yml
index 226909d54c4e..f219cc529a92 100644
--- a/.azurepipelines/templates/spell-check-prereq-steps.yml
+++ b/.azurepipelines/templates/spell-check-prereq-steps.yml
@@ -13,10 +13,10 @@ parameters:
steps:
- task: NodeTool@0
inputs:
- versionSpec: '14.x'
+ versionSpec: '19.x'
#checkLatest: false # Optional
condition: and(gt(variables.pkg_count, 0), succeeded())
-- script: npm install -g cspell@5.20.0
+- script: npm install -g cspell@5.21.0
displayName: 'Install cspell npm'
condition: and(gt(variables.pkg_count, 0), succeeded())
--
2.28.0.windows.1
^ permalink raw reply related [flat|nested] 36+ messages in thread* Re: [edk2-devel] [PATCH v3 12/14] .azurepipelines: Update cspell version to 5.21.0
2022-12-14 22:52 ` [PATCH v3 12/14] .azurepipelines: Update cspell version to 5.21.0 Michael Kubacki
@ 2022-12-14 23:06 ` Michael D Kinney
0 siblings, 0 replies; 36+ messages in thread
From: Michael D Kinney @ 2022-12-14 23:06 UTC (permalink / raw)
To: devel@edk2.groups.io, mikuback@linux.microsoft.com,
Kinney, Michael D
Cc: Sean Brogan, Gao, Liming
Reviewed-by: Michael D Kinney <michael.d.kinney@intel.com>
> -----Original Message-----
> From: devel@edk2.groups.io <devel@edk2.groups.io> On Behalf Of Michael Kubacki
> Sent: Wednesday, December 14, 2022 2:53 PM
> To: devel@edk2.groups.io
> Cc: Sean Brogan <sean.brogan@microsoft.com>; Kinney, Michael D <michael.d.kinney@intel.com>; Gao, Liming
> <gaoliming@byosoft.com.cn>
> Subject: [edk2-devel] [PATCH v3 12/14] .azurepipelines: Update cspell version to 5.21.0
>
> From: Michael Kubacki <michael.kubacki@microsoft.com>
>
> - Updates node from 14.x to 19.x to keep current.
> - Updates the cspell module used in CI from 5.20.0 to 5.21.0.
>
> Cc: Sean Brogan <sean.brogan@microsoft.com>
> Cc: Michael D Kinney <michael.d.kinney@intel.com>
> Cc: Liming Gao <gaoliming@byosoft.com.cn>
> Signed-off-by: Michael Kubacki <michael.kubacki@microsoft.com>
> ---
> .azurepipelines/templates/spell-check-prereq-steps.yml | 4 ++--
> 1 file changed, 2 insertions(+), 2 deletions(-)
>
> diff --git a/.azurepipelines/templates/spell-check-prereq-steps.yml b/.azurepipelines/templates/spell-check-prereq-
> steps.yml
> index 226909d54c4e..f219cc529a92 100644
> --- a/.azurepipelines/templates/spell-check-prereq-steps.yml
> +++ b/.azurepipelines/templates/spell-check-prereq-steps.yml
> @@ -13,10 +13,10 @@ parameters:
> steps:
> - task: NodeTool@0
> inputs:
> - versionSpec: '14.x'
> + versionSpec: '19.x'
> #checkLatest: false # Optional
> condition: and(gt(variables.pkg_count, 0), succeeded())
>
> -- script: npm install -g cspell@5.20.0
> +- script: npm install -g cspell@5.21.0
> displayName: 'Install cspell npm'
> condition: and(gt(variables.pkg_count, 0), succeeded())
> --
> 2.28.0.windows.1
>
>
>
> -=-=-=-=-=-=
> Groups.io Links: You receive all messages sent to this group.
> View/Reply Online (#97393): https://edk2.groups.io/g/devel/message/97393
> Mute This Topic: https://groups.io/mt/95678217/1643496
> Group Owner: devel+owner@edk2.groups.io
> Unsubscribe: https://edk2.groups.io/g/devel/unsub [michael.d.kinney@intel.com]
> -=-=-=-=-=-=
>
^ permalink raw reply [flat|nested] 36+ messages in thread
* [PATCH v3 13/14] ArmPkg: Turn off spellcheck audit mode
2022-12-14 22:52 [PATCH v3 00/14] Fix new typos reported Michael Kubacki
` (11 preceding siblings ...)
2022-12-14 22:52 ` [PATCH v3 12/14] .azurepipelines: Update cspell version to 5.21.0 Michael Kubacki
@ 2022-12-14 22:52 ` Michael Kubacki
2022-12-14 23:07 ` Ard Biesheuvel
2022-12-14 22:52 ` [PATCH v3 14/14] ArmVirtPkg: " Michael Kubacki
2022-12-15 16:40 ` [PATCH v3 00/14] Fix new typos reported Michael Kubacki
14 siblings, 1 reply; 36+ messages in thread
From: Michael Kubacki @ 2022-12-14 22:52 UTC (permalink / raw)
To: devel; +Cc: Leif Lindholm, Ard Biesheuvel, Sami Mujawar
From: Michael Kubacki <michael.kubacki@microsoft.com>
Audit mode was enabled for the spellcheck CI plugin. It is no longer
needed with recent changes. Spelling errors can be checked in the
package moving forward.
Cc: Leif Lindholm <quic_llindhol@quicinc.com>
Cc: Ard Biesheuvel <ardb+tianocore@kernel.org>
Cc: Sami Mujawar <sami.mujawar@arm.com>
Signed-off-by: Michael Kubacki <michael.kubacki@microsoft.com>
---
ArmPkg/ArmPkg.ci.yaml | 3 ++-
1 file changed, 2 insertions(+), 1 deletion(-)
diff --git a/ArmPkg/ArmPkg.ci.yaml b/ArmPkg/ArmPkg.ci.yaml
index c8dface6821a..a304c7966cf7 100644
--- a/ArmPkg/ArmPkg.ci.yaml
+++ b/ArmPkg/ArmPkg.ci.yaml
@@ -87,7 +87,7 @@
## options defined .pytool/Plugin/SpellCheck
"SpellCheck": {
- "AuditOnly": True,
+ "AuditOnly": False,
"IgnoreFiles": [
"Library/ArmSoftFloatLib/berkeley-softfloat-3/**"
], # use gitignore syntax to ignore errors
@@ -148,6 +148,7 @@
"fcmplt",
"ffreestanding",
"frsub",
+ "hauser",
"hisilicon",
"iccabpr",
"iccbpr",
--
2.28.0.windows.1
^ permalink raw reply related [flat|nested] 36+ messages in thread* Re: [PATCH v3 13/14] ArmPkg: Turn off spellcheck audit mode
2022-12-14 22:52 ` [PATCH v3 13/14] ArmPkg: Turn off spellcheck audit mode Michael Kubacki
@ 2022-12-14 23:07 ` Ard Biesheuvel
2022-12-14 23:21 ` Michael Kubacki
0 siblings, 1 reply; 36+ messages in thread
From: Ard Biesheuvel @ 2022-12-14 23:07 UTC (permalink / raw)
To: mikuback; +Cc: devel, Leif Lindholm, Ard Biesheuvel, Sami Mujawar
On Wed, 14 Dec 2022 at 23:53, <mikuback@linux.microsoft.com> wrote:
>
> From: Michael Kubacki <michael.kubacki@microsoft.com>
>
> Audit mode was enabled for the spellcheck CI plugin. It is no longer
> needed with recent changes. Spelling errors can be checked in the
> package moving forward.
>
> Cc: Leif Lindholm <quic_llindhol@quicinc.com>
> Cc: Ard Biesheuvel <ardb+tianocore@kernel.org>
> Cc: Sami Mujawar <sami.mujawar@arm.com>
> Signed-off-by: Michael Kubacki <michael.kubacki@microsoft.com>
Will this patch result in PRs potentially being rejected by pre-merge
CI due to trivial spelling errors?
> ---
> ArmPkg/ArmPkg.ci.yaml | 3 ++-
> 1 file changed, 2 insertions(+), 1 deletion(-)
>
> diff --git a/ArmPkg/ArmPkg.ci.yaml b/ArmPkg/ArmPkg.ci.yaml
> index c8dface6821a..a304c7966cf7 100644
> --- a/ArmPkg/ArmPkg.ci.yaml
> +++ b/ArmPkg/ArmPkg.ci.yaml
> @@ -87,7 +87,7 @@
>
> ## options defined .pytool/Plugin/SpellCheck
> "SpellCheck": {
> - "AuditOnly": True,
> + "AuditOnly": False,
> "IgnoreFiles": [
> "Library/ArmSoftFloatLib/berkeley-softfloat-3/**"
> ], # use gitignore syntax to ignore errors
> @@ -148,6 +148,7 @@
> "fcmplt",
> "ffreestanding",
> "frsub",
> + "hauser",
> "hisilicon",
> "iccabpr",
> "iccbpr",
> --
> 2.28.0.windows.1
>
^ permalink raw reply [flat|nested] 36+ messages in thread* Re: [PATCH v3 13/14] ArmPkg: Turn off spellcheck audit mode
2022-12-14 23:07 ` Ard Biesheuvel
@ 2022-12-14 23:21 ` Michael Kubacki
2022-12-14 23:24 ` Ard Biesheuvel
0 siblings, 1 reply; 36+ messages in thread
From: Michael Kubacki @ 2022-12-14 23:21 UTC (permalink / raw)
To: Ard Biesheuvel; +Cc: devel, Leif Lindholm, Ard Biesheuvel, Sami Mujawar
Yes. It will also reduce frequency of incoming patches that must be
reviewed and merged due to people continuously fixing trivial spelling
errors.
On 12/14/2022 6:07 PM, Ard Biesheuvel wrote:
> On Wed, 14 Dec 2022 at 23:53, <mikuback@linux.microsoft.com> wrote:
>>
>> From: Michael Kubacki <michael.kubacki@microsoft.com>
>>
>> Audit mode was enabled for the spellcheck CI plugin. It is no longer
>> needed with recent changes. Spelling errors can be checked in the
>> package moving forward.
>>
>> Cc: Leif Lindholm <quic_llindhol@quicinc.com>
>> Cc: Ard Biesheuvel <ardb+tianocore@kernel.org>
>> Cc: Sami Mujawar <sami.mujawar@arm.com>
>> Signed-off-by: Michael Kubacki <michael.kubacki@microsoft.com>
>
> Will this patch result in PRs potentially being rejected by pre-merge
> CI due to trivial spelling errors?
>
>
>> ---
>> ArmPkg/ArmPkg.ci.yaml | 3 ++-
>> 1 file changed, 2 insertions(+), 1 deletion(-)
>>
>> diff --git a/ArmPkg/ArmPkg.ci.yaml b/ArmPkg/ArmPkg.ci.yaml
>> index c8dface6821a..a304c7966cf7 100644
>> --- a/ArmPkg/ArmPkg.ci.yaml
>> +++ b/ArmPkg/ArmPkg.ci.yaml
>> @@ -87,7 +87,7 @@
>>
>> ## options defined .pytool/Plugin/SpellCheck
>> "SpellCheck": {
>> - "AuditOnly": True,
>> + "AuditOnly": False,
>> "IgnoreFiles": [
>> "Library/ArmSoftFloatLib/berkeley-softfloat-3/**"
>> ], # use gitignore syntax to ignore errors
>> @@ -148,6 +148,7 @@
>> "fcmplt",
>> "ffreestanding",
>> "frsub",
>> + "hauser",
>> "hisilicon",
>> "iccabpr",
>> "iccbpr",
>> --
>> 2.28.0.windows.1
>>
^ permalink raw reply [flat|nested] 36+ messages in thread* Re: [PATCH v3 13/14] ArmPkg: Turn off spellcheck audit mode
2022-12-14 23:21 ` Michael Kubacki
@ 2022-12-14 23:24 ` Ard Biesheuvel
2022-12-15 0:04 ` [edk2-devel] " Michael Kubacki
0 siblings, 1 reply; 36+ messages in thread
From: Ard Biesheuvel @ 2022-12-14 23:24 UTC (permalink / raw)
To: Michael Kubacki; +Cc: devel, Leif Lindholm, Ard Biesheuvel, Sami Mujawar
On Thu, 15 Dec 2022 at 00:21, Michael Kubacki
<mikuback@linux.microsoft.com> wrote:
>
> Yes. It will also reduce frequency of incoming patches that must be
> reviewed and merged due to people continuously fixing trivial spelling
> errors.
>
In that case, NAK to this patch (and the ArmVirtPkg one). Unless we
add a button to the GitHub UI that permits me to override a negative
CI result on a PR.
> On 12/14/2022 6:07 PM, Ard Biesheuvel wrote:
> > On Wed, 14 Dec 2022 at 23:53, <mikuback@linux.microsoft.com> wrote:
> >>
> >> From: Michael Kubacki <michael.kubacki@microsoft.com>
> >>
> >> Audit mode was enabled for the spellcheck CI plugin. It is no longer
> >> needed with recent changes. Spelling errors can be checked in the
> >> package moving forward.
> >>
> >> Cc: Leif Lindholm <quic_llindhol@quicinc.com>
> >> Cc: Ard Biesheuvel <ardb+tianocore@kernel.org>
> >> Cc: Sami Mujawar <sami.mujawar@arm.com>
> >> Signed-off-by: Michael Kubacki <michael.kubacki@microsoft.com>
> >
> > Will this patch result in PRs potentially being rejected by pre-merge
> > CI due to trivial spelling errors?
> >
> >
> >> ---
> >> ArmPkg/ArmPkg.ci.yaml | 3 ++-
> >> 1 file changed, 2 insertions(+), 1 deletion(-)
> >>
> >> diff --git a/ArmPkg/ArmPkg.ci.yaml b/ArmPkg/ArmPkg.ci.yaml
> >> index c8dface6821a..a304c7966cf7 100644
> >> --- a/ArmPkg/ArmPkg.ci.yaml
> >> +++ b/ArmPkg/ArmPkg.ci.yaml
> >> @@ -87,7 +87,7 @@
> >>
> >> ## options defined .pytool/Plugin/SpellCheck
> >> "SpellCheck": {
> >> - "AuditOnly": True,
> >> + "AuditOnly": False,
> >> "IgnoreFiles": [
> >> "Library/ArmSoftFloatLib/berkeley-softfloat-3/**"
> >> ], # use gitignore syntax to ignore errors
> >> @@ -148,6 +148,7 @@
> >> "fcmplt",
> >> "ffreestanding",
> >> "frsub",
> >> + "hauser",
> >> "hisilicon",
> >> "iccabpr",
> >> "iccbpr",
> >> --
> >> 2.28.0.windows.1
> >>
^ permalink raw reply [flat|nested] 36+ messages in thread* Re: [edk2-devel] [PATCH v3 13/14] ArmPkg: Turn off spellcheck audit mode
2022-12-14 23:24 ` Ard Biesheuvel
@ 2022-12-15 0:04 ` Michael Kubacki
2022-12-15 8:46 ` Ard Biesheuvel
2022-12-15 10:42 ` Leif Lindholm
0 siblings, 2 replies; 36+ messages in thread
From: Michael Kubacki @ 2022-12-15 0:04 UTC (permalink / raw)
To: devel, ardb
Cc: Leif Lindholm, Ard Biesheuvel, Sami Mujawar, Kinney, Michael D
I'm just trying to understand your position.
Are you saying you would rather people check in typos and then later
have patches come into the package to fix them?
For example, like these:
- ArmVirtPkg: https://edk2.groups.io/g/devel/message/97021
- ArmPkg: https://edk2.groups.io/g/devel/message/97022
Why not just have the code checked in without typos in the first place?
Checking in typos creates more review work, makes the code history have
typo fix patches that could be avoided, and impacts accessibility.
I spend far more time with edk2 overhead such as email formatting
problems, keeping track of maintainer email address changes when
updating patches, mapping email replies back to code, and so on that
does not improve the code. A spell checker only takes seconds and is
built into edk2 CI.
On 12/14/2022 6:24 PM, Ard Biesheuvel wrote:
> On Thu, 15 Dec 2022 at 00:21, Michael Kubacki
> <mikuback@linux.microsoft.com> wrote:
>>
>> Yes. It will also reduce frequency of incoming patches that must be
>> reviewed and merged due to people continuously fixing trivial spelling
>> errors.
>>
>
> In that case, NAK to this patch (and the ArmVirtPkg one). Unless we
> add a button to the GitHub UI that permits me to override a negative
> CI result on a PR.
>
>> On 12/14/2022 6:07 PM, Ard Biesheuvel wrote:
>>> On Wed, 14 Dec 2022 at 23:53, <mikuback@linux.microsoft.com> wrote:
>>>>
>>>> From: Michael Kubacki <michael.kubacki@microsoft.com>
>>>>
>>>> Audit mode was enabled for the spellcheck CI plugin. It is no longer
>>>> needed with recent changes. Spelling errors can be checked in the
>>>> package moving forward.
>>>>
>>>> Cc: Leif Lindholm <quic_llindhol@quicinc.com>
>>>> Cc: Ard Biesheuvel <ardb+tianocore@kernel.org>
>>>> Cc: Sami Mujawar <sami.mujawar@arm.com>
>>>> Signed-off-by: Michael Kubacki <michael.kubacki@microsoft.com>
>>>
>>> Will this patch result in PRs potentially being rejected by pre-merge
>>> CI due to trivial spelling errors?
>>>
>>>
>>>> ---
>>>> ArmPkg/ArmPkg.ci.yaml | 3 ++-
>>>> 1 file changed, 2 insertions(+), 1 deletion(-)
>>>>
>>>> diff --git a/ArmPkg/ArmPkg.ci.yaml b/ArmPkg/ArmPkg.ci.yaml
>>>> index c8dface6821a..a304c7966cf7 100644
>>>> --- a/ArmPkg/ArmPkg.ci.yaml
>>>> +++ b/ArmPkg/ArmPkg.ci.yaml
>>>> @@ -87,7 +87,7 @@
>>>>
>>>> ## options defined .pytool/Plugin/SpellCheck
>>>> "SpellCheck": {
>>>> - "AuditOnly": True,
>>>> + "AuditOnly": False,
>>>> "IgnoreFiles": [
>>>> "Library/ArmSoftFloatLib/berkeley-softfloat-3/**"
>>>> ], # use gitignore syntax to ignore errors
>>>> @@ -148,6 +148,7 @@
>>>> "fcmplt",
>>>> "ffreestanding",
>>>> "frsub",
>>>> + "hauser",
>>>> "hisilicon",
>>>> "iccabpr",
>>>> "iccbpr",
>>>> --
>>>> 2.28.0.windows.1
>>>>
>
>
>
>
^ permalink raw reply [flat|nested] 36+ messages in thread* Re: [edk2-devel] [PATCH v3 13/14] ArmPkg: Turn off spellcheck audit mode
2022-12-15 0:04 ` [edk2-devel] " Michael Kubacki
@ 2022-12-15 8:46 ` Ard Biesheuvel
2022-12-15 10:42 ` Leif Lindholm
1 sibling, 0 replies; 36+ messages in thread
From: Ard Biesheuvel @ 2022-12-15 8:46 UTC (permalink / raw)
To: Michael Kubacki; +Cc: devel, Leif Lindholm, Sami Mujawar, Kinney, Michael D
On Thu, 15 Dec 2022 at 01:04, Michael Kubacki
<mikuback@linux.microsoft.com> wrote:
>
> I'm just trying to understand your position.
>
> Are you saying you would rather people check in typos and then later
> have patches come into the package to fix them?
>
> For example, like these:
>
> - ArmVirtPkg: https://edk2.groups.io/g/devel/message/97021
> - ArmPkg: https://edk2.groups.io/g/devel/message/97022
>
> Why not just have the code checked in without typos in the first place?
>
> Checking in typos creates more review work, makes the code history have
> typo fix patches that could be avoided, and impacts accessibility.
>
> I spend far more time with edk2 overhead such as email formatting
> problems, keeping track of maintainer email address changes when
> updating patches, mapping email replies back to code, and so on that
> does not improve the code. A spell checker only takes seconds and is
> built into edk2 CI.
>
SpellCheck cannot distinguish between typos and valid uses of non-english words.
ArmPkg is not made up of english prose, it is unidiomatic even for
EDK2 as its code contains many of the hundreds of mnemonics and
acronyms that are defined in the ARM Architecture Reference Manual.
With SpellCheck enabled, we need to extend the exception list every
time the use of such a word gets introduced into the code, which is
tedious and pointless, given that the exception list is already
hundreds of entries long, and you are even adding *known typos* to it.
Whether or not a patch passes SpellCheck is therefore becoming a poor
measure of quality. And fundamentally, given that the resulting object
code is identical, SpellCheck does not contribute *at all* to making
the code that actually gets shipped any better.
I do care about typos, and if this wasn't so disruptive to my normal
development process, I wouldn't object to it, but getting a simple PR
merged has already become a massive waste of time due to the rigid
uncrustify rules (which I am not as excited about either, tbh). So
rejecting PRs simply because some word does not appear in the list is
not acceptable to me.
Unless I get a button in the GitHub UI that permits me to force-merge
a PR if it failed the SpellCheck pass. Or adds it to the exception
list automatically.
I would also like to point out that all this focus on code aesthetics
that do not contribute to the object code at all is distracting from
things that would actually improve the safety and robustness of the
code. During my time at ARM, I implemented a prototype for IBT/BTI in
EFI, which -given how much EFI relies on function pointers and
indirect calls- would be a very useful thing to have, both on x86 and
arm64.
Unfortunately, this requires a PE/COFF spec change, so that .text
sections can be marked as having been built with brach-tracking
landing pads. At the time, we tried various contacts in Microsoft to
find the people that could help author such a change to the PE/COFF
spec, but I never got anywhere.
So if you are interested, and want to improve EDK2 at a level that
actually makes the shipping code more robust, we could collaborate on
this (PE spec change, UEFI spec change, EDK2 and Linux changes both
for x86 and arm64[0]) so that firmware runs with indirect branch
protection enabled when the hardware supports it.
[0] https://git.kernel.org/pub/scm/linux/kernel/git/ardb/linux.git/log/?h=efi-bti
^ permalink raw reply [flat|nested] 36+ messages in thread
* Re: [edk2-devel] [PATCH v3 13/14] ArmPkg: Turn off spellcheck audit mode
2022-12-15 0:04 ` [edk2-devel] " Michael Kubacki
2022-12-15 8:46 ` Ard Biesheuvel
@ 2022-12-15 10:42 ` Leif Lindholm
2022-12-15 16:38 ` Michael Kubacki
1 sibling, 1 reply; 36+ messages in thread
From: Leif Lindholm @ 2022-12-15 10:42 UTC (permalink / raw)
To: Michael Kubacki
Cc: devel, ardb, Ard Biesheuvel, Sami Mujawar, Kinney, Michael D
On Wed, Dec 14, 2022 at 19:04:06 -0500, Michael Kubacki wrote:
> I'm just trying to understand your position.
>
> Are you saying you would rather people check in typos and then later have
> patches come into the package to fix them?
>
> For example, like these:
>
> - ArmVirtPkg: https://edk2.groups.io/g/devel/message/97021
> - ArmPkg: https://edk2.groups.io/g/devel/message/97022
>
> Why not just have the code checked in without typos in the first place?
A little fairy once whispered in my ear that if I stopped myself and
tried to rephrase whenever I found myself using the work "just", I
would meet less friction in context-stripping communication mediums
such as email. They weren't wrong.
> Checking in typos creates more review work, makes the code history have typo
> fix patches that could be avoided, and impacts accessibility.
>
> I spend far more time with edk2 overhead such as email formatting problems,
> keeping track of maintainer email address changes when updating patches,
> mapping email replies back to code, and so on that does not improve the
> code. A spell checker only takes seconds and is built into edk2 CI.
We didn't disable the spellchecker for the ARM* packages (only)
because we hate correct spelling. We disabled it because it throws
false positives left right and centre. So we end up needing to update
the .ci.yaml every time we mention an architectural concept we haven't
mentioned before. Or add a copyright line mentioning a new
organisation. Or correctly use apostrophes in ways the spellchecker
doesn't expect.
Here is the current (and very incomplete, oh - and package specific)
exception list for ArmPkg:
https://github.com/tianocore/edk2/blob/master/ArmPkg/ArmPkg.ci.yaml#L95
If it had a aggressiveness knob and we could turn it down from 11 to
3 and work our way up from there, that would be another story.
Failing that, a push-through-anyway-this-isn't-a-typo label would be a
reasonable compromise.
But for now, I agree with Ard.
/
Leif
> On 12/14/2022 6:24 PM, Ard Biesheuvel wrote:
> > On Thu, 15 Dec 2022 at 00:21, Michael Kubacki
> > <mikuback@linux.microsoft.com> wrote:
> > >
> > > Yes. It will also reduce frequency of incoming patches that must be
> > > reviewed and merged due to people continuously fixing trivial spelling
> > > errors.
> > >
> >
> > In that case, NAK to this patch (and the ArmVirtPkg one). Unless we
> > add a button to the GitHub UI that permits me to override a negative
> > CI result on a PR.
> >
> > > On 12/14/2022 6:07 PM, Ard Biesheuvel wrote:
> > > > On Wed, 14 Dec 2022 at 23:53, <mikuback@linux.microsoft.com> wrote:
> > > > >
> > > > > From: Michael Kubacki <michael.kubacki@microsoft.com>
> > > > >
> > > > > Audit mode was enabled for the spellcheck CI plugin. It is no longer
> > > > > needed with recent changes. Spelling errors can be checked in the
> > > > > package moving forward.
> > > > >
> > > > > Cc: Leif Lindholm <quic_llindhol@quicinc.com>
> > > > > Cc: Ard Biesheuvel <ardb+tianocore@kernel.org>
> > > > > Cc: Sami Mujawar <sami.mujawar@arm.com>
> > > > > Signed-off-by: Michael Kubacki <michael.kubacki@microsoft.com>
> > > >
> > > > Will this patch result in PRs potentially being rejected by pre-merge
> > > > CI due to trivial spelling errors?
> > > >
> > > >
> > > > > ---
> > > > > ArmPkg/ArmPkg.ci.yaml | 3 ++-
> > > > > 1 file changed, 2 insertions(+), 1 deletion(-)
> > > > >
> > > > > diff --git a/ArmPkg/ArmPkg.ci.yaml b/ArmPkg/ArmPkg.ci.yaml
> > > > > index c8dface6821a..a304c7966cf7 100644
> > > > > --- a/ArmPkg/ArmPkg.ci.yaml
> > > > > +++ b/ArmPkg/ArmPkg.ci.yaml
> > > > > @@ -87,7 +87,7 @@
> > > > >
> > > > > ## options defined .pytool/Plugin/SpellCheck
> > > > > "SpellCheck": {
> > > > > - "AuditOnly": True,
> > > > > + "AuditOnly": False,
> > > > > "IgnoreFiles": [
> > > > > "Library/ArmSoftFloatLib/berkeley-softfloat-3/**"
> > > > > ], # use gitignore syntax to ignore errors
> > > > > @@ -148,6 +148,7 @@
> > > > > "fcmplt",
> > > > > "ffreestanding",
> > > > > "frsub",
> > > > > + "hauser",
> > > > > "hisilicon",
> > > > > "iccabpr",
> > > > > "iccbpr",
> > > > > --
> > > > > 2.28.0.windows.1
> > > > >
> >
> >
> >
> >
^ permalink raw reply [flat|nested] 36+ messages in thread* Re: [edk2-devel] [PATCH v3 13/14] ArmPkg: Turn off spellcheck audit mode
2022-12-15 10:42 ` Leif Lindholm
@ 2022-12-15 16:38 ` Michael Kubacki
2022-12-15 16:57 ` Michael D Kinney
2023-01-04 10:37 ` Ard Biesheuvel
0 siblings, 2 replies; 36+ messages in thread
From: Michael Kubacki @ 2022-12-15 16:38 UTC (permalink / raw)
To: devel, quic_llindhol
Cc: ardb, Ard Biesheuvel, Sami Mujawar, Kinney, Michael D
On 12/15/2022 5:42 AM, Leif Lindholm wrote:
> On Wed, Dec 14, 2022 at 19:04:06 -0500, Michael Kubacki wrote:
>> I'm just trying to understand your position.
>>
>> Are you saying you would rather people check in typos and then later have
>> patches come into the package to fix them?
>>
>> For example, like these:
>>
>> - ArmVirtPkg: https://edk2.groups.io/g/devel/message/97021
>> - ArmPkg: https://edk2.groups.io/g/devel/message/97022
>>
>> Why not just have the code checked in without typos in the first place?
>
> A little fairy once whispered in my ear that if I stopped myself and
> tried to rephrase whenever I found myself using the work "just", I
> would meet less friction in context-stripping communication mediums
> such as email. They weren't wrong.
>
This topic is met with friction regardless of how it is phrased.
The friction exists because the community chose to enable spell checking
in CI and it is not wanted here.
The mechanism chosen to ignore words was through YAML files rather than
a button. A common YAML file can store words for the whole project and
packages can add package-specific words. The community was expected to
make the contributions necessary in the common file to minimize impact
on package maintainers.
The spellcheck log outputs the exact code that needs to be copied/pasted
to the exception list - whether the global list or package list. If you
run CI locally, you can copy/paste the exact lines needed.
This is a patch series I work on in my spare time to try to improve the
project. I am tired of Ard's dismissive and passive aggressive responses
such as those in https://edk2.groups.io/g/devel/message/97433 so I
revoke the series and will let others decide what they want to do.
>> Checking in typos creates more review work, makes the code history have typo
>> fix patches that could be avoided, and impacts accessibility.
>>
>> I spend far more time with edk2 overhead such as email formatting problems,
>> keeping track of maintainer email address changes when updating patches,
>> mapping email replies back to code, and so on that does not improve the
>> code. A spell checker only takes seconds and is built into edk2 CI.
>
> We didn't disable the spellchecker for the ARM* packages (only)
> because we hate correct spelling. We disabled it because it throws
> false positives left right and centre. So we end up needing to update
> the .ci.yaml every time we mention an architectural concept we haven't
> mentioned before. Or add a copyright line mentioning a new
> organisation. Or correctly use apostrophes in ways the spellchecker
> doesn't expect.
>
> Here is the current (and very incomplete, oh - and package specific)
> exception list for ArmPkg:
>
> https://github.com/tianocore/edk2/blob/master/ArmPkg/ArmPkg.ci.yaml#L95
>
> If it had a aggressiveness knob and we could turn it down from 11 to
> 3 and work our way up from there, that would be another story.
>
> Failing that, a push-through-anyway-this-isn't-a-typo label would be a
> reasonable compromise.
>
> But for now, I agree with Ard.
>
> /
> Leif
>
>> On 12/14/2022 6:24 PM, Ard Biesheuvel wrote:
>>> On Thu, 15 Dec 2022 at 00:21, Michael Kubacki
>>> <mikuback@linux.microsoft.com> wrote:
>>>>
>>>> Yes. It will also reduce frequency of incoming patches that must be
>>>> reviewed and merged due to people continuously fixing trivial spelling
>>>> errors.
>>>>
>>>
>>> In that case, NAK to this patch (and the ArmVirtPkg one). Unless we
>>> add a button to the GitHub UI that permits me to override a negative
>>> CI result on a PR.
>>>
>>>> On 12/14/2022 6:07 PM, Ard Biesheuvel wrote:
>>>>> On Wed, 14 Dec 2022 at 23:53, <mikuback@linux.microsoft.com> wrote:
>>>>>>
>>>>>> From: Michael Kubacki <michael.kubacki@microsoft.com>
>>>>>>
>>>>>> Audit mode was enabled for the spellcheck CI plugin. It is no longer
>>>>>> needed with recent changes. Spelling errors can be checked in the
>>>>>> package moving forward.
>>>>>>
>>>>>> Cc: Leif Lindholm <quic_llindhol@quicinc.com>
>>>>>> Cc: Ard Biesheuvel <ardb+tianocore@kernel.org>
>>>>>> Cc: Sami Mujawar <sami.mujawar@arm.com>
>>>>>> Signed-off-by: Michael Kubacki <michael.kubacki@microsoft.com>
>>>>>
>>>>> Will this patch result in PRs potentially being rejected by pre-merge
>>>>> CI due to trivial spelling errors?
>>>>>
>>>>>
>>>>>> ---
>>>>>> ArmPkg/ArmPkg.ci.yaml | 3 ++-
>>>>>> 1 file changed, 2 insertions(+), 1 deletion(-)
>>>>>>
>>>>>> diff --git a/ArmPkg/ArmPkg.ci.yaml b/ArmPkg/ArmPkg.ci.yaml
>>>>>> index c8dface6821a..a304c7966cf7 100644
>>>>>> --- a/ArmPkg/ArmPkg.ci.yaml
>>>>>> +++ b/ArmPkg/ArmPkg.ci.yaml
>>>>>> @@ -87,7 +87,7 @@
>>>>>>
>>>>>> ## options defined .pytool/Plugin/SpellCheck
>>>>>> "SpellCheck": {
>>>>>> - "AuditOnly": True,
>>>>>> + "AuditOnly": False,
>>>>>> "IgnoreFiles": [
>>>>>> "Library/ArmSoftFloatLib/berkeley-softfloat-3/**"
>>>>>> ], # use gitignore syntax to ignore errors
>>>>>> @@ -148,6 +148,7 @@
>>>>>> "fcmplt",
>>>>>> "ffreestanding",
>>>>>> "frsub",
>>>>>> + "hauser",
>>>>>> "hisilicon",
>>>>>> "iccabpr",
>>>>>> "iccbpr",
>>>>>> --
>>>>>> 2.28.0.windows.1
>>>>>>
>>>
>>>
>>>
>>>
>
>
>
>
^ permalink raw reply [flat|nested] 36+ messages in thread* Re: [edk2-devel] [PATCH v3 13/14] ArmPkg: Turn off spellcheck audit mode
2022-12-15 16:38 ` Michael Kubacki
@ 2022-12-15 16:57 ` Michael D Kinney
2022-12-16 17:36 ` Michael Kubacki
2023-01-04 10:37 ` Ard Biesheuvel
1 sibling, 1 reply; 36+ messages in thread
From: Michael D Kinney @ 2022-12-15 16:57 UTC (permalink / raw)
To: devel@edk2.groups.io, mikuback@linux.microsoft.com,
quic_llindhol@quicinc.com, Kinney, Michael D
Cc: ardb@kernel.org, Ard Biesheuvel, Sami Mujawar
Michael,
I appreciate your efforts to improve code quality in all aspects.
I think this is the only part of the change that is being asked
to be adjusted (specifically for the ArmPkg and ArmVirtPkg) is
the following.
>>>>>> - "AuditOnly": True,
>>>>>> + "AuditOnly": False,
Different packages may choose different levels if quality or
quality checks based on the maturity of the package and what
is deemed critical to the package maintainers.
There are obvious checks such as compile failures that we can
all agree on. Checks that are not directly related to
functionality should perhaps be flexible and the policy be
allowed to be adjusted by the package maintainers.
I personally would prefer to see as many packages as possible
take advantage of the CI checks that have been enabled, so I
think it is good to start with an approach where everything is
on by default, and if a package maintainer would prefer a
specific package to have one disabled, then defer to that request.
I also think it would be good to add comments to the package
YAML file if a check is disabled that clearly states that
the choice to diverge from the standard CI checks was made
by the package maintainer.
With this approach, I think your series can go forward with
AuditOnly set to True for the ArmPkg and ArtVirtPkg with
comments that this setting is different than the default
due to requests from the maintainers.
Best regards,
Mike
> -----Original Message-----
> From: devel@edk2.groups.io <devel@edk2.groups.io> On Behalf Of Michael Kubacki
> Sent: Thursday, December 15, 2022 8:39 AM
> To: devel@edk2.groups.io; quic_llindhol@quicinc.com
> Cc: ardb@kernel.org; Ard Biesheuvel <ardb+tianocore@kernel.org>; Sami Mujawar <sami.mujawar@arm.com>; Kinney, Michael D
> <michael.d.kinney@intel.com>
> Subject: Re: [edk2-devel] [PATCH v3 13/14] ArmPkg: Turn off spellcheck audit mode
>
> On 12/15/2022 5:42 AM, Leif Lindholm wrote:
> > On Wed, Dec 14, 2022 at 19:04:06 -0500, Michael Kubacki wrote:
> >> I'm just trying to understand your position.
> >>
> >> Are you saying you would rather people check in typos and then later have
> >> patches come into the package to fix them?
> >>
> >> For example, like these:
> >>
> >> - ArmVirtPkg: https://edk2.groups.io/g/devel/message/97021
> >> - ArmPkg: https://edk2.groups.io/g/devel/message/97022
> >>
> >> Why not just have the code checked in without typos in the first place?
> >
> > A little fairy once whispered in my ear that if I stopped myself and
> > tried to rephrase whenever I found myself using the work "just", I
> > would meet less friction in context-stripping communication mediums
> > such as email. They weren't wrong.
> >
>
> This topic is met with friction regardless of how it is phrased.
>
> The friction exists because the community chose to enable spell checking
> in CI and it is not wanted here.
>
> The mechanism chosen to ignore words was through YAML files rather than
> a button. A common YAML file can store words for the whole project and
> packages can add package-specific words. The community was expected to
> make the contributions necessary in the common file to minimize impact
> on package maintainers.
>
> The spellcheck log outputs the exact code that needs to be copied/pasted
> to the exception list - whether the global list or package list. If you
> run CI locally, you can copy/paste the exact lines needed.
>
> This is a patch series I work on in my spare time to try to improve the
> project. I am tired of Ard's dismissive and passive aggressive responses
> such as those in https://edk2.groups.io/g/devel/message/97433 so I
> revoke the series and will let others decide what they want to do.
>
> >> Checking in typos creates more review work, makes the code history have typo
> >> fix patches that could be avoided, and impacts accessibility.
> >>
> >> I spend far more time with edk2 overhead such as email formatting problems,
> >> keeping track of maintainer email address changes when updating patches,
> >> mapping email replies back to code, and so on that does not improve the
> >> code. A spell checker only takes seconds and is built into edk2 CI.
> >
> > We didn't disable the spellchecker for the ARM* packages (only)
> > because we hate correct spelling. We disabled it because it throws
> > false positives left right and centre. So we end up needing to update
> > the .ci.yaml every time we mention an architectural concept we haven't
> > mentioned before. Or add a copyright line mentioning a new
> > organisation. Or correctly use apostrophes in ways the spellchecker
> > doesn't expect.
> >
> > Here is the current (and very incomplete, oh - and package specific)
> > exception list for ArmPkg:
> >
> > https://github.com/tianocore/edk2/blob/master/ArmPkg/ArmPkg.ci.yaml#L95
> >
> > If it had a aggressiveness knob and we could turn it down from 11 to
> > 3 and work our way up from there, that would be another story.
> >
> > Failing that, a push-through-anyway-this-isn't-a-typo label would be a
> > reasonable compromise.
> >
> > But for now, I agree with Ard.
> >
> > /
> > Leif
> >
> >> On 12/14/2022 6:24 PM, Ard Biesheuvel wrote:
> >>> On Thu, 15 Dec 2022 at 00:21, Michael Kubacki
> >>> <mikuback@linux.microsoft.com> wrote:
> >>>>
> >>>> Yes. It will also reduce frequency of incoming patches that must be
> >>>> reviewed and merged due to people continuously fixing trivial spelling
> >>>> errors.
> >>>>
> >>>
> >>> In that case, NAK to this patch (and the ArmVirtPkg one). Unless we
> >>> add a button to the GitHub UI that permits me to override a negative
> >>> CI result on a PR.
> >>>
> >>>> On 12/14/2022 6:07 PM, Ard Biesheuvel wrote:
> >>>>> On Wed, 14 Dec 2022 at 23:53, <mikuback@linux.microsoft.com> wrote:
> >>>>>>
> >>>>>> From: Michael Kubacki <michael.kubacki@microsoft.com>
> >>>>>>
> >>>>>> Audit mode was enabled for the spellcheck CI plugin. It is no longer
> >>>>>> needed with recent changes. Spelling errors can be checked in the
> >>>>>> package moving forward.
> >>>>>>
> >>>>>> Cc: Leif Lindholm <quic_llindhol@quicinc.com>
> >>>>>> Cc: Ard Biesheuvel <ardb+tianocore@kernel.org>
> >>>>>> Cc: Sami Mujawar <sami.mujawar@arm.com>
> >>>>>> Signed-off-by: Michael Kubacki <michael.kubacki@microsoft.com>
> >>>>>
> >>>>> Will this patch result in PRs potentially being rejected by pre-merge
> >>>>> CI due to trivial spelling errors?
> >>>>>
> >>>>>
> >>>>>> ---
> >>>>>> ArmPkg/ArmPkg.ci.yaml | 3 ++-
> >>>>>> 1 file changed, 2 insertions(+), 1 deletion(-)
> >>>>>>
> >>>>>> diff --git a/ArmPkg/ArmPkg.ci.yaml b/ArmPkg/ArmPkg.ci.yaml
> >>>>>> index c8dface6821a..a304c7966cf7 100644
> >>>>>> --- a/ArmPkg/ArmPkg.ci.yaml
> >>>>>> +++ b/ArmPkg/ArmPkg.ci.yaml
> >>>>>> @@ -87,7 +87,7 @@
> >>>>>>
> >>>>>> ## options defined .pytool/Plugin/SpellCheck
> >>>>>> "SpellCheck": {
> >>>>>> - "AuditOnly": True,
> >>>>>> + "AuditOnly": False,
> >>>>>> "IgnoreFiles": [
> >>>>>> "Library/ArmSoftFloatLib/berkeley-softfloat-3/**"
> >>>>>> ], # use gitignore syntax to ignore errors
> >>>>>> @@ -148,6 +148,7 @@
> >>>>>> "fcmplt",
> >>>>>> "ffreestanding",
> >>>>>> "frsub",
> >>>>>> + "hauser",
> >>>>>> "hisilicon",
> >>>>>> "iccabpr",
> >>>>>> "iccbpr",
> >>>>>> --
> >>>>>> 2.28.0.windows.1
> >>>>>>
> >>>
> >>>
> >>>
> >>>
> >
> >
> >
> >
>
>
>
>
^ permalink raw reply [flat|nested] 36+ messages in thread* Re: [edk2-devel] [PATCH v3 13/14] ArmPkg: Turn off spellcheck audit mode
2022-12-15 16:57 ` Michael D Kinney
@ 2022-12-16 17:36 ` Michael Kubacki
0 siblings, 0 replies; 36+ messages in thread
From: Michael Kubacki @ 2022-12-16 17:36 UTC (permalink / raw)
To: devel, michael.d.kinney, quic_llindhol@quicinc.com
Cc: ardb@kernel.org, Ard Biesheuvel, Sami Mujawar
Hi Mike,
Thanks for the suggestion but I think I'm just going to avoid making
these changes in edk2, at least for now.
If package maintainers don't appreciate the work and we have to figure
out who wants what every time a patch is submitted it truly does consume
more of my time than it should.
Hopefully, a productive result from this series can be a realization
that senior members of this community set the culture and less hostility
toward contributors would encourage more contribution.
I agree the comment in the CI YAML file would be helpful or a section in
a package readme that states the maintainer's preferences.
Thanks,
Michael
On 12/15/2022 11:57 AM, Michael D Kinney wrote:
> Michael,
>
> I appreciate your efforts to improve code quality in all aspects.
>
> I think this is the only part of the change that is being asked
> to be adjusted (specifically for the ArmPkg and ArmVirtPkg) is
> the following.
>
>>>>>>> - "AuditOnly": True,
>>>>>>> + "AuditOnly": False,
>
> Different packages may choose different levels if quality or
> quality checks based on the maturity of the package and what
> is deemed critical to the package maintainers.
>
> There are obvious checks such as compile failures that we can
> all agree on. Checks that are not directly related to
> functionality should perhaps be flexible and the policy be
> allowed to be adjusted by the package maintainers.
>
> I personally would prefer to see as many packages as possible
> take advantage of the CI checks that have been enabled, so I
> think it is good to start with an approach where everything is
> on by default, and if a package maintainer would prefer a
> specific package to have one disabled, then defer to that request.
>
> I also think it would be good to add comments to the package
> YAML file if a check is disabled that clearly states that
> the choice to diverge from the standard CI checks was made
> by the package maintainer.
>
> With this approach, I think your series can go forward with
> AuditOnly set to True for the ArmPkg and ArtVirtPkg with
> comments that this setting is different than the default
> due to requests from the maintainers.
>
> Best regards,
>
> Mike
>
>
>> -----Original Message-----
>> From: devel@edk2.groups.io <devel@edk2.groups.io> On Behalf Of Michael Kubacki
>> Sent: Thursday, December 15, 2022 8:39 AM
>> To: devel@edk2.groups.io; quic_llindhol@quicinc.com
>> Cc: ardb@kernel.org; Ard Biesheuvel <ardb+tianocore@kernel.org>; Sami Mujawar <sami.mujawar@arm.com>; Kinney, Michael D
>> <michael.d.kinney@intel.com>
>> Subject: Re: [edk2-devel] [PATCH v3 13/14] ArmPkg: Turn off spellcheck audit mode
>>
>> On 12/15/2022 5:42 AM, Leif Lindholm wrote:
>>> On Wed, Dec 14, 2022 at 19:04:06 -0500, Michael Kubacki wrote:
>>>> I'm just trying to understand your position.
>>>>
>>>> Are you saying you would rather people check in typos and then later have
>>>> patches come into the package to fix them?
>>>>
>>>> For example, like these:
>>>>
>>>> - ArmVirtPkg: https://edk2.groups.io/g/devel/message/97021
>>>> - ArmPkg: https://edk2.groups.io/g/devel/message/97022
>>>>
>>>> Why not just have the code checked in without typos in the first place?
>>>
>>> A little fairy once whispered in my ear that if I stopped myself and
>>> tried to rephrase whenever I found myself using the work "just", I
>>> would meet less friction in context-stripping communication mediums
>>> such as email. They weren't wrong.
>>>
>>
>> This topic is met with friction regardless of how it is phrased.
>>
>> The friction exists because the community chose to enable spell checking
>> in CI and it is not wanted here.
>>
>> The mechanism chosen to ignore words was through YAML files rather than
>> a button. A common YAML file can store words for the whole project and
>> packages can add package-specific words. The community was expected to
>> make the contributions necessary in the common file to minimize impact
>> on package maintainers.
>>
>> The spellcheck log outputs the exact code that needs to be copied/pasted
>> to the exception list - whether the global list or package list. If you
>> run CI locally, you can copy/paste the exact lines needed.
>>
>> This is a patch series I work on in my spare time to try to improve the
>> project. I am tired of Ard's dismissive and passive aggressive responses
>> such as those in https://edk2.groups.io/g/devel/message/97433 so I
>> revoke the series and will let others decide what they want to do.
>>
>>>> Checking in typos creates more review work, makes the code history have typo
>>>> fix patches that could be avoided, and impacts accessibility.
>>>>
>>>> I spend far more time with edk2 overhead such as email formatting problems,
>>>> keeping track of maintainer email address changes when updating patches,
>>>> mapping email replies back to code, and so on that does not improve the
>>>> code. A spell checker only takes seconds and is built into edk2 CI.
>>>
>>> We didn't disable the spellchecker for the ARM* packages (only)
>>> because we hate correct spelling. We disabled it because it throws
>>> false positives left right and centre. So we end up needing to update
>>> the .ci.yaml every time we mention an architectural concept we haven't
>>> mentioned before. Or add a copyright line mentioning a new
>>> organisation. Or correctly use apostrophes in ways the spellchecker
>>> doesn't expect.
>>>
>>> Here is the current (and very incomplete, oh - and package specific)
>>> exception list for ArmPkg:
>>>
>>> https://github.com/tianocore/edk2/blob/master/ArmPkg/ArmPkg.ci.yaml#L95
>>>
>>> If it had a aggressiveness knob and we could turn it down from 11 to
>>> 3 and work our way up from there, that would be another story.
>>>
>>> Failing that, a push-through-anyway-this-isn't-a-typo label would be a
>>> reasonable compromise.
>>>
>>> But for now, I agree with Ard.
>>>
>>> /
>>> Leif
>>>
>>>> On 12/14/2022 6:24 PM, Ard Biesheuvel wrote:
>>>>> On Thu, 15 Dec 2022 at 00:21, Michael Kubacki
>>>>> <mikuback@linux.microsoft.com> wrote:
>>>>>>
>>>>>> Yes. It will also reduce frequency of incoming patches that must be
>>>>>> reviewed and merged due to people continuously fixing trivial spelling
>>>>>> errors.
>>>>>>
>>>>>
>>>>> In that case, NAK to this patch (and the ArmVirtPkg one). Unless we
>>>>> add a button to the GitHub UI that permits me to override a negative
>>>>> CI result on a PR.
>>>>>
>>>>>> On 12/14/2022 6:07 PM, Ard Biesheuvel wrote:
>>>>>>> On Wed, 14 Dec 2022 at 23:53, <mikuback@linux.microsoft.com> wrote:
>>>>>>>>
>>>>>>>> From: Michael Kubacki <michael.kubacki@microsoft.com>
>>>>>>>>
>>>>>>>> Audit mode was enabled for the spellcheck CI plugin. It is no longer
>>>>>>>> needed with recent changes. Spelling errors can be checked in the
>>>>>>>> package moving forward.
>>>>>>>>
>>>>>>>> Cc: Leif Lindholm <quic_llindhol@quicinc.com>
>>>>>>>> Cc: Ard Biesheuvel <ardb+tianocore@kernel.org>
>>>>>>>> Cc: Sami Mujawar <sami.mujawar@arm.com>
>>>>>>>> Signed-off-by: Michael Kubacki <michael.kubacki@microsoft.com>
>>>>>>>
>>>>>>> Will this patch result in PRs potentially being rejected by pre-merge
>>>>>>> CI due to trivial spelling errors?
>>>>>>>
>>>>>>>
>>>>>>>> ---
>>>>>>>> ArmPkg/ArmPkg.ci.yaml | 3 ++-
>>>>>>>> 1 file changed, 2 insertions(+), 1 deletion(-)
>>>>>>>>
>>>>>>>> diff --git a/ArmPkg/ArmPkg.ci.yaml b/ArmPkg/ArmPkg.ci.yaml
>>>>>>>> index c8dface6821a..a304c7966cf7 100644
>>>>>>>> --- a/ArmPkg/ArmPkg.ci.yaml
>>>>>>>> +++ b/ArmPkg/ArmPkg.ci.yaml
>>>>>>>> @@ -87,7 +87,7 @@
>>>>>>>>
>>>>>>>> ## options defined .pytool/Plugin/SpellCheck
>>>>>>>> "SpellCheck": {
>>>>>>>> - "AuditOnly": True,
>>>>>>>> + "AuditOnly": False,
>>>>>>>> "IgnoreFiles": [
>>>>>>>> "Library/ArmSoftFloatLib/berkeley-softfloat-3/**"
>>>>>>>> ], # use gitignore syntax to ignore errors
>>>>>>>> @@ -148,6 +148,7 @@
>>>>>>>> "fcmplt",
>>>>>>>> "ffreestanding",
>>>>>>>> "frsub",
>>>>>>>> + "hauser",
>>>>>>>> "hisilicon",
>>>>>>>> "iccabpr",
>>>>>>>> "iccbpr",
>>>>>>>> --
>>>>>>>> 2.28.0.windows.1
>>>>>>>>
>>>>>
>>>>>
>>>>>
>>>>>
>>>
>>>
>>>
>>>
>>
>>
>>
>>
>
>
>
>
>
>
^ permalink raw reply [flat|nested] 36+ messages in thread
* Re: [edk2-devel] [PATCH v3 13/14] ArmPkg: Turn off spellcheck audit mode
2022-12-15 16:38 ` Michael Kubacki
2022-12-15 16:57 ` Michael D Kinney
@ 2023-01-04 10:37 ` Ard Biesheuvel
2023-01-06 2:46 ` Michael Kubacki
1 sibling, 1 reply; 36+ messages in thread
From: Ard Biesheuvel @ 2023-01-04 10:37 UTC (permalink / raw)
To: Michael Kubacki; +Cc: devel, quic_llindhol, Sami Mujawar, Kinney, Michael D
On Thu, 15 Dec 2022 at 17:38, Michael Kubacki
<mikuback@linux.microsoft.com> wrote:
>
> On 12/15/2022 5:42 AM, Leif Lindholm wrote:
> > On Wed, Dec 14, 2022 at 19:04:06 -0500, Michael Kubacki wrote:
> >> I'm just trying to understand your position.
> >>
> >> Are you saying you would rather people check in typos and then later have
> >> patches come into the package to fix them?
> >>
> >> For example, like these:
> >>
> >> - ArmVirtPkg: https://edk2.groups.io/g/devel/message/97021
> >> - ArmPkg: https://edk2.groups.io/g/devel/message/97022
> >>
> >> Why not just have the code checked in without typos in the first place?
> >
> > A little fairy once whispered in my ear that if I stopped myself and
> > tried to rephrase whenever I found myself using the work "just", I
> > would meet less friction in context-stripping communication mediums
> > such as email. They weren't wrong.
> >
>
> This topic is met with friction regardless of how it is phrased.
>
> The friction exists because the community chose to enable spell checking
> in CI and it is not wanted here.
>
> The mechanism chosen to ignore words was through YAML files rather than
> a button. A common YAML file can store words for the whole project and
> packages can add package-specific words. The community was expected to
> make the contributions necessary in the common file to minimize impact
> on package maintainers.
>
> The spellcheck log outputs the exact code that needs to be copied/pasted
> to the exception list - whether the global list or package list. If you
> run CI locally, you can copy/paste the exact lines needed.
>
> This is a patch series I work on in my spare time to try to improve the
> project. I am tired of Ard's dismissive and passive aggressive responses
> such as those in https://edk2.groups.io/g/devel/message/97433 so I
> revoke the series and will let others decide what they want to do.
>
I don't think this is a fair characterization of my response. I
explained in detail why I think rigid spellcheck rules are
counter-productive and do not contribute to the quality of what gets
deployed to devices.
Nevertheless, I apologize if my frustration with the recent CI changes
managed to seep through, although I should also mention that I am a
big fan of the pre-merge build and boot tests, as they have been a
huge help in my workflow. Only the rigid enforcement of standards that
are purely cosmetic is what bothers me, especially because finding the
error messages (and suggestions for improvement) in the complex UI is
not as straight-forward as it is made out to be.
That said, it would be helpful if you could respond to the actual
points I made, rather than dismissing them wholesale as a
passive-aggressive and hostile response. You have presented your
contribution as a take-it-or-leave-it style change, rather than
engaging with Leif and me as the package maintainers to converge on
something that we can all agree on.
You may have also missed my question/invitation regarding
collaboration on IBT/BTI enablement in UEFI.
Kind regards,
Ard.
^ permalink raw reply [flat|nested] 36+ messages in thread
* Re: [edk2-devel] [PATCH v3 13/14] ArmPkg: Turn off spellcheck audit mode
2023-01-04 10:37 ` Ard Biesheuvel
@ 2023-01-06 2:46 ` Michael Kubacki
2023-01-11 16:23 ` Ard Biesheuvel
0 siblings, 1 reply; 36+ messages in thread
From: Michael Kubacki @ 2023-01-06 2:46 UTC (permalink / raw)
To: Ard Biesheuvel; +Cc: devel, quic_llindhol, Sami Mujawar, Kinney, Michael D
Hi Ard,
I believe you're referencing the points in this mail, right?
https://edk2.groups.io/g/devel/message/97433
To be clear about why that was considered dismissive and passive
aggressive, these sentences:
"I would also like to point out that all this focus on code aesthetics
that do not contribute to the object code at all is distracting from
things that would actually improve the safety and robustness of the
code."
"So if you are interested, and want to improve EDK2 at a level that
actually makes the shipping code more robust, we could collaborate on
this (PE spec change, UEFI spec change, EDK2 and Linux changes both
for x86 and arm64[0]) so that firmware runs with indirect branch
protection enabled when the hardware supports it."
Read as "this is unimportant/distracting so do this more important stuff
instead".
This may not been what you meant to convey, but it doesn't set the best
foundation for collaboration on the topic.
I understand that there will always be functionally impacting work that
has tangible value over supporting changes like correctly spelling
words. Though, it's not purely aesthetic, language translators and
screen readers function more reliably if words are spelled correctly. In
any case, improving reading comprehension and functionality are not
mutually exclusive.
I think we're meeting on the topic with two different sets of
expectations that naturally conflict.
1. You're not happy with the current process used for spell checking in
TianoCore
2. I would like to prevent and/or minimize future patches that only fix
typos (check in CI)
3. We both believe fixing spelling errors should be simple
(1) is a valid opinion to have but because of (1), I cannot enable (2).
Because of (1), (3) is not true as the infrastructure needs to be
revamped, which I do not personally have bandwidth to do at the moment.
My initial understanding was that the TianoCore process had further
discussion and agreement than it seems occurred so I thought we (as a
community) were in position to simply follow it and reduce the typo
count. Without (2), the typos fixed can reappear (the next commit could
reintroduce the same typo without enforcement) so, in my opinion, it's
not worth the time and effort to manage the patch series in that case.
That's why I revoked the series.
Your feedback is still valuable to the wider TianoCore Tools & CI group
that meets weekly. It may be able to be addressed there.
On the topic of IBT/BTI, I agree that's useful. We probably need to have
a dedicated thread on that to get more background on where you're at and
then we can try to help where possible.
Would you be open to a meeting to discuss that?
Thanks,
Michael
On 1/4/2023 5:37 AM, Ard Biesheuvel wrote:
> On Thu, 15 Dec 2022 at 17:38, Michael Kubacki
> <mikuback@linux.microsoft.com> wrote:
>>
>> On 12/15/2022 5:42 AM, Leif Lindholm wrote:
>>> On Wed, Dec 14, 2022 at 19:04:06 -0500, Michael Kubacki wrote:
>>>> I'm just trying to understand your position.
>>>>
>>>> Are you saying you would rather people check in typos and then later have
>>>> patches come into the package to fix them?
>>>>
>>>> For example, like these:
>>>>
>>>> - ArmVirtPkg: https://edk2.groups.io/g/devel/message/97021
>>>> - ArmPkg: https://edk2.groups.io/g/devel/message/97022
>>>>
>>>> Why not just have the code checked in without typos in the first place?
>>>
>>> A little fairy once whispered in my ear that if I stopped myself and
>>> tried to rephrase whenever I found myself using the work "just", I
>>> would meet less friction in context-stripping communication mediums
>>> such as email. They weren't wrong.
>>>
>>
>> This topic is met with friction regardless of how it is phrased.
>>
>> The friction exists because the community chose to enable spell checking
>> in CI and it is not wanted here.
>>
>> The mechanism chosen to ignore words was through YAML files rather than
>> a button. A common YAML file can store words for the whole project and
>> packages can add package-specific words. The community was expected to
>> make the contributions necessary in the common file to minimize impact
>> on package maintainers.
>>
>> The spellcheck log outputs the exact code that needs to be copied/pasted
>> to the exception list - whether the global list or package list. If you
>> run CI locally, you can copy/paste the exact lines needed.
>>
>> This is a patch series I work on in my spare time to try to improve the
>> project. I am tired of Ard's dismissive and passive aggressive responses
>> such as those in https://edk2.groups.io/g/devel/message/97433 so I
>> revoke the series and will let others decide what they want to do.
>>
>
> I don't think this is a fair characterization of my response. I
> explained in detail why I think rigid spellcheck rules are
> counter-productive and do not contribute to the quality of what gets
> deployed to devices.
>
> Nevertheless, I apologize if my frustration with the recent CI changes
> managed to seep through, although I should also mention that I am a
> big fan of the pre-merge build and boot tests, as they have been a
> huge help in my workflow. Only the rigid enforcement of standards that
> are purely cosmetic is what bothers me, especially because finding the
> error messages (and suggestions for improvement) in the complex UI is
> not as straight-forward as it is made out to be.
>
> That said, it would be helpful if you could respond to the actual
> points I made, rather than dismissing them wholesale as a
> passive-aggressive and hostile response. You have presented your
> contribution as a take-it-or-leave-it style change, rather than
> engaging with Leif and me as the package maintainers to converge on
> something that we can all agree on.
>
> You may have also missed my question/invitation regarding
> collaboration on IBT/BTI enablement in UEFI.
>
> Kind regards,
> Ard.
^ permalink raw reply [flat|nested] 36+ messages in thread
* Re: [edk2-devel] [PATCH v3 13/14] ArmPkg: Turn off spellcheck audit mode
2023-01-06 2:46 ` Michael Kubacki
@ 2023-01-11 16:23 ` Ard Biesheuvel
2023-01-13 1:50 ` Michael Kubacki
0 siblings, 1 reply; 36+ messages in thread
From: Ard Biesheuvel @ 2023-01-11 16:23 UTC (permalink / raw)
To: devel, mikuback; +Cc: quic_llindhol, Sami Mujawar, Kinney, Michael D
On Fri, 6 Jan 2023 at 03:46, Michael Kubacki
<mikuback@linux.microsoft.com> wrote:
>
> Hi Ard,
>
> I believe you're referencing the points in this mail, right?
> https://edk2.groups.io/g/devel/message/97433
>
> To be clear about why that was considered dismissive and passive
> aggressive, these sentences:
>
> "I would also like to point out that all this focus on code aesthetics
> that do not contribute to the object code at all is distracting from
> things that would actually improve the safety and robustness of the
> code."
>
> "So if you are interested, and want to improve EDK2 at a level that
> actually makes the shipping code more robust, we could collaborate on
> this (PE spec change, UEFI spec change, EDK2 and Linux changes both
> for x86 and arm64[0]) so that firmware runs with indirect branch
> protection enabled when the hardware supports it."
>
> Read as "this is unimportant/distracting so do this more important stuff
> instead".
>
Fair enough. It was never my intent to be disrespectful, though.
> This may not been what you meant to convey, but it doesn't set the best
> foundation for collaboration on the topic.
>
True.
> I understand that there will always be functionally impacting work that
> has tangible value over supporting changes like correctly spelling
> words. Though, it's not purely aesthetic, language translators and
> screen readers function more reliably if words are spelled correctly. In
> any case, improving reading comprehension and functionality are not
> mutually exclusive.
>
> I think we're meeting on the topic with two different sets of
> expectations that naturally conflict.
>
> 1. You're not happy with the current process used for spell checking in
> TianoCore
> 2. I would like to prevent and/or minimize future patches that only fix
> typos (check in CI)
> 3. We both believe fixing spelling errors should be simple
>
> (1) is a valid opinion to have but because of (1), I cannot enable (2).
> Because of (1), (3) is not true as the infrastructure needs to be
> revamped, which I do not personally have bandwidth to do at the moment.
>
None of this would be problematic for me if I had the discretion as a
long time maintainer to override/ignore certain CI errors. I don't see
how this is fundamentally different from adding known typos to the
exception list.
> My initial understanding was that the TianoCore process had further
> discussion and agreement than it seems occurred so I thought we (as a
> community) were in position to simply follow it and reduce the typo
> count. Without (2), the typos fixed can reappear (the next commit could
> reintroduce the same typo without enforcement) so, in my opinion, it's
> not worth the time and effort to manage the patch series in that case.
> That's why I revoked the series.
>
Fair enough.
> Your feedback is still valuable to the wider TianoCore Tools & CI group
> that meets weekly. It may be able to be addressed there.
>
Those tend to take place in the middle of the night for me, which is
why I rarely join those.
> On the topic of IBT/BTI, I agree that's useful. We probably need to have
> a dedicated thread on that to get more background on where you're at and
> then we can try to help where possible.
>
> Would you be open to a meeting to discuss that?
>
Yes, please. I'm in UTC+1, and my calendar is generally fairly empty,
so please feel free to set a time that works for you.
^ permalink raw reply [flat|nested] 36+ messages in thread
* Re: [edk2-devel] [PATCH v3 13/14] ArmPkg: Turn off spellcheck audit mode
2023-01-11 16:23 ` Ard Biesheuvel
@ 2023-01-13 1:50 ` Michael Kubacki
0 siblings, 0 replies; 36+ messages in thread
From: Michael Kubacki @ 2023-01-13 1:50 UTC (permalink / raw)
To: Ard Biesheuvel, devel; +Cc: quic_llindhol, Sami Mujawar, Kinney, Michael D
On 1/11/2023 11:23 AM, Ard Biesheuvel wrote:
>> Your feedback is still valuable to the wider TianoCore Tools & CI group
>> that meets weekly. It may be able to be addressed there.
>>
>
> Those tend to take place in the middle of the night for me, which is
> why I rarely join those.
>
The meeting time has been an issue for a number of people that have
expressed interest in joining. There was a discussion around hosting a
meeting at least once a month that is Europe friendly that hopefully can
get started soon.
>> On the topic of IBT/BTI, I agree that's useful. We probably need to have
>> a dedicated thread on that to get more background on where you're at and
>> then we can try to help where possible.
>>
>> Would you be open to a meeting to discuss that?
>>
>
> Yes, please. I'm in UTC+1, and my calendar is generally fairly empty,
> so please feel free to set a time that works for you.
I've learned this was discussed around 2020 and it appears to have been
dropped. Sorry about that. We are gathering the right contacts and will
follow up with you likely next week.
Thanks,
Michael
^ permalink raw reply [flat|nested] 36+ messages in thread
* [PATCH v3 14/14] ArmVirtPkg: Turn off spellcheck audit mode
2022-12-14 22:52 [PATCH v3 00/14] Fix new typos reported Michael Kubacki
` (12 preceding siblings ...)
2022-12-14 22:52 ` [PATCH v3 13/14] ArmPkg: Turn off spellcheck audit mode Michael Kubacki
@ 2022-12-14 22:52 ` Michael Kubacki
2022-12-15 16:40 ` [PATCH v3 00/14] Fix new typos reported Michael Kubacki
14 siblings, 0 replies; 36+ messages in thread
From: Michael Kubacki @ 2022-12-14 22:52 UTC (permalink / raw)
To: devel; +Cc: Ard Biesheuvel, Leif Lindholm, Sami Mujawar, Gerd Hoffmann
From: Michael Kubacki <michael.kubacki@microsoft.com>
Audit mode was enabled for the spellcheck CI plugin. It is no longer
needed with recent changes. Spelling errors can be checked in the
package moving forward.
Cc: Ard Biesheuvel <ardb+tianocore@kernel.org>
Cc: Leif Lindholm <quic_llindhol@quicinc.com>
Cc: Sami Mujawar <sami.mujawar@arm.com>
Cc: Gerd Hoffmann <kraxel@redhat.com>
Signed-off-by: Michael Kubacki <michael.kubacki@microsoft.com>
---
ArmVirtPkg/ArmVirtPkg.ci.yaml | 2 +-
1 file changed, 1 insertion(+), 1 deletion(-)
diff --git a/ArmVirtPkg/ArmVirtPkg.ci.yaml b/ArmVirtPkg/ArmVirtPkg.ci.yaml
index f22dde6d5718..e905e0e6a449 100644
--- a/ArmVirtPkg/ArmVirtPkg.ci.yaml
+++ b/ArmVirtPkg/ArmVirtPkg.ci.yaml
@@ -96,7 +96,7 @@
## options defined .pytool/Plugin/SpellCheck
"SpellCheck": {
- "AuditOnly": True,
+ "AuditOnly": False,
"IgnoreFiles": [], # use gitignore syntax to ignore errors in matching files
"ExtendWords": [
"acpiview",
--
2.28.0.windows.1
^ permalink raw reply related [flat|nested] 36+ messages in thread* Re: [PATCH v3 00/14] Fix new typos reported
2022-12-14 22:52 [PATCH v3 00/14] Fix new typos reported Michael Kubacki
` (13 preceding siblings ...)
2022-12-14 22:52 ` [PATCH v3 14/14] ArmVirtPkg: " Michael Kubacki
@ 2022-12-15 16:40 ` Michael Kubacki
2022-12-16 2:35 ` Dongdong Zhang
14 siblings, 1 reply; 36+ messages in thread
From: Michael Kubacki @ 2022-12-15 16:40 UTC (permalink / raw)
To: devel
Cc: Alexei Fedorov, Ankit Sinha, Ard Biesheuvel, Dongdong Zhang,
Gerd Hoffmann, Guomin Jiang, Jiewen Yao, Leif Lindholm,
Liming Gao, Michael D Kinney, Nate DeSimone, Ray Ni, Sami Mujawar,
Sean Brogan, Supreeth Venkatesh, Wei6 Xu
This series is revoked.
Dongdong, if you would like to still submit your patches, you can use
your original series.
Thanks,
Michael
On 12/14/2022 5:52 PM, mikuback@linux.microsoft.com wrote:
> From: Michael Kubacki <michael.kubacki@microsoft.com>
>
> REF:https://bugzilla.tianocore.org/show_bug.cgi?id=3929
>
> The 5.21.0 SpellCheck plugin update originally caused new typos to
> be reported that were originally missed.
>
> These patches were deferred at the time. There's been renewed
> interest in getting these changes in to continue to improve spelling
> consistency in the codebase so it is rebased, integrates new patches,
> and updates the cspell version.
>
> V3 changes:
> 1. Rebase series (and reopen BZ 3929)
> 2. Add patches from Dongdong Zhang
> 3. Update cspell and node versions
> 4. Disable spellcheck audit mode in ArmPkg and ArmVirtPkg
>
> V2 changes:
> 1. Complete BZ 3929.
> 2. Lock the cspell version to v5.20.0 to prevent latest from
> unexpectedly causing issues in the future.
> 3. Update the common word list in cspell.base.yaml to prevent package
> level duplication in the future.
> 4. Set "allowCompoundWords" to "true" to better recognize compound words.
> 4. Include code review tags.
>
> Cc: Alexei Fedorov <Alexei.Fedorov@arm.com>
> Cc: Ankit Sinha <ankit.sinha@intel.com>
> Cc: Ard Biesheuvel <ardb+tianocore@kernel.org>
> Cc: Dongdong Zhang <zhangdongdong@eswincomputing.com>
> Cc: Gerd Hoffmann <kraxel@redhat.com>
> Cc: Guomin Jiang <guomin.jiang@intel.com>
> Cc: Jiewen Yao <jiewen.yao@intel.com>
> Cc: Leif Lindholm <quic_llindhol@quicinc.com>
> Cc: Liming Gao <gaoliming@byosoft.com.cn>
> Cc: Michael D Kinney <michael.d.kinney@intel.com>
> Cc: Michael Kubacki <mikuback@linux.microsoft.com>
> Cc: Nate DeSimone <nathaniel.l.desimone@intel.com>
> Cc: Ray Ni <ray.ni@intel.com>
> Cc: Sami Mujawar <sami.mujawar@arm.com>
> Cc: Sean Brogan <sean.brogan@microsoft.com>
> Cc: Supreeth Venkatesh <supreeth.venkatesh@arm.com>
> Cc: Wei6 Xu <wei6.xu@intel.com>
> Signed-off-by: Michael Kubacki <michael.kubacki@microsoft.com>
>
> Dongdong Zhang (3):
> ArmPkg: Fix typos
> ArmPlatformPkg: Fix typos
> ArmVirtPkg: Fix typos
>
> Michael Kubacki (11):
> PrmPkg: Fix new typos reported
> StandaloneMmPkg: Fix new typos reported
> DynamicTablesPkg: Fix new typos reported
> UnitTestFrameworkPkg: Fix new typos reported
> FatPkg: Fix new typos reported
> FmpDevicePkg: Fix new typos reported
> ArmPkg: Ignore new typos reported
> ArmVirtPkg: Add new ignored spelling errors
> .azurepipelines: Update cspell version to 5.21.0
> ArmPkg: Turn off spellcheck audit mode
> ArmVirtPkg: Turn off spellcheck audit mode
>
> ArmPkg/Drivers/ArmScmiDxe/ScmiDxe.c | 2 +-
> ArmPkg/Library/ArmDisassemblerLib/ThumbDisassembler.c | 10 ++--
> ArmPkg/Library/SemiHostingSerialPortLib/SerialPortLib.c | 2 +-
> ArmPkg/Library/StandaloneMmMmuLib/ArmMmuStandaloneMmLib.c | 6 +--
> ArmPkg/Universal/Smbios/OemMiscLibNull/OemMiscLib.c | 2 +-
> ArmPkg/Universal/Smbios/ProcessorSubClassDxe/SmbiosProcessorArmCommon.c | 2 +-
> ArmPlatformPkg/Library/ArmMaliDp/ArmMaliDp.c | 2 +-
> ArmPlatformPkg/Library/PL111Lcd/PL111Lcd.c | 6 +--
> ArmVirtPkg/Library/CloudHvVirtMemInfoLib/CloudHvVirtMemInfoLib.c | 2 +-
> ArmVirtPkg/Library/QemuVirtMemInfoLib/QemuVirtMemInfoLib.c | 2 +-
> DynamicTablesPkg/Library/Acpi/Arm/AcpiPpttLibArm/PpttGenerator.c | 2 +-
> DynamicTablesPkg/Library/Acpi/Arm/AcpiSsdtCmn600LibArm/SsdtCmn600Generator.c | 2 +-
> DynamicTablesPkg/Library/Common/AmlLib/Parser/AmlMethodParser.c | 2 +-
> DynamicTablesPkg/Library/Common/AmlLib/Parser/AmlParser.c | 2 +-
> DynamicTablesPkg/Library/Common/AmlLib/Tree/AmlNode.c | 2 +-
> DynamicTablesPkg/Library/Common/DynamicPlatRepoLib/DynamicPlatRepo.c | 4 +-
> DynamicTablesPkg/Library/FdtHwInfoParserLib/Gic/ArmGicDispatcher.c | 2 +-
> DynamicTablesPkg/Library/FdtHwInfoParserLib/Serial/ArmSerialPortParser.c | 2 +-
> FatPkg/EnhancedFatDxe/FileSpace.c | 2 +-
> FatPkg/EnhancedFatDxe/ReadWrite.c | 2 +-
> FmpDevicePkg/Library/FmpDependencyLib/FmpDependencyLib.c | 2 +-
> PrmPkg/Application/PrmInfo/PrmInfo.c | 2 +-
> PrmPkg/Library/DxePrmModuleDiscoveryLib/DxePrmModuleDiscoveryLib.c | 2 +-
> PrmPkg/PrmLoaderDxe/PrmLoaderDxe.c | 2 +-
> StandaloneMmPkg/Core/Dependency.c | 2 +-
> StandaloneMmPkg/Core/Dispatcher.c | 18 +++----
> StandaloneMmPkg/Core/Handle.c | 2 +-
> UnitTestFrameworkPkg/Library/Posix/MemoryAllocationLibPosix/MemoryAllocationLibPosix.c | 18 +++----
> UnitTestFrameworkPkg/Library/UnitTestBootLibNull/UnitTestBootLibNull.c | 2 +-
> UnitTestFrameworkPkg/Library/UnitTestBootLibUsbClass/UnitTestBootLibUsbClass.c | 2 +-
> UnitTestFrameworkPkg/Library/UnitTestLib/Log.c | 2 +-
> UnitTestFrameworkPkg/Library/UnitTestLib/UnitTestLib.c | 2 +-
> UnitTestFrameworkPkg/Library/UnitTestUefiBootServicesTableLib/UnitTestUefiBootServicesTableLibImage.c | 2 +-
> UnitTestFrameworkPkg/Library/UnitTestUefiBootServicesTableLib/UnitTestUefiBootServicesTableLibProtocol.c | 2 +-
> UnitTestFrameworkPkg/Test/UnitTest/Sample/SampleUnitTest/SampleUnitTest.c | 2 +-
> .azurepipelines/templates/spell-check-prereq-steps.yml | 4 +-
> ArmPkg/ArmPkg.ci.yaml | 56 ++++++++++++++++++--
> ArmPkg/Include/Library/OemMiscLib.h | 2 +-
> ArmPkg/Library/ArmLib/AArch64/ArmLibSupport.S | 2 +-
> ArmPkg/Library/ArmLib/AArch64/ArmLibSupportV8.S | 2 +-
> ArmPkg/Library/SemihostLib/Arm/GccSemihost.S | 2 +-
> ArmPlatformPkg/ArmPlatformPkg.dec | 2 +-
> ArmPlatformPkg/Include/Library/LcdPlatformLib.h | 2 +-
> ArmVirtPkg/ArmVirt.dsc.inc | 2 +-
> ArmVirtPkg/ArmVirtPkg.ci.yaml | 27 ++++++----
> DynamicTablesPkg/DynamicTablesPkg.ci.yaml | 31 ++++++++---
> DynamicTablesPkg/Include/Library/DynamicPlatRepoLib.h | 4 +-
> DynamicTablesPkg/Library/Common/AmlLib/Parser/AmlMethodParser.h | 2 +-
> DynamicTablesPkg/Library/FdtHwInfoParserLib/Gic/ArmGicDispatcher.h | 2 +-
> DynamicTablesPkg/Library/FdtHwInfoParserLib/Serial/ArmSerialPortParser.h | 2 +-
> DynamicTablesPkg/Readme.md | 4 +-
> FatPkg/EnhancedFatDxe/Fat.h | 2 +-
> FatPkg/FatPkg.ci.yaml | 22 ++++++--
> FmpDevicePkg/FmpDevicePkg.ci.yaml | 4 ++
> PrmPkg/Include/Library/PrmModuleDiscoveryLib.h | 2 +-
> PrmPkg/PrmLoaderDxe/PrmAcpiTable.h | 4 +-
> PrmPkg/PrmPkg.ci.yaml | 9 ++++
> StandaloneMmPkg/Core/StandaloneMmCore.h | 2 +-
> StandaloneMmPkg/Include/Guid/MmCoreData.h | 2 +-
> StandaloneMmPkg/StandaloneMmPkg.ci.yaml | 8 +++
> UnitTestFrameworkPkg/Library/UnitTestUefiBootServicesTableLib/UnitTestUefiBootServicesTableLib.h | 4 +-
> UnitTestFrameworkPkg/PrivateInclude/Library/UnitTestBootLib.h | 2 +-
> UnitTestFrameworkPkg/PrivateInclude/UnitTestFrameworkTypes.h | 2 +-
> UnitTestFrameworkPkg/UnitTestFrameworkPkg.ci.yaml | 31 +++++++----
> 64 files changed, 236 insertions(+), 124 deletions(-)
>
^ permalink raw reply [flat|nested] 36+ messages in thread* Re: [PATCH v3 00/14] Fix new typos reported
2022-12-15 16:40 ` [PATCH v3 00/14] Fix new typos reported Michael Kubacki
@ 2022-12-16 2:35 ` Dongdong Zhang
0 siblings, 0 replies; 36+ messages in thread
From: Dongdong Zhang @ 2022-12-16 2:35 UTC (permalink / raw)
To: Michael Kubacki
Cc: devel, Alexei Fedorov, Ankit Sinha, Gerd Hoffmann, Guomin Jiang,
Jiewen Yao, Leif Lindholm, Liming Gao, Michael D Kinney,
Nate DeSimone, Ray Ni, Sami Mujawar, Sean Brogan,
Supreeth Venkatesh, Wei6 Xu
Hi Michael,
Thanks for your reminder.
Dongdong
> -----原始邮件-----发件人:"Michael Kubacki" <mikuback@linux.microsoft.com>发送时间:2022-12-16 00:40:44 (星期五)收件人:devel@edk2.groups.io抄送:"Alexei Fedorov" <Alexei.Fedorov@arm.com>, "Ankit Sinha" <ankit.sinha@intel.com>, "Ard Biesheuvel" <ardb+tianocore@kernel.org>, "Dongdong Zhang" <zhangdongdong@eswincomputing.com>, "Gerd Hoffmann" <kraxel@redhat.com>, "Guomin Jiang" <guomin.jiang@intel.com>, "Jiewen Yao" <jiewen.yao@intel.com>, "Leif Lindholm" <quic_llindhol@quicinc.com>, "Liming Gao" <gaoliming@byosoft.com.cn>, "Michael D Kinney" <michael.d.kinney@intel.com>, "Nate DeSimone" <nathaniel.l.desimone@intel.com>, "Ray Ni" <ray.ni@intel.com>, "Sami Mujawar" <sami.mujawar@arm.com>, "Sean Brogan" <sean.brogan@microsoft.com>, "Supreeth Venkatesh" <supreeth.venkatesh@arm.com>, "Wei6 Xu" <wei6.xu@intel.com>主题:Re: [PATCH v3 00/14] Fix new typos reported
>
> This series is revoked.
>
> Dongdong, if you would like to still submit your patches, you can use
> your original series.
>
> Thanks,
> Michael
>
> On 12/14/2022 5:52 PM, mikuback@linux.microsoft.com wrote:
> > From: Michael Kubacki <michael.kubacki@microsoft.com>
> >
> > REF:https://bugzilla.tianocore.org/show_bug.cgi?id=3929
> >
> > The 5.21.0 SpellCheck plugin update originally caused new typos to
> > be reported that were originally missed.
> >
> > These patches were deferred at the time. There's been renewed
> > interest in getting these changes in to continue to improve spelling
> > consistency in the codebase so it is rebased, integrates new patches,
> > and updates the cspell version.
> >
> > V3 changes:
> > 1. Rebase series (and reopen BZ 3929)
> > 2. Add patches from Dongdong Zhang
> > 3. Update cspell and node versions
> > 4. Disable spellcheck audit mode in ArmPkg and ArmVirtPkg
> >
> > V2 changes:
> > 1. Complete BZ 3929.
> > 2. Lock the cspell version to v5.20.0 to prevent latest from
> > unexpectedly causing issues in the future.
> > 3. Update the common word list in cspell.base.yaml to prevent package
> > level duplication in the future.
> > 4. Set "allowCompoundWords" to "true" to better recognize compound words.
> > 4. Include code review tags.
> >
> > Cc: Alexei Fedorov <Alexei.Fedorov@arm.com>
> > Cc: Ankit Sinha <ankit.sinha@intel.com>
> > Cc: Ard Biesheuvel <ardb+tianocore@kernel.org>
> > Cc: Dongdong Zhang <zhangdongdong@eswincomputing.com>
> > Cc: Gerd Hoffmann <kraxel@redhat.com>
> > Cc: Guomin Jiang <guomin.jiang@intel.com>
> > Cc: Jiewen Yao <jiewen.yao@intel.com>
> > Cc: Leif Lindholm <quic_llindhol@quicinc.com>
> > Cc: Liming Gao <gaoliming@byosoft.com.cn>
> > Cc: Michael D Kinney <michael.d.kinney@intel.com>
> > Cc: Michael Kubacki <mikuback@linux.microsoft.com>
> > Cc: Nate DeSimone <nathaniel.l.desimone@intel.com>
> > Cc: Ray Ni <ray.ni@intel.com>
> > Cc: Sami Mujawar <sami.mujawar@arm.com>
> > Cc: Sean Brogan <sean.brogan@microsoft.com>
> > Cc: Supreeth Venkatesh <supreeth.venkatesh@arm.com>
> > Cc: Wei6 Xu <wei6.xu@intel.com>
> > Signed-off-by: Michael Kubacki <michael.kubacki@microsoft.com>
> >
> > Dongdong Zhang (3):
> > ArmPkg: Fix typos
> > ArmPlatformPkg: Fix typos
> > ArmVirtPkg: Fix typos
> >
> > Michael Kubacki (11):
> > PrmPkg: Fix new typos reported
> > StandaloneMmPkg: Fix new typos reported
> > DynamicTablesPkg: Fix new typos reported
> > UnitTestFrameworkPkg: Fix new typos reported
> > FatPkg: Fix new typos reported
> > FmpDevicePkg: Fix new typos reported
> > ArmPkg: Ignore new typos reported
> > ArmVirtPkg: Add new ignored spelling errors
> > .azurepipelines: Update cspell version to 5.21.0
> > ArmPkg: Turn off spellcheck audit mode
> > ArmVirtPkg: Turn off spellcheck audit mode
> >
> > ArmPkg/Drivers/ArmScmiDxe/ScmiDxe.c | 2 +-
> > ArmPkg/Library/ArmDisassemblerLib/ThumbDisassembler.c | 10 ++--
> > ArmPkg/Library/SemiHostingSerialPortLib/SerialPortLib.c | 2 +-
> > ArmPkg/Library/StandaloneMmMmuLib/ArmMmuStandaloneMmLib.c | 6 +--
> > ArmPkg/Universal/Smbios/OemMiscLibNull/OemMiscLib.c | 2 +-
> > ArmPkg/Universal/Smbios/ProcessorSubClassDxe/SmbiosProcessorArmCommon.c | 2 +-
> > ArmPlatformPkg/Library/ArmMaliDp/ArmMaliDp.c | 2 +-
> > ArmPlatformPkg/Library/PL111Lcd/PL111Lcd.c | 6 +--
> > ArmVirtPkg/Library/CloudHvVirtMemInfoLib/CloudHvVirtMemInfoLib.c | 2 +-
> > ArmVirtPkg/Library/QemuVirtMemInfoLib/QemuVirtMemInfoLib.c | 2 +-
> > DynamicTablesPkg/Library/Acpi/Arm/AcpiPpttLibArm/PpttGenerator.c | 2 +-
> > DynamicTablesPkg/Library/Acpi/Arm/AcpiSsdtCmn600LibArm/SsdtCmn600Generator.c | 2 +-
> > DynamicTablesPkg/Library/Common/AmlLib/Parser/AmlMethodParser.c | 2 +-
> > DynamicTablesPkg/Library/Common/AmlLib/Parser/AmlParser.c | 2 +-
> > DynamicTablesPkg/Library/Common/AmlLib/Tree/AmlNode.c | 2 +-
> > DynamicTablesPkg/Library/Common/DynamicPlatRepoLib/DynamicPlatRepo.c | 4 +-
> > DynamicTablesPkg/Library/FdtHwInfoParserLib/Gic/ArmGicDispatcher.c | 2 +-
> > DynamicTablesPkg/Library/FdtHwInfoParserLib/Serial/ArmSerialPortParser.c | 2 +-
> > FatPkg/EnhancedFatDxe/FileSpace.c | 2 +-
> > FatPkg/EnhancedFatDxe/ReadWrite.c | 2 +-
> > FmpDevicePkg/Library/FmpDependencyLib/FmpDependencyLib.c | 2 +-
> > PrmPkg/Application/PrmInfo/PrmInfo.c | 2 +-
> > PrmPkg/Library/DxePrmModuleDiscoveryLib/DxePrmModuleDiscoveryLib.c | 2 +-
> > PrmPkg/PrmLoaderDxe/PrmLoaderDxe.c | 2 +-
> > StandaloneMmPkg/Core/Dependency.c | 2 +-
> > StandaloneMmPkg/Core/Dispatcher.c | 18 +++----
> > StandaloneMmPkg/Core/Handle.c | 2 +-
> > UnitTestFrameworkPkg/Library/Posix/MemoryAllocationLibPosix/MemoryAllocationLibPosix.c | 18 +++----
> > UnitTestFrameworkPkg/Library/UnitTestBootLibNull/UnitTestBootLibNull.c | 2 +-
> > UnitTestFrameworkPkg/Library/UnitTestBootLibUsbClass/UnitTestBootLibUsbClass.c | 2 +-
> > UnitTestFrameworkPkg/Library/UnitTestLib/Log.c | 2 +-
> > UnitTestFrameworkPkg/Library/UnitTestLib/UnitTestLib.c | 2 +-
> > UnitTestFrameworkPkg/Library/UnitTestUefiBootServicesTableLib/UnitTestUefiBootServicesTableLibImage.c | 2 +-
> > UnitTestFrameworkPkg/Library/UnitTestUefiBootServicesTableLib/UnitTestUefiBootServicesTableLibProtocol.c | 2 +-
> > UnitTestFrameworkPkg/Test/UnitTest/Sample/SampleUnitTest/SampleUnitTest.c | 2 +-
> > .azurepipelines/templates/spell-check-prereq-steps.yml | 4 +-
> > ArmPkg/ArmPkg.ci.yaml | 56 ++++++++++++++++++--
> > ArmPkg/Include/Library/OemMiscLib.h | 2 +-
> > ArmPkg/Library/ArmLib/AArch64/ArmLibSupport.S | 2 +-
> > ArmPkg/Library/ArmLib/AArch64/ArmLibSupportV8.S | 2 +-
> > ArmPkg/Library/SemihostLib/Arm/GccSemihost.S | 2 +-
> > ArmPlatformPkg/ArmPlatformPkg.dec | 2 +-
> > ArmPlatformPkg/Include/Library/LcdPlatformLib.h | 2 +-
> > ArmVirtPkg/ArmVirt.dsc.inc | 2 +-
> > ArmVirtPkg/ArmVirtPkg.ci.yaml | 27 ++++++----
> > DynamicTablesPkg/DynamicTablesPkg.ci.yaml | 31 ++++++++---
> > DynamicTablesPkg/Include/Library/DynamicPlatRepoLib.h | 4 +-
> > DynamicTablesPkg/Library/Common/AmlLib/Parser/AmlMethodParser.h | 2 +-
> > DynamicTablesPkg/Library/FdtHwInfoParserLib/Gic/ArmGicDispatcher.h | 2 +-
> > DynamicTablesPkg/Library/FdtHwInfoParserLib/Serial/ArmSerialPortParser.h | 2 +-
> > DynamicTablesPkg/Readme.md | 4 +-
> > FatPkg/EnhancedFatDxe/Fat.h | 2 +-
> > FatPkg/FatPkg.ci.yaml | 22 ++++++--
> > FmpDevicePkg/FmpDevicePkg.ci.yaml | 4 ++
> > PrmPkg/Include/Library/PrmModuleDiscoveryLib.h | 2 +-
> > PrmPkg/PrmLoaderDxe/PrmAcpiTable.h | 4 +-
> > PrmPkg/PrmPkg.ci.yaml | 9 ++++
> > StandaloneMmPkg/Core/StandaloneMmCore.h | 2 +-
> > StandaloneMmPkg/Include/Guid/MmCoreData.h | 2 +-
> > StandaloneMmPkg/StandaloneMmPkg.ci.yaml | 8 +++
> > UnitTestFrameworkPkg/Library/UnitTestUefiBootServicesTableLib/UnitTestUefiBootServicesTableLib.h | 4 +-
> > UnitTestFrameworkPkg/PrivateInclude/Library/UnitTestBootLib.h | 2 +-
> > UnitTestFrameworkPkg/PrivateInclude/UnitTestFrameworkTypes.h | 2 +-
> > UnitTestFrameworkPkg/UnitTestFrameworkPkg.ci.yaml | 31 +++++++----
> > 64 files changed, 236 insertions(+), 124 deletions(-)
> >
^ permalink raw reply [flat|nested] 36+ messages in thread