* [PATCH v1 1/8] PrmPkg: Fix new typos reported
2022-05-17 16:00 [PATCH v1 0/8] Fix new typos reported Michael Kubacki
@ 2022-05-17 16:00 ` Michael Kubacki
2022-05-17 16:00 ` [PATCH v1 2/8] StandaloneMmPkg: " Michael Kubacki
` (7 subsequent siblings)
8 siblings, 0 replies; 24+ messages in thread
From: Michael Kubacki @ 2022-05-17 16:00 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 +-
PrmPkg/Test/UnitTest/Library/UefiBootServicesTableLibUnitTest/UefiBootServicesTableLibUnitTestImage.c | 2 +-
PrmPkg/Test/UnitTest/Library/UefiBootServicesTableLibUnitTest/UefiBootServicesTableLibUnitTestProtocol.c | 2 +-
PrmPkg/Include/Library/PrmModuleDiscoveryLib.h | 2 +-
PrmPkg/PrmLoaderDxe/PrmAcpiTable.h | 4 ++--
PrmPkg/PrmPkg.ci.yaml | 9 +++++++++
PrmPkg/Test/UnitTest/Library/UefiBootServicesTableLibUnitTest/UefiBootServicesTableLibUnitTest.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/PrmPkg/Test/UnitTest/Library/UefiBootServicesTableLibUnitTest/UefiBootServicesTableLibUnitTestImage.c b/PrmPkg/Test/UnitTest/Library/UefiBootServicesTableLibUnitTest/UefiBootServicesTableLibUnitTestImage.c
index a5799ff92d0c..abc6a4f1440c 100644
--- a/PrmPkg/Test/UnitTest/Library/UefiBootServicesTableLibUnitTest/UefiBootServicesTableLibUnitTestImage.c
+++ b/PrmPkg/Test/UnitTest/Library/UefiBootServicesTableLibUnitTest/UefiBootServicesTableLibUnitTestImage.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/PrmPkg/Test/UnitTest/Library/UefiBootServicesTableLibUnitTest/UefiBootServicesTableLibUnitTestProtocol.c b/PrmPkg/Test/UnitTest/Library/UefiBootServicesTableLibUnitTest/UefiBootServicesTableLibUnitTestProtocol.c
index 799b153a445f..46fd263ec070 100644
--- a/PrmPkg/Test/UnitTest/Library/UefiBootServicesTableLibUnitTest/UefiBootServicesTableLibUnitTestProtocol.c
+++ b/PrmPkg/Test/UnitTest/Library/UefiBootServicesTableLibUnitTest/UefiBootServicesTableLibUnitTestProtocol.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 babaf2214ec8..0c84e616adbf 100644
--- a/PrmPkg/PrmPkg.ci.yaml
+++ b/PrmPkg/PrmPkg.ci.yaml
@@ -93,10 +93,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/PrmPkg/Test/UnitTest/Library/UefiBootServicesTableLibUnitTest/UefiBootServicesTableLibUnitTest.h b/PrmPkg/Test/UnitTest/Library/UefiBootServicesTableLibUnitTest/UefiBootServicesTableLibUnitTest.h
index 82853bb61a1c..20958589b254 100644
--- a/PrmPkg/Test/UnitTest/Library/UefiBootServicesTableLibUnitTest/UefiBootServicesTableLibUnitTest.h
+++ b/PrmPkg/Test/UnitTest/Library/UefiBootServicesTableLibUnitTest/UefiBootServicesTableLibUnitTest.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] 24+ messages in thread* [PATCH v1 2/8] StandaloneMmPkg: Fix new typos reported
2022-05-17 16:00 [PATCH v1 0/8] Fix new typos reported Michael Kubacki
2022-05-17 16:00 ` [PATCH v1 1/8] PrmPkg: " Michael Kubacki
@ 2022-05-17 16:00 ` Michael Kubacki
2022-05-17 16:19 ` Sami Mujawar
2022-05-17 16:00 ` [PATCH v1 3/8] DynamicTablesPkg: " Michael Kubacki
` (6 subsequent siblings)
8 siblings, 1 reply; 24+ messages in thread
From: Michael Kubacki @ 2022-05-17 16:00 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>
---
StandaloneMmPkg/Core/Dependency.c | 2 +-
StandaloneMmPkg/Core/Dispatcher.c | 18 +++++++++---------
StandaloneMmPkg/Include/Guid/MmCoreData.h | 2 +-
StandaloneMmPkg/StandaloneMmPkg.ci.yaml | 9 +++++++++
4 files changed, 20 insertions(+), 11 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/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..535e269e7891 100644
--- a/StandaloneMmPkg/StandaloneMmPkg.ci.yaml
+++ b/StandaloneMmPkg/StandaloneMmPkg.ci.yaml
@@ -81,12 +81,21 @@
"IgnoreFiles": [], # use gitignore syntax to ignore errors
# in matching files
"ExtendWords": [
+ "bootinformation",
"Bsymbolic",
+ "bugbug",
+ "combineable",
+ "depexes",
"FwVol",
+ "hoblist",
+ "imagehandle",
+ "interfacer",
"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] 24+ messages in thread* Re: [PATCH v1 2/8] StandaloneMmPkg: Fix new typos reported
2022-05-17 16:00 ` [PATCH v1 2/8] StandaloneMmPkg: " Michael Kubacki
@ 2022-05-17 16:19 ` Sami Mujawar
2022-05-17 17:23 ` Michael Kubacki
0 siblings, 1 reply; 24+ messages in thread
From: Sami Mujawar @ 2022-05-17 16:19 UTC (permalink / raw)
To: mikuback@linux.microsoft.com, devel@edk2.groups.io
Cc: Ard Biesheuvel, Jiewen Yao, Supreeth Venkatesh, nd
Hi Michael,
Thank you for fixing these issues.
I have a minor suggestion marked inline as [SAMI]. Otherwise, this patch looks good to me.
Reviewed-by: Sami Mujawar <sami.mujawar@arm.com>
Regards,
Sami Mujawar
On 17/05/2022, 17:01, "mikuback@linux.microsoft.com" <mikuback@linux.microsoft.com> wrote:
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>
---
StandaloneMmPkg/Core/Dependency.c | 2 +-
StandaloneMmPkg/Core/Dispatcher.c | 18 +++++++++---------
StandaloneMmPkg/Include/Guid/MmCoreData.h | 2 +-
StandaloneMmPkg/StandaloneMmPkg.ci.yaml | 9 +++++++++
4 files changed, 20 insertions(+), 11 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/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..535e269e7891 100644
--- a/StandaloneMmPkg/StandaloneMmPkg.ci.yaml
+++ b/StandaloneMmPkg/StandaloneMmPkg.ci.yaml
@@ -81,12 +81,21 @@
"IgnoreFiles": [], # use gitignore syntax to ignore errors
# in matching files
"ExtendWords": [
+ "bootinformation",
"Bsymbolic",
+ "bugbug",
+ "combineable",
+ "depexes",
"FwVol",
+ "hoblist",
+ "imagehandle",
+ "interfacer",
[SAMI] I think there is a typo in https://github.com/tianocore/edk2/blob/master/StandaloneMmPkg/Core/Handle.c#L350 and https://github.com/tianocore/edk2/blob/master/StandaloneMmPkg/Core/StandaloneMmCore.h#L429, where "a protocol:interfacer" needs to be changed to "protocol interfaces".
[/SAMI]
"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 [flat|nested] 24+ messages in thread* Re: [PATCH v1 2/8] StandaloneMmPkg: Fix new typos reported
2022-05-17 16:19 ` Sami Mujawar
@ 2022-05-17 17:23 ` Michael Kubacki
0 siblings, 0 replies; 24+ messages in thread
From: Michael Kubacki @ 2022-05-17 17:23 UTC (permalink / raw)
To: Sami Mujawar, devel@edk2.groups.io
Cc: Ard Biesheuvel, Jiewen Yao, Supreeth Venkatesh, nd
Sure I can add that to a v2. I'm going to leave v1 up for a bit longer
to collect more feedback before sending that.
Regards,
Michael
On 5/17/2022 12:19 PM, Sami Mujawar wrote:
> Hi Michael,
>
> Thank you for fixing these issues.
>
> I have a minor suggestion marked inline as [SAMI]. Otherwise, this patch looks good to me.
>
> Reviewed-by: Sami Mujawar <sami.mujawar@arm.com>
>
> Regards,
>
> Sami Mujawar
>
> On 17/05/2022, 17:01, "mikuback@linux.microsoft.com" <mikuback@linux.microsoft.com> wrote:
>
> 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>
> ---
> StandaloneMmPkg/Core/Dependency.c | 2 +-
> StandaloneMmPkg/Core/Dispatcher.c | 18 +++++++++---------
> StandaloneMmPkg/Include/Guid/MmCoreData.h | 2 +-
> StandaloneMmPkg/StandaloneMmPkg.ci.yaml | 9 +++++++++
> 4 files changed, 20 insertions(+), 11 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/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..535e269e7891 100644
> --- a/StandaloneMmPkg/StandaloneMmPkg.ci.yaml
> +++ b/StandaloneMmPkg/StandaloneMmPkg.ci.yaml
> @@ -81,12 +81,21 @@
> "IgnoreFiles": [], # use gitignore syntax to ignore errors
> # in matching files
> "ExtendWords": [
> + "bootinformation",
> "Bsymbolic",
> + "bugbug",
> + "combineable",
> + "depexes",
> "FwVol",
> + "hoblist",
> + "imagehandle",
> + "interfacer",
> [SAMI] I think there is a typo in https://github.com/tianocore/edk2/blob/master/StandaloneMmPkg/Core/Handle.c#L350 and https://github.com/tianocore/edk2/blob/master/StandaloneMmPkg/Core/StandaloneMmCore.h#L429, where "a protocol:interfacer" needs to be changed to "protocol interfaces".
> [/SAMI]
> "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 [flat|nested] 24+ messages in thread
* [PATCH v1 3/8] DynamicTablesPkg: Fix new typos reported
2022-05-17 16:00 [PATCH v1 0/8] Fix new typos reported Michael Kubacki
2022-05-17 16:00 ` [PATCH v1 1/8] PrmPkg: " Michael Kubacki
2022-05-17 16:00 ` [PATCH v1 2/8] StandaloneMmPkg: " Michael Kubacki
@ 2022-05-17 16:00 ` Michael Kubacki
2022-05-17 16:27 ` Sami Mujawar
2022-05-17 16:00 ` [PATCH v1 4/8] UnitTestFrameworkPkg: " Michael Kubacki
` (5 subsequent siblings)
8 siblings, 1 reply; 24+ messages in thread
From: Michael Kubacki @ 2022-05-17 16:00 UTC (permalink / raw)
To: devel; +Cc: Sami Mujawar, Alexei Fedorov
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>
Signed-off-by: Michael Kubacki <michael.kubacki@microsoft.com>
---
DynamicTablesPkg/Library/Acpi/Arm/AcpiPpttLibArm/PpttGenerator.c | 2 +-
DynamicTablesPkg/Library/Acpi/Arm/AcpiSsdtCmn600LibArm/SsdtCmn600Generator.c | 2 +-
DynamicTablesPkg/Library/Common/AmlLib/CodeGen/AmlResourceDataCodeGen.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 +--
15 files changed, 41 insertions(+), 24 deletions(-)
diff --git a/DynamicTablesPkg/Library/Acpi/Arm/AcpiPpttLibArm/PpttGenerator.c b/DynamicTablesPkg/Library/Acpi/Arm/AcpiPpttLibArm/PpttGenerator.c
index 59001378c4e0..83bda4cfba67 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 18c8b8d24525..b823b412caae 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/CodeGen/AmlResourceDataCodeGen.c b/DynamicTablesPkg/Library/Common/AmlLib/CodeGen/AmlResourceDataCodeGen.c
index dafbd19fde15..32c3ab534d0b 100644
--- a/DynamicTablesPkg/Library/Common/AmlLib/CodeGen/AmlResourceDataCodeGen.c
+++ b/DynamicTablesPkg/Library/Common/AmlLib/CodeGen/AmlResourceDataCodeGen.c
@@ -619,7 +619,7 @@ AmlCodeGenRdDWordMemory (
See ACPI 6.4 spec, s19.2.8 for more.
@param [in] IsReadWrite ReadAndWrite parameter.
- @param [in] Addres AddressBase parameter.
+ @param [in] Address AddressBase parameter.
@param [in] RangeLength Range length.
@param [in] NameOpNode NameOp object node defining a named object.
If provided, append the new resource data
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 831f0d5b7365..d38a331f4822 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 0557e416b44c..71e92ee1fb14 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 bfa282926e48..2d2f3405e467 100644
--- a/DynamicTablesPkg/DynamicTablesPkg.ci.yaml
+++ b/DynamicTablesPkg/DynamicTablesPkg.ci.yaml
@@ -92,35 +92,52 @@
"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",
"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 5f92d4c6cb2e..f5b3f65cd9af 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] 24+ messages in thread* Re: [PATCH v1 3/8] DynamicTablesPkg: Fix new typos reported
2022-05-17 16:00 ` [PATCH v1 3/8] DynamicTablesPkg: " Michael Kubacki
@ 2022-05-17 16:27 ` Sami Mujawar
0 siblings, 0 replies; 24+ messages in thread
From: Sami Mujawar @ 2022-05-17 16:27 UTC (permalink / raw)
To: mikuback@linux.microsoft.com, devel@edk2.groups.io; +Cc: Alexei Fedorov, nd
Hi Michael,
Thank you for this patch. These changes look good to me.
Reviewed-by: Sami Mujawar <sami.mujawar@arm.com>
Regards,
Sami Mujawar
On 17/05/2022, 17:01, "mikuback@linux.microsoft.com" <mikuback@linux.microsoft.com> wrote:
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>
Signed-off-by: Michael Kubacki <michael.kubacki@microsoft.com>
---
DynamicTablesPkg/Library/Acpi/Arm/AcpiPpttLibArm/PpttGenerator.c | 2 +-
DynamicTablesPkg/Library/Acpi/Arm/AcpiSsdtCmn600LibArm/SsdtCmn600Generator.c | 2 +-
DynamicTablesPkg/Library/Common/AmlLib/CodeGen/AmlResourceDataCodeGen.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 +--
15 files changed, 41 insertions(+), 24 deletions(-)
diff --git a/DynamicTablesPkg/Library/Acpi/Arm/AcpiPpttLibArm/PpttGenerator.c b/DynamicTablesPkg/Library/Acpi/Arm/AcpiPpttLibArm/PpttGenerator.c
index 59001378c4e0..83bda4cfba67 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 18c8b8d24525..b823b412caae 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/CodeGen/AmlResourceDataCodeGen.c b/DynamicTablesPkg/Library/Common/AmlLib/CodeGen/AmlResourceDataCodeGen.c
index dafbd19fde15..32c3ab534d0b 100644
--- a/DynamicTablesPkg/Library/Common/AmlLib/CodeGen/AmlResourceDataCodeGen.c
+++ b/DynamicTablesPkg/Library/Common/AmlLib/CodeGen/AmlResourceDataCodeGen.c
@@ -619,7 +619,7 @@ AmlCodeGenRdDWordMemory (
See ACPI 6.4 spec, s19.2.8 for more.
@param [in] IsReadWrite ReadAndWrite parameter.
- @param [in] Addres AddressBase parameter.
+ @param [in] Address AddressBase parameter.
@param [in] RangeLength Range length.
@param [in] NameOpNode NameOp object node defining a named object.
If provided, append the new resource data
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 831f0d5b7365..d38a331f4822 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 0557e416b44c..71e92ee1fb14 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 bfa282926e48..2d2f3405e467 100644
--- a/DynamicTablesPkg/DynamicTablesPkg.ci.yaml
+++ b/DynamicTablesPkg/DynamicTablesPkg.ci.yaml
@@ -92,35 +92,52 @@
"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",
"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 5f92d4c6cb2e..f5b3f65cd9af 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 [flat|nested] 24+ messages in thread
* [PATCH v1 4/8] UnitTestFrameworkPkg: Fix new typos reported
2022-05-17 16:00 [PATCH v1 0/8] Fix new typos reported Michael Kubacki
` (2 preceding siblings ...)
2022-05-17 16:00 ` [PATCH v1 3/8] DynamicTablesPkg: " Michael Kubacki
@ 2022-05-17 16:00 ` Michael Kubacki
2022-05-17 16:00 ` [PATCH v1 5/8] FatPkg: " Michael Kubacki
` (4 subsequent siblings)
8 siblings, 0 replies; 24+ messages in thread
From: Michael Kubacki @ 2022-05-17 16:00 UTC (permalink / raw)
To: devel; +Cc: Michael D Kinney, Michael Kubacki, Sean Brogan, Bret Barkelew
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: Michael Kubacki <mikuback@linux.microsoft.com>
Cc: Sean Brogan <sean.brogan@microsoft.com>
Cc: Bret Barkelew <Bret.Barkelew@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 | 29 ++++++++++++++------
9 files changed, 36 insertions(+), 25 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 64d5880783bf..d095b2f12067 100644
--- a/UnitTestFrameworkPkg/Library/UnitTestLib/UnitTestLib.c
+++ b/UnitTestFrameworkPkg/Library/UnitTestLib/UnitTestLib.c
@@ -215,7 +215,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 77d51e13484c..dab416521585 100644
--- a/UnitTestFrameworkPkg/UnitTestFrameworkPkg.ci.yaml
+++ b/UnitTestFrameworkPkg/UnitTestFrameworkPkg.ci.yaml
@@ -81,19 +81,30 @@
"Library/CmockaLib/cmocka/**/*.*" # 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",
+ "mdkinney", # Contact GitHub account in Readme
+ "NOFAILURE",
+ "notefierror",
+ "notequal",
"pytool",
"pytools",
- "NOFAILURE",
- "cmockery",
- "DHAVE", # build flag for cmocka in the 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] 24+ messages in thread* [PATCH v1 5/8] FatPkg: Fix new typos reported
2022-05-17 16:00 [PATCH v1 0/8] Fix new typos reported Michael Kubacki
` (3 preceding siblings ...)
2022-05-17 16:00 ` [PATCH v1 4/8] UnitTestFrameworkPkg: " Michael Kubacki
@ 2022-05-17 16:00 ` Michael Kubacki
2022-05-18 0:58 ` Ni, Ray
2022-05-17 16:00 ` [PATCH v1 6/8] FmpDevicePkg: " Michael Kubacki
` (3 subsequent siblings)
8 siblings, 1 reply; 24+ messages in thread
From: Michael Kubacki @ 2022-05-17 16:00 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] 24+ messages in thread* Re: [PATCH v1 5/8] FatPkg: Fix new typos reported
2022-05-17 16:00 ` [PATCH v1 5/8] FatPkg: " Michael Kubacki
@ 2022-05-18 0:58 ` Ni, Ray
0 siblings, 0 replies; 24+ messages in thread
From: Ni, Ray @ 2022-05-18 0:58 UTC (permalink / raw)
To: mikuback@linux.microsoft.com, devel@edk2.groups.io
Reviewed-by: Ray Ni <ray.ni@Intel.com>
> -----Original Message-----
> From: mikuback@linux.microsoft.com <mikuback@linux.microsoft.com>
> Sent: Wednesday, May 18, 2022 12:01 AM
> To: devel@edk2.groups.io
> Cc: Ni, Ray <ray.ni@intel.com>
> Subject: [PATCH v1 5/8] 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",
> + "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 [flat|nested] 24+ messages in thread
* [PATCH v1 6/8] FmpDevicePkg: Fix new typos reported
2022-05-17 16:00 [PATCH v1 0/8] Fix new typos reported Michael Kubacki
` (4 preceding siblings ...)
2022-05-17 16:00 ` [PATCH v1 5/8] FatPkg: " Michael Kubacki
@ 2022-05-17 16:00 ` Michael Kubacki
2022-05-17 16:00 ` [PATCH v1 7/8] ArmPkg: Ignore " Michael Kubacki
` (2 subsequent siblings)
8 siblings, 0 replies; 24+ messages in thread
From: Michael Kubacki @ 2022-05-17 16:00 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] 24+ messages in thread* [PATCH v1 7/8] ArmPkg: Ignore new typos reported
2022-05-17 16:00 [PATCH v1 0/8] Fix new typos reported Michael Kubacki
` (5 preceding siblings ...)
2022-05-17 16:00 ` [PATCH v1 6/8] FmpDevicePkg: " Michael Kubacki
@ 2022-05-17 16:00 ` Michael Kubacki
2022-05-17 16:00 ` [PATCH v1 8/8] ArmVirtPkg: Add new ignored spelling errors Michael Kubacki
2022-05-17 16:13 ` [PATCH v1 0/8] Fix new typos reported Ard Biesheuvel
8 siblings, 0 replies; 24+ messages in thread
From: Michael Kubacki @ 2022-05-17 16:00 UTC (permalink / raw)
To: devel; +Cc: Leif Lindholm, Ard Biesheuvel, Sami Mujawar
From: Michael Kubacki <michael.kubacki@microsoft.com>
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>
---
ArmPkg/ArmPkg.ci.yaml | 55 +++++++++++++++++++-
1 file changed, 53 insertions(+), 2 deletions(-)
diff --git a/ArmPkg/ArmPkg.ci.yaml b/ArmPkg/ArmPkg.ci.yaml
index b7e07aaef675..1874ba61eaaf 100644
--- a/ArmPkg/ArmPkg.ci.yaml
+++ b/ArmPkg/ArmPkg.ci.yaml
@@ -93,20 +93,34 @@
], # use gitignore syntax to ignore errors
# in matching files
"ExtendWords": [
- "api's",
"ackintid",
"actlr",
+ "addressig",
"aeabi",
+ "api's",
+ "armgic",
+ "armltd",
"asedis",
"ashldi",
"ashrdi",
+ "autoreload",
"baddr",
+ "batard",
+ "bootflow",
+ "bootup",
+ "cacheability",
+ "cachetype",
"ccidx",
"ccsidr",
+ "characteritics",
"clidr",
"clrex",
"clzsi",
"cnthctl",
+ "codeview",
+ "commonlpiaff",
+ "comms",
+ "conout",
"cortexa",
"cpacr",
"cpuactlr",
@@ -121,11 +135,15 @@
"dcmple",
"dcmplt",
"ddisable",
+ "deadloop",
+ "devicepath",
+ "directlpi",
"divdi",
"divsi",
"dmdepkg",
"dpref",
"drsub",
+ "everyoneelse",
"fcmpeq",
"fcmpge",
"fcmpgt",
@@ -136,6 +154,7 @@
"hisilicon",
"iccabpr",
"iccbpr",
+ "icceior",
"icciar",
"iccicr",
"icciidr",
@@ -143,24 +162,33 @@
"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",
+ "itstate",
"lable",
+ "langcode",
+ "langcodes",
+ "largepage",
"ldivmod",
"ldmdb",
"ldmia",
@@ -174,25 +202,38 @@
"ldrsb",
"ldrsbt",
"ldrsh",
+ "ldrsht",
+ "littleendian",
"lshrdi",
+ "memclr",
+ "mesaage",
"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 +259,14 @@
"strexd",
"strexh",
"strht",
+ "subhierarchy",
+ "subtrack",
+ "subvendor",
+ "successfull",
+ "supersection",
"switchu",
+ "targetlist",
+ "tmpname",
"tpidrurw",
"ttbcr",
"typer",
@@ -232,7 +280,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
--
2.28.0.windows.1
^ permalink raw reply related [flat|nested] 24+ messages in thread* [PATCH v1 8/8] ArmVirtPkg: Add new ignored spelling errors
2022-05-17 16:00 [PATCH v1 0/8] Fix new typos reported Michael Kubacki
` (6 preceding siblings ...)
2022-05-17 16:00 ` [PATCH v1 7/8] ArmPkg: Ignore " Michael Kubacki
@ 2022-05-17 16:00 ` Michael Kubacki
2022-05-17 16:13 ` [PATCH v1 0/8] Fix new typos reported Ard Biesheuvel
8 siblings, 0 replies; 24+ messages in thread
From: Michael Kubacki @ 2022-05-17 16:00 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>
---
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 d5d63ddd4fd7..e6963a719ea1 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] 24+ messages in thread* Re: [PATCH v1 0/8] Fix new typos reported
2022-05-17 16:00 [PATCH v1 0/8] Fix new typos reported Michael Kubacki
` (7 preceding siblings ...)
2022-05-17 16:00 ` [PATCH v1 8/8] ArmVirtPkg: Add new ignored spelling errors Michael Kubacki
@ 2022-05-17 16:13 ` Ard Biesheuvel
2022-05-17 16:25 ` [edk2-devel] " Michael Kubacki
8 siblings, 1 reply; 24+ messages in thread
From: Ard Biesheuvel @ 2022-05-17 16:13 UTC (permalink / raw)
To: Michael Kubacki
Cc: edk2-devel-groups-io, Alexei Fedorov, Ankit Sinha, Ard Biesheuvel,
Bret Barkelew, 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
Hello Michael,
Thanks for taking care of this. However, I strongly feel that
automation is increasing my workload here rather than the other way
around, for dubious benefits, so as a package maintainer, I am
inclined to disable the spell checks altogether for all the packages I
am in charge of.
On Tue, 17 May 2022 at 18:01, <mikuback@linux.microsoft.com> wrote:
>
> From: Michael Kubacki <michael.kubacki@microsoft.com>
>
> The SpellCheck plugin began reporting new typos that were previously
> missed. This is impacting edk2 pull requests from being completed.
>
> A change in the cspell plugin or some other upstream component may
> have caused them to appear now. This patch series mitigates the
> issue by fixing legitimate spelling issues and adding new ignored
> words if appropriate.
>
> Fixes in ArmPkg were deferred due to the number of reported issues
> in the package. The maintainers should follow up by reviewing the
> extended word list for SpellCheck in ArmPkg.ci.yaml and determining
> the best resolution for each item.
>
> That follow up task for ArmPkg was filed in the following BZ:
> https://bugzilla.tianocore.org/show_bug.cgi?id=3929
>
> Cc: Alexei Fedorov <Alexei.Fedorov@arm.com>
> Cc: Ankit Sinha <ankit.sinha@intel.com>
> Cc: Ard Biesheuvel <ardb+tianocore@kernel.org>
> Cc: Bret Barkelew <Bret.Barkelew@microsoft.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>
>
> Michael Kubacki (8):
> 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
>
> DynamicTablesPkg/Library/Acpi/Arm/AcpiPpttLibArm/PpttGenerator.c | 2 +-
> DynamicTablesPkg/Library/Acpi/Arm/AcpiSsdtCmn600LibArm/SsdtCmn600Generator.c | 2 +-
> DynamicTablesPkg/Library/Common/AmlLib/CodeGen/AmlResourceDataCodeGen.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 +-
> PrmPkg/Test/UnitTest/Library/UefiBootServicesTableLibUnitTest/UefiBootServicesTableLibUnitTestImage.c | 2 +-
> PrmPkg/Test/UnitTest/Library/UefiBootServicesTableLibUnitTest/UefiBootServicesTableLibUnitTestProtocol.c | 2 +-
> StandaloneMmPkg/Core/Dependency.c | 2 +-
> StandaloneMmPkg/Core/Dispatcher.c | 18 +++----
> 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 +-
> ArmPkg/ArmPkg.ci.yaml | 55 +++++++++++++++++++-
> ArmVirtPkg/ArmVirtPkg.ci.yaml | 25 +++++----
> 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 ++++
> PrmPkg/Test/UnitTest/Library/UefiBootServicesTableLibUnitTest/UefiBootServicesTableLibUnitTest.h | 4 +-
> StandaloneMmPkg/Include/Guid/MmCoreData.h | 2 +-
> StandaloneMmPkg/StandaloneMmPkg.ci.yaml | 9 ++++
> UnitTestFrameworkPkg/PrivateInclude/Library/UnitTestBootLib.h | 2 +-
> UnitTestFrameworkPkg/PrivateInclude/UnitTestFrameworkTypes.h | 2 +-
> UnitTestFrameworkPkg/UnitTestFrameworkPkg.ci.yaml | 29 +++++++----
> 45 files changed, 209 insertions(+), 91 deletions(-)
>
> --
> 2.28.0.windows.1
>
^ permalink raw reply [flat|nested] 24+ messages in thread* Re: [edk2-devel] [PATCH v1 0/8] Fix new typos reported
2022-05-17 16:13 ` [PATCH v1 0/8] Fix new typos reported Ard Biesheuvel
@ 2022-05-17 16:25 ` Michael Kubacki
2022-05-17 17:31 ` Ard Biesheuvel
0 siblings, 1 reply; 24+ messages in thread
From: Michael Kubacki @ 2022-05-17 16:25 UTC (permalink / raw)
To: devel, ardb
Cc: Alexei Fedorov, Ankit Sinha, Ard Biesheuvel, Bret Barkelew,
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 Ard,
I think that's a reasonable approach.
We could also consider locking onto a specific cspell version to
decrease the likelihood of this sporadically appearing in the future.
In this case, I would prefer not to make the decision to disable spell
check entirely on behalf of various package maintainers though. I'm just
trying to keep the status quo from unblocking other changes.
Do you think that's something you or others could add as a change on top
of this series?
Thanks,
Michael
On 5/17/2022 12:13 PM, Ard Biesheuvel wrote:
> Hello Michael,
>
> Thanks for taking care of this. However, I strongly feel that
> automation is increasing my workload here rather than the other way
> around, for dubious benefits, so as a package maintainer, I am
> inclined to disable the spell checks altogether for all the packages I
> am in charge of.
>
>
> On Tue, 17 May 2022 at 18:01, <mikuback@linux.microsoft.com> wrote:
>>
>> From: Michael Kubacki <michael.kubacki@microsoft.com>
>>
>> The SpellCheck plugin began reporting new typos that were previously
>> missed. This is impacting edk2 pull requests from being completed.
>>
>> A change in the cspell plugin or some other upstream component may
>> have caused them to appear now. This patch series mitigates the
>> issue by fixing legitimate spelling issues and adding new ignored
>> words if appropriate.
>>
>> Fixes in ArmPkg were deferred due to the number of reported issues
>> in the package. The maintainers should follow up by reviewing the
>> extended word list for SpellCheck in ArmPkg.ci.yaml and determining
>> the best resolution for each item.
>>
>> That follow up task for ArmPkg was filed in the following BZ:
>> https://bugzilla.tianocore.org/show_bug.cgi?id=3929
>>
>> Cc: Alexei Fedorov <Alexei.Fedorov@arm.com>
>> Cc: Ankit Sinha <ankit.sinha@intel.com>
>> Cc: Ard Biesheuvel <ardb+tianocore@kernel.org>
>> Cc: Bret Barkelew <Bret.Barkelew@microsoft.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>
>>
>> Michael Kubacki (8):
>> 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
>>
>> DynamicTablesPkg/Library/Acpi/Arm/AcpiPpttLibArm/PpttGenerator.c | 2 +-
>> DynamicTablesPkg/Library/Acpi/Arm/AcpiSsdtCmn600LibArm/SsdtCmn600Generator.c | 2 +-
>> DynamicTablesPkg/Library/Common/AmlLib/CodeGen/AmlResourceDataCodeGen.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 +-
>> PrmPkg/Test/UnitTest/Library/UefiBootServicesTableLibUnitTest/UefiBootServicesTableLibUnitTestImage.c | 2 +-
>> PrmPkg/Test/UnitTest/Library/UefiBootServicesTableLibUnitTest/UefiBootServicesTableLibUnitTestProtocol.c | 2 +-
>> StandaloneMmPkg/Core/Dependency.c | 2 +-
>> StandaloneMmPkg/Core/Dispatcher.c | 18 +++----
>> 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 +-
>> ArmPkg/ArmPkg.ci.yaml | 55 +++++++++++++++++++-
>> ArmVirtPkg/ArmVirtPkg.ci.yaml | 25 +++++----
>> 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 ++++
>> PrmPkg/Test/UnitTest/Library/UefiBootServicesTableLibUnitTest/UefiBootServicesTableLibUnitTest.h | 4 +-
>> StandaloneMmPkg/Include/Guid/MmCoreData.h | 2 +-
>> StandaloneMmPkg/StandaloneMmPkg.ci.yaml | 9 ++++
>> UnitTestFrameworkPkg/PrivateInclude/Library/UnitTestBootLib.h | 2 +-
>> UnitTestFrameworkPkg/PrivateInclude/UnitTestFrameworkTypes.h | 2 +-
>> UnitTestFrameworkPkg/UnitTestFrameworkPkg.ci.yaml | 29 +++++++----
>> 45 files changed, 209 insertions(+), 91 deletions(-)
>>
>> --
>> 2.28.0.windows.1
>>
>
>
>
>
^ permalink raw reply [flat|nested] 24+ messages in thread
* Re: [edk2-devel] [PATCH v1 0/8] Fix new typos reported
2022-05-17 16:25 ` [edk2-devel] " Michael Kubacki
@ 2022-05-17 17:31 ` Ard Biesheuvel
2022-05-17 19:32 ` Michael Kubacki
0 siblings, 1 reply; 24+ messages in thread
From: Ard Biesheuvel @ 2022-05-17 17:31 UTC (permalink / raw)
To: edk2-devel-groups-io, Michael Kubacki
Cc: Alexei Fedorov, Ankit Sinha, Ard Biesheuvel, Bret Barkelew,
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
On Tue, 17 May 2022 at 18:25, Michael Kubacki
<mikuback@linux.microsoft.com> wrote:
>
> Hi Ard,
>
> I think that's a reasonable approach.
>
> We could also consider locking onto a specific cspell version to
> decrease the likelihood of this sporadically appearing in the future.
>
> In this case, I would prefer not to make the decision to disable spell
> check entirely on behalf of various package maintainers though. I'm just
> trying to keep the status quo from unblocking other changes.
>
> Do you think that's something you or others could add as a change on top
> of this series?
>
I guess that could wait until after the stable tag. However, your
current series adds words such as "addressig" and "characteritics" to
the ignorelist of ArmPkg, and that is something I do have a problem
with: this is just busywork, as there is no confusion whatsoever about
the meaning of the texts in question, nobody is proposing changes to
the code that contains these typos, and adding typos to these
ignorelists is clearly not the correct solution.
CI and automation are fine, but here, they are just creating problems,
resulting in pointless churn, and impeding the stable tag process.
Please, just turn it off.
^ permalink raw reply [flat|nested] 24+ messages in thread
* Re: [edk2-devel] [PATCH v1 0/8] Fix new typos reported
2022-05-17 17:31 ` Ard Biesheuvel
@ 2022-05-17 19:32 ` Michael Kubacki
2022-05-17 20:06 ` Ard Biesheuvel
0 siblings, 1 reply; 24+ messages in thread
From: Michael Kubacki @ 2022-05-17 19:32 UTC (permalink / raw)
To: Ard Biesheuvel, edk2-devel-groups-io
Cc: Alexei Fedorov, Ankit Sinha, Ard Biesheuvel, Bret Barkelew,
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
As noted in the patch, this BZ was filed to follow up and review those:
https://bugzilla.tianocore.org/show_bug.cgi?id=3929
I don't like doing this either but the spelling errors do exist. I am
trying not to make CI policy changes as those can be controversial even
among maintainers in the same package and is an orthogonal conversation
to addressing pre-existing issues within the presently defined CI policy.
In this specific case, the ignore list in the package CI YAML file can
be used to explicitly identify known typos and the BZ explicitly tracks
reviewing those so there's a well defined path to resolve and fix the issue.
I personally feel that's better than ignoring the problem entirely but
it also depends on where your package code ends up getting consumed and
the requirements and burden it might place on those consumers. For
example, if it ends up in auto generated documentation and that
documentation has spell check enabled, it becomes a downstream override.
There's currently several PRs active that fix typos so others see some
value in this work (as opposed to disabling spell checking):
- https://github.com/tianocore/edk2/pull/2900
- https://github.com/tianocore/edk2/pull/2789
- https://github.com/tianocore/edk2/pull/1955
For future changes, I suggested lock the cspell version and I think
that's an option to prevent these from appearing at unknown points in
time. I'm not appointed to make authoritative decisions about that (to
my understanding) so I am making that suggestion for the community to
consider.
Again, I don't have a strong opinion on this topic, I've been waiting 4
weeks to get the v5 patch series merged (other busy work in between),
and you're the maintainer. It sounds like if I take ownership of BZ
3929, you might be okay with leaving it enabled? I can do that but
there's so many words in this instance, I wanted someone closer to the
package contents to look at it.
If you still strongly feel you would prefer to have it disabled, I will
pull that change in and see if any opposing opinions surface. However, I
wanted to double check this is what you want to do right now.
Thanks,
Michael
On 5/17/2022 1:31 PM, Ard Biesheuvel wrote:
> On Tue, 17 May 2022 at 18:25, Michael Kubacki
> <mikuback@linux.microsoft.com> wrote:
>>
>> Hi Ard,
>>
>> I think that's a reasonable approach.
>>
>> We could also consider locking onto a specific cspell version to
>> decrease the likelihood of this sporadically appearing in the future.
>>
>> In this case, I would prefer not to make the decision to disable spell
>> check entirely on behalf of various package maintainers though. I'm just
>> trying to keep the status quo from unblocking other changes.
>>
>> Do you think that's something you or others could add as a change on top
>> of this series?
>>
>
> I guess that could wait until after the stable tag. However, your
> current series adds words such as "addressig" and "characteritics" to
> the ignorelist of ArmPkg, and that is something I do have a problem
> with: this is just busywork, as there is no confusion whatsoever about
> the meaning of the texts in question, nobody is proposing changes to
> the code that contains these typos, and adding typos to these
> ignorelists is clearly not the correct solution.
>
> CI and automation are fine, but here, they are just creating problems,
> resulting in pointless churn, and impeding the stable tag process.
> Please, just turn it off.
^ permalink raw reply [flat|nested] 24+ messages in thread
* Re: [edk2-devel] [PATCH v1 0/8] Fix new typos reported
2022-05-17 19:32 ` Michael Kubacki
@ 2022-05-17 20:06 ` Ard Biesheuvel
2022-05-17 23:50 ` Michael Kubacki
0 siblings, 1 reply; 24+ messages in thread
From: Ard Biesheuvel @ 2022-05-17 20:06 UTC (permalink / raw)
To: Michael Kubacki
Cc: edk2-devel-groups-io, Alexei Fedorov, Ankit Sinha, Ard Biesheuvel,
Bret Barkelew, Gerd Hoffmann, Guomin Jiang, Jiewen Yao,
Leif Lindholm, Liming Gao, Michael D Kinney, Nate DeSimone,
Ray Ni, Sami Mujawar, Sean Brogan, Wei6 Xu
On Tue, 17 May 2022 at 21:32, Michael Kubacki
<mikuback@linux.microsoft.com> wrote:
>
> As noted in the patch, this BZ was filed to follow up and review those:
> https://bugzilla.tianocore.org/show_bug.cgi?id=3929
>
> I don't like doing this either but the spelling errors do exist. I am
> trying not to make CI policy changes as those can be controversial even
> among maintainers in the same package and is an orthogonal conversation
> to addressing pre-existing issues within the presently defined CI policy.
>
> In this specific case, the ignore list in the package CI YAML file can
> be used to explicitly identify known typos and the BZ explicitly tracks
> reviewing those so there's a well defined path to resolve and fix the issue.
>
> I personally feel that's better than ignoring the problem entirely but
> it also depends on where your package code ends up getting consumed and
> the requirements and burden it might place on those consumers. For
> example, if it ends up in auto generated documentation and that
> documentation has spell check enabled, it becomes a downstream override.
>
> There's currently several PRs active that fix typos so others see some
> value in this work (as opposed to disabling spell checking):
> - https://github.com/tianocore/edk2/pull/2900
> - https://github.com/tianocore/edk2/pull/2789
> - https://github.com/tianocore/edk2/pull/1955
>
> For future changes, I suggested lock the cspell version and I think
> that's an option to prevent these from appearing at unknown points in
> time. I'm not appointed to make authoritative decisions about that (to
> my understanding) so I am making that suggestion for the community to
> consider.
>
> Again, I don't have a strong opinion on this topic, I've been waiting 4
> weeks to get the v5 patch series merged (other busy work in between),
> and you're the maintainer. It sounds like if I take ownership of BZ
> 3929, you might be okay with leaving it enabled? I can do that but
> there's so many words in this instance, I wanted someone closer to the
> package contents to look at it.
>
> If you still strongly feel you would prefer to have it disabled, I will
> pull that change in and see if any opposing opinions surface. However, I
> wanted to double check this is what you want to do right now.
>
If you feel it is worth your time to fix typos in existing comments, I
won't stand in your way. But I don't feel it is worth my time, given
that it doesn't actually improve the code, except for by some
artifical measure of spelling-correctness, which has no bearing at all
on what runs on people's machines, and as far as I can tell, these
typoes do not create any confusion regarding what the comments intend
to convey.
Adding typoed words to the ignorelist is the worst possible solution,
because you will be wasting your time only to placate the machine,
accumulating technical debt in the code base without actually fixing
the problems. So that is out of the question for me.
If you want to fix these issues, that is also fine. I will review/ack
with priority provided that I actually have any bandwidth available.
But if we are working for the CI instead of the other way around,
something is seriously wrong. If we can't roll a stable tag because
the CI wants us to fix our typoes first, we have to be able to
override it. And corrupting the codebase by adding typoes to the
ignorelist just to placate the CI is preposterous..
^ permalink raw reply [flat|nested] 24+ messages in thread
* Re: [edk2-devel] [PATCH v1 0/8] Fix new typos reported
2022-05-17 20:06 ` Ard Biesheuvel
@ 2022-05-17 23:50 ` Michael Kubacki
2022-05-18 1:18 ` 回复: " gaoliming
0 siblings, 1 reply; 24+ messages in thread
From: Michael Kubacki @ 2022-05-17 23:50 UTC (permalink / raw)
To: devel, ardb
Cc: Alexei Fedorov, Ankit Sinha, Ard Biesheuvel, Bret Barkelew,
Gerd Hoffmann, Guomin Jiang, Jiewen Yao, Leif Lindholm,
Liming Gao, Michael D Kinney, Nate DeSimone, Ray Ni, Sami Mujawar,
Sean Brogan, Wei6 Xu
Hi Ard,
I understand it is frustrating for things that were working to suddenly
stop and errors to have been missed by the plugin in the past. I'm also
surprised that some of these issues were previously not caught.
To clarify, adding the words to the ignore list was not really that much
time. The plugin output gives the words to add to the list (in JSON) so
that's a copy/paste operation and an IDE can remove duplicate lines
instantly so that was about a 10-30 second or so solution. Submitting
the BZ was another 1-2 minutes
Following the the edk2 contribution process to manually add maintainers
per package, rebase and manually add review tags, parse feedback inline
to unified diffs over email, generate patch files, and update the cover
letter was a relatively larger consumer of time. For v2, I took
ownership of the BZ and spent more time to try to reduce the likelihood
of unexpected issues appearing in the future.
V2 will do the following:
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. Include Sami's code review tags.
I'm checking the CI results in the PR now and once it passes, I'll send
it on the list.
https://github.com/tianocore/edk2/pull/2903
Thanks,
Michael
On 5/17/2022 4:06 PM, Ard Biesheuvel wrote:
> On Tue, 17 May 2022 at 21:32, Michael Kubacki
> <mikuback@linux.microsoft.com> wrote:
>>
>> As noted in the patch, this BZ was filed to follow up and review those:
>> https://bugzilla.tianocore.org/show_bug.cgi?id=3929
>>
>> I don't like doing this either but the spelling errors do exist. I am
>> trying not to make CI policy changes as those can be controversial even
>> among maintainers in the same package and is an orthogonal conversation
>> to addressing pre-existing issues within the presently defined CI policy.
>>
>> In this specific case, the ignore list in the package CI YAML file can
>> be used to explicitly identify known typos and the BZ explicitly tracks
>> reviewing those so there's a well defined path to resolve and fix the issue.
>>
>> I personally feel that's better than ignoring the problem entirely but
>> it also depends on where your package code ends up getting consumed and
>> the requirements and burden it might place on those consumers. For
>> example, if it ends up in auto generated documentation and that
>> documentation has spell check enabled, it becomes a downstream override.
>>
>> There's currently several PRs active that fix typos so others see some
>> value in this work (as opposed to disabling spell checking):
>> - https://github.com/tianocore/edk2/pull/2900
>> - https://github.com/tianocore/edk2/pull/2789
>> - https://github.com/tianocore/edk2/pull/1955
>>
>> For future changes, I suggested lock the cspell version and I think
>> that's an option to prevent these from appearing at unknown points in
>> time. I'm not appointed to make authoritative decisions about that (to
>> my understanding) so I am making that suggestion for the community to
>> consider.
>>
>> Again, I don't have a strong opinion on this topic, I've been waiting 4
>> weeks to get the v5 patch series merged (other busy work in between),
>> and you're the maintainer. It sounds like if I take ownership of BZ
>> 3929, you might be okay with leaving it enabled? I can do that but
>> there's so many words in this instance, I wanted someone closer to the
>> package contents to look at it.
>>
>> If you still strongly feel you would prefer to have it disabled, I will
>> pull that change in and see if any opposing opinions surface. However, I
>> wanted to double check this is what you want to do right now.
>>
>
> If you feel it is worth your time to fix typos in existing comments, I
> won't stand in your way. But I don't feel it is worth my time, given
> that it doesn't actually improve the code, except for by some
> artifical measure of spelling-correctness, which has no bearing at all
> on what runs on people's machines, and as far as I can tell, these
> typoes do not create any confusion regarding what the comments intend
> to convey.
>
> Adding typoed words to the ignorelist is the worst possible solution,
> because you will be wasting your time only to placate the machine,
> accumulating technical debt in the code base without actually fixing
> the problems. So that is out of the question for me.
>
> If you want to fix these issues, that is also fine. I will review/ack
> with priority provided that I actually have any bandwidth available.
>
> But if we are working for the CI instead of the other way around,
> something is seriously wrong. If we can't roll a stable tag because
> the CI wants us to fix our typoes first, we have to be able to
> override it. And corrupting the codebase by adding typoes to the
> ignorelist just to placate the CI is preposterous..
>
>
>
>
^ permalink raw reply [flat|nested] 24+ messages in thread* 回复: [edk2-devel] [PATCH v1 0/8] Fix new typos reported
2022-05-17 23:50 ` Michael Kubacki
@ 2022-05-18 1:18 ` gaoliming
2022-05-18 2:07 ` Michael Kubacki
0 siblings, 1 reply; 24+ messages in thread
From: gaoliming @ 2022-05-18 1:18 UTC (permalink / raw)
To: 'Michael Kubacki', devel, ardb
Cc: 'Alexei Fedorov', 'Ankit Sinha',
'Ard Biesheuvel', 'Bret Barkelew',
'Gerd Hoffmann', 'Guomin Jiang',
'Jiewen Yao', 'Leif Lindholm',
'Michael D Kinney', 'Nate DeSimone',
'Ray Ni', 'Sami Mujawar', 'Sean Brogan',
'Wei6 Xu'
Michael:
Thanks for your quick work to resolve the CI issue. For this issue, if we use the old stable version cspell version, those new issues will not be reported, right? If yes, can we update CI only to unblock PR first for this stable tag? The change in Packages can be made in future.
Thanks
Liming
> -----邮件原件-----
> 发件人: Michael Kubacki <mikuback@linux.microsoft.com>
> 发送时间: 2022年5月18日 7:51
> 收件人: devel@edk2.groups.io; ardb@kernel.org
> 抄送: Alexei Fedorov <Alexei.Fedorov@arm.com>; Ankit Sinha
> <ankit.sinha@intel.com>; Ard Biesheuvel <ardb+tianocore@kernel.org>; Bret
> Barkelew <Bret.Barkelew@microsoft.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>; Wei6 Xu <wei6.xu@intel.com>
> 主题: Re: [edk2-devel] [PATCH v1 0/8] Fix new typos reported
>
> Hi Ard,
>
> I understand it is frustrating for things that were working to suddenly
> stop and errors to have been missed by the plugin in the past. I'm also
> surprised that some of these issues were previously not caught.
>
> To clarify, adding the words to the ignore list was not really that much
> time. The plugin output gives the words to add to the list (in JSON) so
> that's a copy/paste operation and an IDE can remove duplicate lines
> instantly so that was about a 10-30 second or so solution. Submitting
> the BZ was another 1-2 minutes
>
> Following the the edk2 contribution process to manually add maintainers
> per package, rebase and manually add review tags, parse feedback inline
> to unified diffs over email, generate patch files, and update the cover
> letter was a relatively larger consumer of time. For v2, I took
> ownership of the BZ and spent more time to try to reduce the likelihood
> of unexpected issues appearing in the future.
>
> V2 will do the following:
> 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. Include Sami's code review tags.
>
> I'm checking the CI results in the PR now and once it passes, I'll send
> it on the list.
>
> https://github.com/tianocore/edk2/pull/2903
>
> Thanks,
> Michael
>
> On 5/17/2022 4:06 PM, Ard Biesheuvel wrote:
> > On Tue, 17 May 2022 at 21:32, Michael Kubacki
> > <mikuback@linux.microsoft.com> wrote:
> >>
> >> As noted in the patch, this BZ was filed to follow up and review those:
> >> https://bugzilla.tianocore.org/show_bug.cgi?id=3929
> >>
> >> I don't like doing this either but the spelling errors do exist. I am
> >> trying not to make CI policy changes as those can be controversial even
> >> among maintainers in the same package and is an orthogonal conversation
> >> to addressing pre-existing issues within the presently defined CI policy.
> >>
> >> In this specific case, the ignore list in the package CI YAML file can
> >> be used to explicitly identify known typos and the BZ explicitly tracks
> >> reviewing those so there's a well defined path to resolve and fix the issue.
> >>
> >> I personally feel that's better than ignoring the problem entirely but
> >> it also depends on where your package code ends up getting consumed
> and
> >> the requirements and burden it might place on those consumers. For
> >> example, if it ends up in auto generated documentation and that
> >> documentation has spell check enabled, it becomes a downstream
> override.
> >>
> >> There's currently several PRs active that fix typos so others see some
> >> value in this work (as opposed to disabling spell checking):
> >> - https://github.com/tianocore/edk2/pull/2900
> >> - https://github.com/tianocore/edk2/pull/2789
> >> - https://github.com/tianocore/edk2/pull/1955
> >>
> >> For future changes, I suggested lock the cspell version and I think
> >> that's an option to prevent these from appearing at unknown points in
> >> time. I'm not appointed to make authoritative decisions about that (to
> >> my understanding) so I am making that suggestion for the community to
> >> consider.
> >>
> >> Again, I don't have a strong opinion on this topic, I've been waiting 4
> >> weeks to get the v5 patch series merged (other busy work in between),
> >> and you're the maintainer. It sounds like if I take ownership of BZ
> >> 3929, you might be okay with leaving it enabled? I can do that but
> >> there's so many words in this instance, I wanted someone closer to the
> >> package contents to look at it.
> >>
> >> If you still strongly feel you would prefer to have it disabled, I will
> >> pull that change in and see if any opposing opinions surface. However, I
> >> wanted to double check this is what you want to do right now.
> >>
> >
> > If you feel it is worth your time to fix typos in existing comments, I
> > won't stand in your way. But I don't feel it is worth my time, given
> > that it doesn't actually improve the code, except for by some
> > artifical measure of spelling-correctness, which has no bearing at all
> > on what runs on people's machines, and as far as I can tell, these
> > typoes do not create any confusion regarding what the comments intend
> > to convey.
> >
> > Adding typoed words to the ignorelist is the worst possible solution,
> > because you will be wasting your time only to placate the machine,
> > accumulating technical debt in the code base without actually fixing
> > the problems. So that is out of the question for me.
> >
> > If you want to fix these issues, that is also fine. I will review/ack
> > with priority provided that I actually have any bandwidth available.
> >
> > But if we are working for the CI instead of the other way around,
> > something is seriously wrong. If we can't roll a stable tag because
> > the CI wants us to fix our typoes first, we have to be able to
> > override it. And corrupting the codebase by adding typoes to the
> > ignorelist just to placate the CI is preposterous..
> >
> >
> >
> >
^ permalink raw reply [flat|nested] 24+ messages in thread
* Re: 回复: [edk2-devel] [PATCH v1 0/8] Fix new typos reported
2022-05-18 1:18 ` 回复: " gaoliming
@ 2022-05-18 2:07 ` Michael Kubacki
2022-05-18 6:43 ` 回复: " gaoliming
0 siblings, 1 reply; 24+ messages in thread
From: Michael Kubacki @ 2022-05-18 2:07 UTC (permalink / raw)
To: devel, gaoliming, ardb
Cc: 'Alexei Fedorov', 'Ankit Sinha',
'Ard Biesheuvel', 'Bret Barkelew',
'Gerd Hoffmann', 'Guomin Jiang',
'Jiewen Yao', 'Leif Lindholm',
'Michael D Kinney', 'Nate DeSimone',
'Ray Ni', 'Sami Mujawar', 'Sean Brogan',
'Wei6 Xu'
Hi Liming,
That should be true but these are intended to be non-functional changes
(low risk) that should help ease the decision to move to a new version
in the future and help support consumers of the stable tag that might
need spelling fixes.
For example, Project Mu integrates the stable tag and includes the same
checks so they would be beneficial to include from edk2 upstream tag.
edk2 might choose to move to a new version in the future to address a
critical issue like a security vulnerability in the cspell version and
having the changes in place makes that move easier.
Revisiting the same changes in the future will also cause some duplicate
effort at that time so I am hoping they can be merged now.
However, if you prefer to only merge the necessary patches for the tag,
the last three patches [9][10][11] in the v2 series are recommended.
I pushed those commits as-is from the v2 series to the following PR. I'm
using it to check the CI results with these commits.
https://github.com/tianocore/edk2/pull/2904
Thanks,
Michael
On 5/17/2022 9:18 PM, gaoliming wrote:
> Michael:
> Thanks for your quick work to resolve the CI issue. For this issue, if we use the old stable version cspell version, those new issues will not be reported, right? If yes, can we update CI only to unblock PR first for this stable tag? The change in Packages can be made in future.
>
> Thanks
> Liming
>> -----邮件原件-----
>> 发件人: Michael Kubacki <mikuback@linux.microsoft.com>
>> 发送时间: 2022年5月18日 7:51
>> 收件人: devel@edk2.groups.io; ardb@kernel.org
>> 抄送: Alexei Fedorov <Alexei.Fedorov@arm.com>; Ankit Sinha
>> <ankit.sinha@intel.com>; Ard Biesheuvel <ardb+tianocore@kernel.org>; Bret
>> Barkelew <Bret.Barkelew@microsoft.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>; Wei6 Xu <wei6.xu@intel.com>
>> 主题: Re: [edk2-devel] [PATCH v1 0/8] Fix new typos reported
>>
>> Hi Ard,
>>
>> I understand it is frustrating for things that were working to suddenly
>> stop and errors to have been missed by the plugin in the past. I'm also
>> surprised that some of these issues were previously not caught.
>>
>> To clarify, adding the words to the ignore list was not really that much
>> time. The plugin output gives the words to add to the list (in JSON) so
>> that's a copy/paste operation and an IDE can remove duplicate lines
>> instantly so that was about a 10-30 second or so solution. Submitting
>> the BZ was another 1-2 minutes
>>
>> Following the the edk2 contribution process to manually add maintainers
>> per package, rebase and manually add review tags, parse feedback inline
>> to unified diffs over email, generate patch files, and update the cover
>> letter was a relatively larger consumer of time. For v2, I took
>> ownership of the BZ and spent more time to try to reduce the likelihood
>> of unexpected issues appearing in the future.
>>
>> V2 will do the following:
>> 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. Include Sami's code review tags.
>>
>> I'm checking the CI results in the PR now and once it passes, I'll send
>> it on the list.
>>
>> https://github.com/tianocore/edk2/pull/2903
>>
>> Thanks,
>> Michael
>>
>> On 5/17/2022 4:06 PM, Ard Biesheuvel wrote:
>>> On Tue, 17 May 2022 at 21:32, Michael Kubacki
>>> <mikuback@linux.microsoft.com> wrote:
>>>>
>>>> As noted in the patch, this BZ was filed to follow up and review those:
>>>> https://bugzilla.tianocore.org/show_bug.cgi?id=3929
>>>>
>>>> I don't like doing this either but the spelling errors do exist. I am
>>>> trying not to make CI policy changes as those can be controversial even
>>>> among maintainers in the same package and is an orthogonal conversation
>>>> to addressing pre-existing issues within the presently defined CI policy.
>>>>
>>>> In this specific case, the ignore list in the package CI YAML file can
>>>> be used to explicitly identify known typos and the BZ explicitly tracks
>>>> reviewing those so there's a well defined path to resolve and fix the issue.
>>>>
>>>> I personally feel that's better than ignoring the problem entirely but
>>>> it also depends on where your package code ends up getting consumed
>> and
>>>> the requirements and burden it might place on those consumers. For
>>>> example, if it ends up in auto generated documentation and that
>>>> documentation has spell check enabled, it becomes a downstream
>> override.
>>>>
>>>> There's currently several PRs active that fix typos so others see some
>>>> value in this work (as opposed to disabling spell checking):
>>>> - https://github.com/tianocore/edk2/pull/2900
>>>> - https://github.com/tianocore/edk2/pull/2789
>>>> - https://github.com/tianocore/edk2/pull/1955
>>>>
>>>> For future changes, I suggested lock the cspell version and I think
>>>> that's an option to prevent these from appearing at unknown points in
>>>> time. I'm not appointed to make authoritative decisions about that (to
>>>> my understanding) so I am making that suggestion for the community to
>>>> consider.
>>>>
>>>> Again, I don't have a strong opinion on this topic, I've been waiting 4
>>>> weeks to get the v5 patch series merged (other busy work in between),
>>>> and you're the maintainer. It sounds like if I take ownership of BZ
>>>> 3929, you might be okay with leaving it enabled? I can do that but
>>>> there's so many words in this instance, I wanted someone closer to the
>>>> package contents to look at it.
>>>>
>>>> If you still strongly feel you would prefer to have it disabled, I will
>>>> pull that change in and see if any opposing opinions surface. However, I
>>>> wanted to double check this is what you want to do right now.
>>>>
>>>
>>> If you feel it is worth your time to fix typos in existing comments, I
>>> won't stand in your way. But I don't feel it is worth my time, given
>>> that it doesn't actually improve the code, except for by some
>>> artifical measure of spelling-correctness, which has no bearing at all
>>> on what runs on people's machines, and as far as I can tell, these
>>> typoes do not create any confusion regarding what the comments intend
>>> to convey.
>>>
>>> Adding typoed words to the ignorelist is the worst possible solution,
>>> because you will be wasting your time only to placate the machine,
>>> accumulating technical debt in the code base without actually fixing
>>> the problems. So that is out of the question for me.
>>>
>>> If you want to fix these issues, that is also fine. I will review/ack
>>> with priority provided that I actually have any bandwidth available.
>>>
>>> But if we are working for the CI instead of the other way around,
>>> something is seriously wrong. If we can't roll a stable tag because
>>> the CI wants us to fix our typoes first, we have to be able to
>>> override it. And corrupting the codebase by adding typoes to the
>>> ignorelist just to placate the CI is preposterous..
>>>
>>>
>>>
>>>
>
>
>
>
>
>
>
>
^ permalink raw reply [flat|nested] 24+ messages in thread
* 回复: 回复: [edk2-devel] [PATCH v1 0/8] Fix new typos reported
2022-05-18 2:07 ` Michael Kubacki
@ 2022-05-18 6:43 ` gaoliming
2022-05-18 14:52 ` Michael Kubacki
0 siblings, 1 reply; 24+ messages in thread
From: gaoliming @ 2022-05-18 6:43 UTC (permalink / raw)
To: devel, mikuback, ardb
Cc: 'Alexei Fedorov', 'Ankit Sinha',
'Ard Biesheuvel', 'Bret Barkelew',
'Gerd Hoffmann', 'Guomin Jiang',
'Jiewen Yao', 'Leif Lindholm',
'Michael D Kinney', 'Nate DeSimone',
'Ray Ni', 'Sami Mujawar', 'Sean Brogan',
'Wei6 Xu'
Michael:
Thanks for your update. I prefer to merge the necessary changes for this stable tag. The remaining change can be reviewed after the stable tag.
Thanks
Liming
> -----邮件原件-----
> 发件人: devel@edk2.groups.io <devel@edk2.groups.io> 代表 Michael
> Kubacki
> 发送时间: 2022年5月18日 10:07
> 收件人: devel@edk2.groups.io; gaoliming@byosoft.com.cn; ardb@kernel.org
> 抄送: 'Alexei Fedorov' <Alexei.Fedorov@arm.com>; 'Ankit Sinha'
> <ankit.sinha@intel.com>; 'Ard Biesheuvel' <ardb+tianocore@kernel.org>;
> 'Bret Barkelew' <Bret.Barkelew@microsoft.com>; 'Gerd Hoffmann'
> <kraxel@redhat.com>; 'Guomin Jiang' <guomin.jiang@intel.com>; 'Jiewen
> Yao' <jiewen.yao@intel.com>; 'Leif Lindholm' <quic_llindhol@quicinc.com>;
> '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>; 'Wei6 Xu' <wei6.xu@intel.com>
> 主题: Re: 回复: [edk2-devel] [PATCH v1 0/8] Fix new typos reported
>
> Hi Liming,
>
> That should be true but these are intended to be non-functional changes
> (low risk) that should help ease the decision to move to a new version
> in the future and help support consumers of the stable tag that might
> need spelling fixes.
>
> For example, Project Mu integrates the stable tag and includes the same
> checks so they would be beneficial to include from edk2 upstream tag.
> edk2 might choose to move to a new version in the future to address a
> critical issue like a security vulnerability in the cspell version and
> having the changes in place makes that move easier.
>
> Revisiting the same changes in the future will also cause some duplicate
> effort at that time so I am hoping they can be merged now.
>
> However, if you prefer to only merge the necessary patches for the tag,
> the last three patches [9][10][11] in the v2 series are recommended.
>
> I pushed those commits as-is from the v2 series to the following PR. I'm
> using it to check the CI results with these commits.
>
> https://github.com/tianocore/edk2/pull/2904
>
> Thanks,
> Michael
>
> On 5/17/2022 9:18 PM, gaoliming wrote:
> > Michael:
> > Thanks for your quick work to resolve the CI issue. For this issue, if we
> use the old stable version cspell version, those new issues will not be reported,
> right? If yes, can we update CI only to unblock PR first for this stable tag? The
> change in Packages can be made in future.
> >
> > Thanks
> > Liming
> >> -----邮件原件-----
> >> 发件人: Michael Kubacki <mikuback@linux.microsoft.com>
> >> 发送时间: 2022年5月18日 7:51
> >> 收件人: devel@edk2.groups.io; ardb@kernel.org
> >> 抄送: Alexei Fedorov <Alexei.Fedorov@arm.com>; Ankit Sinha
> >> <ankit.sinha@intel.com>; Ard Biesheuvel <ardb+tianocore@kernel.org>;
> Bret
> >> Barkelew <Bret.Barkelew@microsoft.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>; Wei6 Xu <wei6.xu@intel.com>
> >> 主题: Re: [edk2-devel] [PATCH v1 0/8] Fix new typos reported
> >>
> >> Hi Ard,
> >>
> >> I understand it is frustrating for things that were working to suddenly
> >> stop and errors to have been missed by the plugin in the past. I'm also
> >> surprised that some of these issues were previously not caught.
> >>
> >> To clarify, adding the words to the ignore list was not really that much
> >> time. The plugin output gives the words to add to the list (in JSON) so
> >> that's a copy/paste operation and an IDE can remove duplicate lines
> >> instantly so that was about a 10-30 second or so solution. Submitting
> >> the BZ was another 1-2 minutes
> >>
> >> Following the the edk2 contribution process to manually add maintainers
> >> per package, rebase and manually add review tags, parse feedback inline
> >> to unified diffs over email, generate patch files, and update the cover
> >> letter was a relatively larger consumer of time. For v2, I took
> >> ownership of the BZ and spent more time to try to reduce the likelihood
> >> of unexpected issues appearing in the future.
> >>
> >> V2 will do the following:
> >> 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. Include Sami's code review tags.
> >>
> >> I'm checking the CI results in the PR now and once it passes, I'll send
> >> it on the list.
> >>
> >> https://github.com/tianocore/edk2/pull/2903
> >>
> >> Thanks,
> >> Michael
> >>
> >> On 5/17/2022 4:06 PM, Ard Biesheuvel wrote:
> >>> On Tue, 17 May 2022 at 21:32, Michael Kubacki
> >>> <mikuback@linux.microsoft.com> wrote:
> >>>>
> >>>> As noted in the patch, this BZ was filed to follow up and review those:
> >>>> https://bugzilla.tianocore.org/show_bug.cgi?id=3929
> >>>>
> >>>> I don't like doing this either but the spelling errors do exist. I am
> >>>> trying not to make CI policy changes as those can be controversial even
> >>>> among maintainers in the same package and is an orthogonal
> conversation
> >>>> to addressing pre-existing issues within the presently defined CI policy.
> >>>>
> >>>> In this specific case, the ignore list in the package CI YAML file can
> >>>> be used to explicitly identify known typos and the BZ explicitly tracks
> >>>> reviewing those so there's a well defined path to resolve and fix the
> issue.
> >>>>
> >>>> I personally feel that's better than ignoring the problem entirely but
> >>>> it also depends on where your package code ends up getting consumed
> >> and
> >>>> the requirements and burden it might place on those consumers. For
> >>>> example, if it ends up in auto generated documentation and that
> >>>> documentation has spell check enabled, it becomes a downstream
> >> override.
> >>>>
> >>>> There's currently several PRs active that fix typos so others see some
> >>>> value in this work (as opposed to disabling spell checking):
> >>>> - https://github.com/tianocore/edk2/pull/2900
> >>>> - https://github.com/tianocore/edk2/pull/2789
> >>>> - https://github.com/tianocore/edk2/pull/1955
> >>>>
> >>>> For future changes, I suggested lock the cspell version and I think
> >>>> that's an option to prevent these from appearing at unknown points in
> >>>> time. I'm not appointed to make authoritative decisions about that (to
> >>>> my understanding) so I am making that suggestion for the community to
> >>>> consider.
> >>>>
> >>>> Again, I don't have a strong opinion on this topic, I've been waiting 4
> >>>> weeks to get the v5 patch series merged (other busy work in between),
> >>>> and you're the maintainer. It sounds like if I take ownership of BZ
> >>>> 3929, you might be okay with leaving it enabled? I can do that but
> >>>> there's so many words in this instance, I wanted someone closer to the
> >>>> package contents to look at it.
> >>>>
> >>>> If you still strongly feel you would prefer to have it disabled, I will
> >>>> pull that change in and see if any opposing opinions surface. However, I
> >>>> wanted to double check this is what you want to do right now.
> >>>>
> >>>
> >>> If you feel it is worth your time to fix typos in existing comments, I
> >>> won't stand in your way. But I don't feel it is worth my time, given
> >>> that it doesn't actually improve the code, except for by some
> >>> artifical measure of spelling-correctness, which has no bearing at all
> >>> on what runs on people's machines, and as far as I can tell, these
> >>> typoes do not create any confusion regarding what the comments intend
> >>> to convey.
> >>>
> >>> Adding typoed words to the ignorelist is the worst possible solution,
> >>> because you will be wasting your time only to placate the machine,
> >>> accumulating technical debt in the code base without actually fixing
> >>> the problems. So that is out of the question for me.
> >>>
> >>> If you want to fix these issues, that is also fine. I will review/ack
> >>> with priority provided that I actually have any bandwidth available.
> >>>
> >>> But if we are working for the CI instead of the other way around,
> >>> something is seriously wrong. If we can't roll a stable tag because
> >>> the CI wants us to fix our typoes first, we have to be able to
> >>> override it. And corrupting the codebase by adding typoes to the
> >>> ignorelist just to placate the CI is preposterous..
> >>>
> >>>
> >>>
> >>>
> >
> >
> >
> >
> >
> >
> >
> >
>
>
>
>
^ permalink raw reply [flat|nested] 24+ messages in thread
* Re: 回复: 回复: [edk2-devel] [PATCH v1 0/8] Fix new typos reported
2022-05-18 6:43 ` 回复: " gaoliming
@ 2022-05-18 14:52 ` Michael Kubacki
2022-05-19 1:23 ` 回复: " gaoliming
0 siblings, 1 reply; 24+ messages in thread
From: Michael Kubacki @ 2022-05-18 14:52 UTC (permalink / raw)
To: devel, gaoliming, ardb
Cc: 'Alexei Fedorov', 'Ankit Sinha',
'Ard Biesheuvel', 'Bret Barkelew',
'Gerd Hoffmann', 'Guomin Jiang',
'Jiewen Yao', 'Leif Lindholm',
'Michael D Kinney', 'Nate DeSimone',
'Ray Ni', 'Sami Mujawar', 'Sean Brogan',
'Wei6 Xu'
Sounds good. Let me know if anything else is needed for the stable tag.
Thanks,
Michael
On 5/18/2022 2:43 AM, gaoliming wrote:
> Michael:
> Thanks for your update. I prefer to merge the necessary changes for this stable tag. The remaining change can be reviewed after the stable tag.
>
> Thanks
> Liming
>> -----邮件原件-----
>> 发件人: devel@edk2.groups.io <devel@edk2.groups.io> 代表 Michael
>> Kubacki
>> 发送时间: 2022年5月18日 10:07
>> 收件人: devel@edk2.groups.io; gaoliming@byosoft.com.cn; ardb@kernel.org
>> 抄送: 'Alexei Fedorov' <Alexei.Fedorov@arm.com>; 'Ankit Sinha'
>> <ankit.sinha@intel.com>; 'Ard Biesheuvel' <ardb+tianocore@kernel.org>;
>> 'Bret Barkelew' <Bret.Barkelew@microsoft.com>; 'Gerd Hoffmann'
>> <kraxel@redhat.com>; 'Guomin Jiang' <guomin.jiang@intel.com>; 'Jiewen
>> Yao' <jiewen.yao@intel.com>; 'Leif Lindholm' <quic_llindhol@quicinc.com>;
>> '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>; 'Wei6 Xu' <wei6.xu@intel.com>
>> 主题: Re: 回复: [edk2-devel] [PATCH v1 0/8] Fix new typos reported
>>
>> Hi Liming,
>>
>> That should be true but these are intended to be non-functional changes
>> (low risk) that should help ease the decision to move to a new version
>> in the future and help support consumers of the stable tag that might
>> need spelling fixes.
>>
>> For example, Project Mu integrates the stable tag and includes the same
>> checks so they would be beneficial to include from edk2 upstream tag.
>> edk2 might choose to move to a new version in the future to address a
>> critical issue like a security vulnerability in the cspell version and
>> having the changes in place makes that move easier.
>>
>> Revisiting the same changes in the future will also cause some duplicate
>> effort at that time so I am hoping they can be merged now.
>>
>> However, if you prefer to only merge the necessary patches for the tag,
>> the last three patches [9][10][11] in the v2 series are recommended.
>>
>> I pushed those commits as-is from the v2 series to the following PR. I'm
>> using it to check the CI results with these commits.
>>
>> https://github.com/tianocore/edk2/pull/2904
>>
>> Thanks,
>> Michael
>>
>> On 5/17/2022 9:18 PM, gaoliming wrote:
>>> Michael:
>>> Thanks for your quick work to resolve the CI issue. For this issue, if we
>> use the old stable version cspell version, those new issues will not be reported,
>> right? If yes, can we update CI only to unblock PR first for this stable tag? The
>> change in Packages can be made in future.
>>>
>>> Thanks
>>> Liming
>>>> -----邮件原件-----
>>>> 发件人: Michael Kubacki <mikuback@linux.microsoft.com>
>>>> 发送时间: 2022年5月18日 7:51
>>>> 收件人: devel@edk2.groups.io; ardb@kernel.org
>>>> 抄送: Alexei Fedorov <Alexei.Fedorov@arm.com>; Ankit Sinha
>>>> <ankit.sinha@intel.com>; Ard Biesheuvel <ardb+tianocore@kernel.org>;
>> Bret
>>>> Barkelew <Bret.Barkelew@microsoft.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>; Wei6 Xu <wei6.xu@intel.com>
>>>> 主题: Re: [edk2-devel] [PATCH v1 0/8] Fix new typos reported
>>>>
>>>> Hi Ard,
>>>>
>>>> I understand it is frustrating for things that were working to suddenly
>>>> stop and errors to have been missed by the plugin in the past. I'm also
>>>> surprised that some of these issues were previously not caught.
>>>>
>>>> To clarify, adding the words to the ignore list was not really that much
>>>> time. The plugin output gives the words to add to the list (in JSON) so
>>>> that's a copy/paste operation and an IDE can remove duplicate lines
>>>> instantly so that was about a 10-30 second or so solution. Submitting
>>>> the BZ was another 1-2 minutes
>>>>
>>>> Following the the edk2 contribution process to manually add maintainers
>>>> per package, rebase and manually add review tags, parse feedback inline
>>>> to unified diffs over email, generate patch files, and update the cover
>>>> letter was a relatively larger consumer of time. For v2, I took
>>>> ownership of the BZ and spent more time to try to reduce the likelihood
>>>> of unexpected issues appearing in the future.
>>>>
>>>> V2 will do the following:
>>>> 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. Include Sami's code review tags.
>>>>
>>>> I'm checking the CI results in the PR now and once it passes, I'll send
>>>> it on the list.
>>>>
>>>> https://github.com/tianocore/edk2/pull/2903
>>>>
>>>> Thanks,
>>>> Michael
>>>>
>>>> On 5/17/2022 4:06 PM, Ard Biesheuvel wrote:
>>>>> On Tue, 17 May 2022 at 21:32, Michael Kubacki
>>>>> <mikuback@linux.microsoft.com> wrote:
>>>>>>
>>>>>> As noted in the patch, this BZ was filed to follow up and review those:
>>>>>> https://bugzilla.tianocore.org/show_bug.cgi?id=3929
>>>>>>
>>>>>> I don't like doing this either but the spelling errors do exist. I am
>>>>>> trying not to make CI policy changes as those can be controversial even
>>>>>> among maintainers in the same package and is an orthogonal
>> conversation
>>>>>> to addressing pre-existing issues within the presently defined CI policy.
>>>>>>
>>>>>> In this specific case, the ignore list in the package CI YAML file can
>>>>>> be used to explicitly identify known typos and the BZ explicitly tracks
>>>>>> reviewing those so there's a well defined path to resolve and fix the
>> issue.
>>>>>>
>>>>>> I personally feel that's better than ignoring the problem entirely but
>>>>>> it also depends on where your package code ends up getting consumed
>>>> and
>>>>>> the requirements and burden it might place on those consumers. For
>>>>>> example, if it ends up in auto generated documentation and that
>>>>>> documentation has spell check enabled, it becomes a downstream
>>>> override.
>>>>>>
>>>>>> There's currently several PRs active that fix typos so others see some
>>>>>> value in this work (as opposed to disabling spell checking):
>>>>>> - https://github.com/tianocore/edk2/pull/2900
>>>>>> - https://github.com/tianocore/edk2/pull/2789
>>>>>> - https://github.com/tianocore/edk2/pull/1955
>>>>>>
>>>>>> For future changes, I suggested lock the cspell version and I think
>>>>>> that's an option to prevent these from appearing at unknown points in
>>>>>> time. I'm not appointed to make authoritative decisions about that (to
>>>>>> my understanding) so I am making that suggestion for the community to
>>>>>> consider.
>>>>>>
>>>>>> Again, I don't have a strong opinion on this topic, I've been waiting 4
>>>>>> weeks to get the v5 patch series merged (other busy work in between),
>>>>>> and you're the maintainer. It sounds like if I take ownership of BZ
>>>>>> 3929, you might be okay with leaving it enabled? I can do that but
>>>>>> there's so many words in this instance, I wanted someone closer to the
>>>>>> package contents to look at it.
>>>>>>
>>>>>> If you still strongly feel you would prefer to have it disabled, I will
>>>>>> pull that change in and see if any opposing opinions surface. However, I
>>>>>> wanted to double check this is what you want to do right now.
>>>>>>
>>>>>
>>>>> If you feel it is worth your time to fix typos in existing comments, I
>>>>> won't stand in your way. But I don't feel it is worth my time, given
>>>>> that it doesn't actually improve the code, except for by some
>>>>> artifical measure of spelling-correctness, which has no bearing at all
>>>>> on what runs on people's machines, and as far as I can tell, these
>>>>> typoes do not create any confusion regarding what the comments intend
>>>>> to convey.
>>>>>
>>>>> Adding typoed words to the ignorelist is the worst possible solution,
>>>>> because you will be wasting your time only to placate the machine,
>>>>> accumulating technical debt in the code base without actually fixing
>>>>> the problems. So that is out of the question for me.
>>>>>
>>>>> If you want to fix these issues, that is also fine. I will review/ack
>>>>> with priority provided that I actually have any bandwidth available.
>>>>>
>>>>> But if we are working for the CI instead of the other way around,
>>>>> something is seriously wrong. If we can't roll a stable tag because
>>>>> the CI wants us to fix our typoes first, we have to be able to
>>>>> override it. And corrupting the codebase by adding typoes to the
>>>>> ignorelist just to placate the CI is preposterous..
>>>>>
>>>>>
>>>>>
>>>>>
>>>
>>>
>>>
>>>
>>>
>>>
>>>
>>>
>>
>>
>>
>>
>
>
>
>
>
>
>
^ permalink raw reply [flat|nested] 24+ messages in thread
* 回复: 回复: 回复: [edk2-devel] [PATCH v1 0/8] Fix new typos reported
2022-05-18 14:52 ` Michael Kubacki
@ 2022-05-19 1:23 ` gaoliming
0 siblings, 0 replies; 24+ messages in thread
From: gaoliming @ 2022-05-19 1:23 UTC (permalink / raw)
To: 'Michael Kubacki', devel, ardb
Cc: 'Alexei Fedorov', 'Ankit Sinha',
'Ard Biesheuvel', 'Bret Barkelew',
'Gerd Hoffmann', 'Guomin Jiang',
'Jiewen Yao', 'Leif Lindholm',
'Michael D Kinney', 'Nate DeSimone',
'Ray Ni', 'Sami Mujawar', 'Sean Brogan',
'Wei6 Xu'
For the changes in CI , Reviewed-by: Liming Gao <gaoliming@byosoft.com.cn>.
Create PR https://github.com/tianocore/edk2/pull/2906 to merge it for this stable tag.
Thanks
Liming
> -----邮件原件-----
> 发件人: Michael Kubacki <mikuback@linux.microsoft.com>
> 发送时间: 2022年5月18日 22:52
> 收件人: devel@edk2.groups.io; gaoliming@byosoft.com.cn; ardb@kernel.org
> 抄送: 'Alexei Fedorov' <Alexei.Fedorov@arm.com>; 'Ankit Sinha'
> <ankit.sinha@intel.com>; 'Ard Biesheuvel' <ardb+tianocore@kernel.org>;
> 'Bret Barkelew' <Bret.Barkelew@microsoft.com>; 'Gerd Hoffmann'
> <kraxel@redhat.com>; 'Guomin Jiang' <guomin.jiang@intel.com>; 'Jiewen
> Yao' <jiewen.yao@intel.com>; 'Leif Lindholm' <quic_llindhol@quicinc.com>;
> '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>; 'Wei6 Xu' <wei6.xu@intel.com>
> 主题: Re: 回复: 回复: [edk2-devel] [PATCH v1 0/8] Fix new typos reported
>
> Sounds good. Let me know if anything else is needed for the stable tag.
>
> Thanks,
> Michael
>
> On 5/18/2022 2:43 AM, gaoliming wrote:
> > Michael:
> > Thanks for your update. I prefer to merge the necessary changes for
> this stable tag. The remaining change can be reviewed after the stable tag.
> >
> > Thanks
> > Liming
> >> -----邮件原件-----
> >> 发件人: devel@edk2.groups.io <devel@edk2.groups.io> 代表 Michael
> >> Kubacki
> >> 发送时间: 2022年5月18日 10:07
> >> 收件人: devel@edk2.groups.io; gaoliming@byosoft.com.cn;
> ardb@kernel.org
> >> 抄送: 'Alexei Fedorov' <Alexei.Fedorov@arm.com>; 'Ankit Sinha'
> >> <ankit.sinha@intel.com>; 'Ard Biesheuvel' <ardb+tianocore@kernel.org>;
> >> 'Bret Barkelew' <Bret.Barkelew@microsoft.com>; 'Gerd Hoffmann'
> >> <kraxel@redhat.com>; 'Guomin Jiang' <guomin.jiang@intel.com>; 'Jiewen
> >> Yao' <jiewen.yao@intel.com>; 'Leif Lindholm'
> <quic_llindhol@quicinc.com>;
> >> '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>; 'Wei6 Xu' <wei6.xu@intel.com>
> >> 主题: Re: 回复: [edk2-devel] [PATCH v1 0/8] Fix new typos reported
> >>
> >> Hi Liming,
> >>
> >> That should be true but these are intended to be non-functional changes
> >> (low risk) that should help ease the decision to move to a new version
> >> in the future and help support consumers of the stable tag that might
> >> need spelling fixes.
> >>
> >> For example, Project Mu integrates the stable tag and includes the same
> >> checks so they would be beneficial to include from edk2 upstream tag.
> >> edk2 might choose to move to a new version in the future to address a
> >> critical issue like a security vulnerability in the cspell version and
> >> having the changes in place makes that move easier.
> >>
> >> Revisiting the same changes in the future will also cause some duplicate
> >> effort at that time so I am hoping they can be merged now.
> >>
> >> However, if you prefer to only merge the necessary patches for the tag,
> >> the last three patches [9][10][11] in the v2 series are recommended.
> >>
> >> I pushed those commits as-is from the v2 series to the following PR. I'm
> >> using it to check the CI results with these commits.
> >>
> >> https://github.com/tianocore/edk2/pull/2904
> >>
> >> Thanks,
> >> Michael
> >>
> >> On 5/17/2022 9:18 PM, gaoliming wrote:
> >>> Michael:
> >>> Thanks for your quick work to resolve the CI issue. For this issue, if
> we
> >> use the old stable version cspell version, those new issues will not be
> reported,
> >> right? If yes, can we update CI only to unblock PR first for this stable tag?
> The
> >> change in Packages can be made in future.
> >>>
> >>> Thanks
> >>> Liming
> >>>> -----邮件原件-----
> >>>> 发件人: Michael Kubacki <mikuback@linux.microsoft.com>
> >>>> 发送时间: 2022年5月18日 7:51
> >>>> 收件人: devel@edk2.groups.io; ardb@kernel.org
> >>>> 抄送: Alexei Fedorov <Alexei.Fedorov@arm.com>; Ankit Sinha
> >>>> <ankit.sinha@intel.com>; Ard Biesheuvel
> <ardb+tianocore@kernel.org>;
> >> Bret
> >>>> Barkelew <Bret.Barkelew@microsoft.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>; Wei6 Xu <wei6.xu@intel.com>
> >>>> 主题: Re: [edk2-devel] [PATCH v1 0/8] Fix new typos reported
> >>>>
> >>>> Hi Ard,
> >>>>
> >>>> I understand it is frustrating for things that were working to suddenly
> >>>> stop and errors to have been missed by the plugin in the past. I'm also
> >>>> surprised that some of these issues were previously not caught.
> >>>>
> >>>> To clarify, adding the words to the ignore list was not really that much
> >>>> time. The plugin output gives the words to add to the list (in JSON) so
> >>>> that's a copy/paste operation and an IDE can remove duplicate lines
> >>>> instantly so that was about a 10-30 second or so solution. Submitting
> >>>> the BZ was another 1-2 minutes
> >>>>
> >>>> Following the the edk2 contribution process to manually add
> maintainers
> >>>> per package, rebase and manually add review tags, parse feedback
> inline
> >>>> to unified diffs over email, generate patch files, and update the cover
> >>>> letter was a relatively larger consumer of time. For v2, I took
> >>>> ownership of the BZ and spent more time to try to reduce the likelihood
> >>>> of unexpected issues appearing in the future.
> >>>>
> >>>> V2 will do the following:
> >>>> 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. Include Sami's code review tags.
> >>>>
> >>>> I'm checking the CI results in the PR now and once it passes, I'll send
> >>>> it on the list.
> >>>>
> >>>> https://github.com/tianocore/edk2/pull/2903
> >>>>
> >>>> Thanks,
> >>>> Michael
> >>>>
> >>>> On 5/17/2022 4:06 PM, Ard Biesheuvel wrote:
> >>>>> On Tue, 17 May 2022 at 21:32, Michael Kubacki
> >>>>> <mikuback@linux.microsoft.com> wrote:
> >>>>>>
> >>>>>> As noted in the patch, this BZ was filed to follow up and review those:
> >>>>>> https://bugzilla.tianocore.org/show_bug.cgi?id=3929
> >>>>>>
> >>>>>> I don't like doing this either but the spelling errors do exist. I am
> >>>>>> trying not to make CI policy changes as those can be controversial
> even
> >>>>>> among maintainers in the same package and is an orthogonal
> >> conversation
> >>>>>> to addressing pre-existing issues within the presently defined CI
> policy.
> >>>>>>
> >>>>>> In this specific case, the ignore list in the package CI YAML file can
> >>>>>> be used to explicitly identify known typos and the BZ explicitly tracks
> >>>>>> reviewing those so there's a well defined path to resolve and fix the
> >> issue.
> >>>>>>
> >>>>>> I personally feel that's better than ignoring the problem entirely but
> >>>>>> it also depends on where your package code ends up getting
> consumed
> >>>> and
> >>>>>> the requirements and burden it might place on those consumers. For
> >>>>>> example, if it ends up in auto generated documentation and that
> >>>>>> documentation has spell check enabled, it becomes a downstream
> >>>> override.
> >>>>>>
> >>>>>> There's currently several PRs active that fix typos so others see some
> >>>>>> value in this work (as opposed to disabling spell checking):
> >>>>>> - https://github.com/tianocore/edk2/pull/2900
> >>>>>> - https://github.com/tianocore/edk2/pull/2789
> >>>>>> - https://github.com/tianocore/edk2/pull/1955
> >>>>>>
> >>>>>> For future changes, I suggested lock the cspell version and I think
> >>>>>> that's an option to prevent these from appearing at unknown points in
> >>>>>> time. I'm not appointed to make authoritative decisions about that (to
> >>>>>> my understanding) so I am making that suggestion for the community
> to
> >>>>>> consider.
> >>>>>>
> >>>>>> Again, I don't have a strong opinion on this topic, I've been waiting 4
> >>>>>> weeks to get the v5 patch series merged (other busy work in
> between),
> >>>>>> and you're the maintainer. It sounds like if I take ownership of BZ
> >>>>>> 3929, you might be okay with leaving it enabled? I can do that but
> >>>>>> there's so many words in this instance, I wanted someone closer to
> the
> >>>>>> package contents to look at it.
> >>>>>>
> >>>>>> If you still strongly feel you would prefer to have it disabled, I will
> >>>>>> pull that change in and see if any opposing opinions surface. However,
> I
> >>>>>> wanted to double check this is what you want to do right now.
> >>>>>>
> >>>>>
> >>>>> If you feel it is worth your time to fix typos in existing comments, I
> >>>>> won't stand in your way. But I don't feel it is worth my time, given
> >>>>> that it doesn't actually improve the code, except for by some
> >>>>> artifical measure of spelling-correctness, which has no bearing at all
> >>>>> on what runs on people's machines, and as far as I can tell, these
> >>>>> typoes do not create any confusion regarding what the comments
> intend
> >>>>> to convey.
> >>>>>
> >>>>> Adding typoed words to the ignorelist is the worst possible solution,
> >>>>> because you will be wasting your time only to placate the machine,
> >>>>> accumulating technical debt in the code base without actually fixing
> >>>>> the problems. So that is out of the question for me.
> >>>>>
> >>>>> If you want to fix these issues, that is also fine. I will review/ack
> >>>>> with priority provided that I actually have any bandwidth available.
> >>>>>
> >>>>> But if we are working for the CI instead of the other way around,
> >>>>> something is seriously wrong. If we can't roll a stable tag because
> >>>>> the CI wants us to fix our typoes first, we have to be able to
> >>>>> override it. And corrupting the codebase by adding typoes to the
> >>>>> ignorelist just to placate the CI is preposterous..
> >>>>>
> >>>>>
> >>>>>
> >>>>>
> >>>
> >>>
> >>>
> >>>
> >>>
> >>>
> >>>
> >>>
> >>
> >>
> >>
> >>
> >
> >
> >
> >
> >
> >
> >
^ permalink raw reply [flat|nested] 24+ messages in thread