[edk2-devel] [PATCH v2 17/17] UnitTestFrameworkPkg: Remove duplicated words
Michael D Kinney
michael.d.kinney at intel.com
Tue Sep 6 18:47:12 UTC 2022
Reviewed-by: Michael D Kinney <michael.d.kinney at intel.com>
> -----Original Message-----
> From: Pierre.Gondois at arm.com <Pierre.Gondois at arm.com>
> Sent: Tuesday, September 6, 2022 1:29 AM
> To: devel at edk2.groups.io
> Cc: Pierre Gondois <pierre.gondois at arm.com>; Kinney, Michael D <michael.d.kinney at intel.com>; Michael Kubacki
> <mikuback at linux.microsoft.com>; Kubacki, Michael <michael.kubacki at microsoft.com>
> Subject: [PATCH v2 17/17] UnitTestFrameworkPkg: Remove duplicated words
>
> From: Pierre Gondois <pierre.gondois at arm.com>
>
> In an effort to clean the documentation of the above
> package, remove duplicated words.
>
> Also change in/out tag to pass the EccCheck.
>
> Cc: Michael D Kinney <michael.d.kinney at intel.com>
> Cc: Michael Kubacki <mikuback at linux.microsoft.com>
> Signed-off-by: Pierre Gondois <pierre.gondois at arm.com>
> Reviewed-by: Michael Kubacki <michael.kubacki at microsoft.com>
> ---
>
> Notes:
> v2:
> - Correctly align comments. [Michael Kubacki]
>
> .../Library/Posix/DebugLibPosix/DebugLibPosix.c | 2 +-
> UnitTestFrameworkPkg/Library/UnitTestLib/Assert.c | 2 +-
> UnitTestFrameworkPkg/Library/UnitTestLib/AssertCmocka.c | 2 +-
> .../UnitTestPersistenceLibNull/UnitTestPersistenceLibNull.c | 2 +-
> .../UnitTestPersistenceLibSimpleFileSystem.c | 2 +-
> .../PrivateInclude/Library/UnitTestPersistenceLib.h | 2 +-
> UnitTestFrameworkPkg/ReadMe.md | 6 +++---
> 7 files changed, 9 insertions(+), 9 deletions(-)
>
> diff --git a/UnitTestFrameworkPkg/Library/Posix/DebugLibPosix/DebugLibPosix.c
> b/UnitTestFrameworkPkg/Library/Posix/DebugLibPosix/DebugLibPosix.c
> index 694f4beb8bf5..cfee36d2ac7f 100644
> --- a/UnitTestFrameworkPkg/Library/Posix/DebugLibPosix/DebugLibPosix.c
> +++ b/UnitTestFrameworkPkg/Library/Posix/DebugLibPosix/DebugLibPosix.c
> @@ -179,7 +179,7 @@ DebugClearMemory (
> ASSERT (Buffer != NULL);
>
> //
> - // SetMem() checks for the the ASSERT() condition on Length and returns Buffer
> + // SetMem() checks for the ASSERT() condition on Length and returns Buffer
> //
> return SetMem (Buffer, Length, PcdGet8 (PcdDebugClearMemoryValue));
> }
> diff --git a/UnitTestFrameworkPkg/Library/UnitTestLib/Assert.c b/UnitTestFrameworkPkg/Library/UnitTestLib/Assert.c
> index 35636565b783..9bb0798dd801 100644
> --- a/UnitTestFrameworkPkg/Library/UnitTestLib/Assert.c
> +++ b/UnitTestFrameworkPkg/Library/UnitTestLib/Assert.c
> @@ -516,7 +516,7 @@ UnitTestAssertNotNull (
> is either pass, skipped, or failed.
> @param[in] FunctionName Null-terminated ASCII string of the function
> executing the UT_EXPECT_ASSERT_FAILURE() macro.
> - @param[in] LineNumber The source file line number of the the function
> + @param[in] LineNumber The source file line number of the function
> executing the UT_EXPECT_ASSERT_FAILURE() macro.
> @param[in] FileName Null-terminated ASCII string of the filename
> executing the UT_EXPECT_ASSERT_FAILURE() macro.
> diff --git a/UnitTestFrameworkPkg/Library/UnitTestLib/AssertCmocka.c b/UnitTestFrameworkPkg/Library/UnitTestLib/AssertCmocka.c
> index dc05bbd4384c..0b1f6b197a35 100644
> --- a/UnitTestFrameworkPkg/Library/UnitTestLib/AssertCmocka.c
> +++ b/UnitTestFrameworkPkg/Library/UnitTestLib/AssertCmocka.c
> @@ -349,7 +349,7 @@ UnitTestAssertNotNull (
> is either pass, skipped, or failed.
> @param[in] FunctionName Null-terminated ASCII string of the function
> executing the UT_EXPECT_ASSERT_FAILURE() macro.
> - @param[in] LineNumber The source file line number of the the function
> + @param[in] LineNumber The source file line number of the function
> executing the UT_EXPECT_ASSERT_FAILURE() macro.
> @param[in] FileName Null-terminated ASCII string of the filename
> executing the UT_EXPECT_ASSERT_FAILURE() macro.
> diff --git a/UnitTestFrameworkPkg/Library/UnitTestPersistenceLibNull/UnitTestPersistenceLibNull.c
> b/UnitTestFrameworkPkg/Library/UnitTestPersistenceLibNull/UnitTestPersistenceLibNull.c
> index e28327652eaf..064b967b13b3 100644
> --- a/UnitTestFrameworkPkg/Library/UnitTestPersistenceLibNull/UnitTestPersistenceLibNull.c
> +++ b/UnitTestFrameworkPkg/Library/UnitTestPersistenceLibNull/UnitTestPersistenceLibNull.c
> @@ -55,7 +55,7 @@ SaveUnitTestCache (
> Will allocate a buffer to hold the loaded data.
>
> @param[in] FrameworkHandle A pointer to the framework that is being persisted.
> - @param[in] SaveData A pointer pointer that will be updated with the address
> + @param[out] SaveData A pointer that will be updated with the address
> of the loaded data buffer.
>
> @retval EFI_SUCCESS Data has been loaded successfully and SaveData is updated
> diff --git a/UnitTestFrameworkPkg/Library/UnitTestPersistenceLibSimpleFileSystem/UnitTestPersistenceLibSimpleFileSystem.c
> b/UnitTestFrameworkPkg/Library/UnitTestPersistenceLibSimpleFileSystem/UnitTestPersistenceLibSimpleFileSystem.c
> index ed4a7d161524..940c7e42d43c 100644
> --- a/UnitTestFrameworkPkg/Library/UnitTestPersistenceLibSimpleFileSystem/UnitTestPersistenceLibSimpleFileSystem.c
> +++ b/UnitTestFrameworkPkg/Library/UnitTestPersistenceLibSimpleFileSystem/UnitTestPersistenceLibSimpleFileSystem.c
> @@ -312,7 +312,7 @@ Exit:
> Will allocate a buffer to hold the loaded data.
>
> @param[in] FrameworkHandle A pointer to the framework that is being persisted.
> - @param[in] SaveData A pointer pointer that will be updated with the address
> + @param[out] SaveData A pointer that will be updated with the address
> of the loaded data buffer.
>
> @retval EFI_SUCCESS Data has been loaded successfully and SaveData is updated
> diff --git a/UnitTestFrameworkPkg/PrivateInclude/Library/UnitTestPersistenceLib.h
> b/UnitTestFrameworkPkg/PrivateInclude/Library/UnitTestPersistenceLib.h
> index be29e079ec3e..e473bebec7e2 100644
> --- a/UnitTestFrameworkPkg/PrivateInclude/Library/UnitTestPersistenceLib.h
> +++ b/UnitTestFrameworkPkg/PrivateInclude/Library/UnitTestPersistenceLib.h
> @@ -57,7 +57,7 @@ SaveUnitTestCache (
> Will allocate a buffer to hold the loaded data.
>
> @param[in] FrameworkHandle A pointer to the framework that is being persisted.
> - @param[in] SaveData A pointer pointer that will be updated with the address
> + @param[out] SaveData A pointer that will be updated with the address
> of the loaded data buffer.
>
> @retval EFI_SUCCESS Data has been loaded successfully and SaveData is updated
> diff --git a/UnitTestFrameworkPkg/ReadMe.md b/UnitTestFrameworkPkg/ReadMe.md
> index e696412cb3cf..a7b64bd65392 100644
> --- a/UnitTestFrameworkPkg/ReadMe.md
> +++ b/UnitTestFrameworkPkg/ReadMe.md
> @@ -144,7 +144,7 @@ will be used when adding test cases.
> Great! Now we've finished some of the cruft, red tape, and busy work. We're ready to add some tests. Adding a test
> to a test suite is accomplished with the -- you guessed it -- `AddTestCase` function. It takes in the suite handle;
> a `CHAR8` string for the description and class name; a function pointer for the test case itself; additional, optional
> -function pointers for prerequisite check and cleanup routines; and and optional pointer to a context structure.
> +function pointers for prerequisite check and cleanup routines; and optional pointer to a context structure.
>
> Okay, that's a lot. Let's take it one piece at a time. The description and class name strings are very similar in
> usage to the suite title and package name strings in the test suites. The former is for user presentation and the
> @@ -268,8 +268,8 @@ stuart_ci_build -c .pytool/CISettings.py TOOL_CHAIN_TAG=VS2019 -p MdePkg -t NOOP
>
> ## Building and Running Host-Based Tests
>
> -The EDK2 CI infrastructure provides a convenient way to run all host-based tests -- in the the entire tree or just
> -selected packages -- and aggregate all the the reports, including highlighting any failures. This functionality is
> +The EDK2 CI infrastructure provides a convenient way to run all host-based tests -- in the entire tree or just
> +selected packages -- and aggregate all the reports, including highlighting any failures. This functionality is
> provided through the Stuart build system (published by EDK2-PyTools) and the `NOOPT` build target.
>
> ### Building Locally
> --
> 2.25.1
-=-=-=-=-=-=-=-=-=-=-=-
Groups.io Links: You receive all messages sent to this group.
View/Reply Online (#93299): https://edk2.groups.io/g/devel/message/93299
Mute This Topic: https://groups.io/mt/93496615/1813853
Group Owner: devel+owner at edk2.groups.io
Unsubscribe: https://edk2.groups.io/g/devel/unsub [edk2-devel-archive at redhat.com]
-=-=-=-=-=-=-=-=-=-=-=-
More information about the edk2-devel-archive
mailing list