public inbox for devel@edk2.groups.io
 help / color / mirror / Atom feed
From: "Michael Kubacki" <mikuback@linux.microsoft.com>
To: devel@edk2.groups.io
Cc: Michael D Kinney <michael.d.kinney@intel.com>,
	Michael Kubacki <mikuback@linux.microsoft.com>,
	Sean Brogan <sean.brogan@microsoft.com>,
	Bret Barkelew <Bret.Barkelew@microsoft.com>
Subject: [PATCH v2 04/11] UnitTestFrameworkPkg: Fix new typos reported
Date: Tue, 17 May 2022 20:13:31 -0400	[thread overview]
Message-ID: <20220518001338.1380-5-mikuback@linux.microsoft.com> (raw)
In-Reply-To: <20220518001338.1380-1-mikuback@linux.microsoft.com>

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


  parent reply	other threads:[~2022-05-18  0:14 UTC|newest]

Thread overview: 16+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2022-05-18  0:13 [PATCH v2 00/11] Fix new typos reported Michael Kubacki
2022-05-18  0:13 ` [PATCH v2 01/11] PrmPkg: " Michael Kubacki
2022-05-18  0:13 ` [PATCH v2 02/11] StandaloneMmPkg: " Michael Kubacki
2022-12-13 10:26   ` Sami Mujawar
2022-12-14  3:03     ` [edk2-devel] " Michael Kubacki
2022-05-18  0:13 ` [PATCH v2 03/11] DynamicTablesPkg: " Michael Kubacki
2022-05-18  0:13 ` Michael Kubacki [this message]
2022-05-18  0:13 ` [PATCH v2 05/11] FatPkg: " Michael Kubacki
2022-05-18  0:13 ` [PATCH v2 06/11] FmpDevicePkg: " Michael Kubacki
2022-05-18  0:13 ` [PATCH v2 07/11] ArmPkg: Ignore " Michael Kubacki
2022-12-13 10:36   ` Sami Mujawar
2022-05-18  0:13 ` [PATCH v2 08/11] ArmVirtPkg: Add new ignored spelling errors Michael Kubacki
2022-12-13 10:38   ` Sami Mujawar
2022-05-18  0:13 ` [PATCH v2 09/11] .azurepipelines: Fix cspell version to v5.20.0 Michael Kubacki
2022-05-18  0:13 ` [PATCH v2 10/11] .pytool/plugin/SpellCheck: Allow compound words Michael Kubacki
2022-05-18  0:13 ` [PATCH v2 11/11] .pytool/plugin/SpellCheck: Add more common words Michael Kubacki

Reply instructions:

You may reply publicly to this message via plain-text email
using any one of the following methods:

* Save the following mbox file, import it into your mail client,
  and reply-to-list from there: mbox

  Avoid top-posting and favor interleaved quoting:
  https://en.wikipedia.org/wiki/Posting_style#Interleaved_style

* Reply using the --to, --cc, and --in-reply-to
  switches of git-send-email(1):

  git send-email \
    --in-reply-to=20220518001338.1380-5-mikuback@linux.microsoft.com \
    --to=devel@edk2.groups.io \
    /path/to/YOUR_REPLY

  https://kernel.org/pub/software/scm/git/docs/git-send-email.html

* If your mail client supports setting the In-Reply-To header
  via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line before the message body.
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox