From mboxrd@z Thu Jan 1 00:00:00 1970 Received: from foss.arm.com (foss.arm.com [217.140.110.172]) by mx.groups.io with SMTP id smtpd.web08.33677.1661270459509328440 for ; Tue, 23 Aug 2022 09:00:59 -0700 Authentication-Results: mx.groups.io; dkim=missing; spf=pass (domain: arm.com, ip: 217.140.110.172, mailfrom: pierre.gondois@arm.com) Received: from usa-sjc-imap-foss1.foss.arm.com (unknown [10.121.207.14]) by usa-sjc-mx-foss1.foss.arm.com (Postfix) with ESMTP id DA9D91424; Tue, 23 Aug 2022 09:01:02 -0700 (PDT) Received: from pierre123.nice.arm.com (pierre123.nice.arm.com [10.34.100.116]) by usa-sjc-imap-foss1.foss.arm.com (Postfix) with ESMTPA id 6A5B33F718; Tue, 23 Aug 2022 09:00:58 -0700 (PDT) From: "PierreGondois" To: devel@edk2.groups.io Cc: Pierre Gondois , Michael D Kinney , Michael Kubacki Subject: [PATCH 24/24] UnitTestFrameworkPkg: Remove duplicated words Date: Tue, 23 Aug 2022 18:00:31 +0200 Message-Id: <20220823160031.991072-25-Pierre.Gondois@arm.com> X-Mailer: git-send-email 2.25.1 In-Reply-To: <20220823160031.991072-1-Pierre.Gondois@arm.com> References: <20220823160031.991072-1-Pierre.Gondois@arm.com> MIME-Version: 1.0 Content-Transfer-Encoding: quoted-printable From: Pierre Gondois 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 Cc: Michael Kubacki Signed-off-by: Pierre Gondois --- .../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/DebugLibPos= ix.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 !=3D NULL); =20 // - // SetMem() checks for the the ASSERT() condition on Length and return= s Buffer + // SetMem() checks for the ASSERT() condition on Length and returns Bu= ffer // return SetMem (Buffer, Length, PcdGet8 (PcdDebugClearMemoryValue)); } diff --git a/UnitTestFrameworkPkg/Library/UnitTestLib/Assert.c b/UnitTest= FrameworkPkg/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 functi= on executing the UT_EXPECT_ASSERT_FAILURE() m= acro. - @param[in] LineNumber The source file line number of the the fun= ction + @param[in] LineNumber The source file line number of the functio= n executing the UT_EXPECT_ASSERT_FAILURE() m= acro. @param[in] FileName Null-terminated ASCII string of the filena= me executing the UT_EXPECT_ASSERT_FAILURE() m= acro. diff --git a/UnitTestFrameworkPkg/Library/UnitTestLib/AssertCmocka.c b/Un= itTestFrameworkPkg/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 functi= on executing the UT_EXPECT_ASSERT_FAILURE() m= acro. - @param[in] LineNumber The source file line number of the the fun= ction + @param[in] LineNumber The source file line number of the functio= n executing the UT_EXPECT_ASSERT_FAILURE() m= acro. @param[in] FileName Null-terminated ASCII string of the filena= me executing the UT_EXPECT_ASSERT_FAILURE() m= acro. diff --git a/UnitTestFrameworkPkg/Library/UnitTestPersistenceLibNull/Unit= TestPersistenceLibNull.c b/UnitTestFrameworkPkg/Library/UnitTestPersisten= ceLibNull/UnitTestPersistenceLibNull.c index e28327652eaf..6cd8e4150465 100644 --- a/UnitTestFrameworkPkg/Library/UnitTestPersistenceLibNull/UnitTestPer= sistenceLibNull.c +++ b/UnitTestFrameworkPkg/Library/UnitTestPersistenceLibNull/UnitTestPer= sistenceLibNull.c @@ -55,7 +55,7 @@ SaveUnitTestCache ( Will allocate a buffer to hold the loaded data. =20 @param[in] FrameworkHandle A pointer to the framework that is being = persisted. - @param[in] SaveData A pointer pointer that will be updated wi= th the address + @param[out] SaveData A pointer that will be updated with the = address of the loaded data buffer. =20 @retval EFI_SUCCESS Data has been loaded successfully and SaveData i= s updated diff --git a/UnitTestFrameworkPkg/Library/UnitTestPersistenceLibSimpleFil= eSystem/UnitTestPersistenceLibSimpleFileSystem.c b/UnitTestFrameworkPkg/L= ibrary/UnitTestPersistenceLibSimpleFileSystem/UnitTestPersistenceLibSimpl= eFileSystem.c index ed4a7d161524..4e2fb785be78 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. =20 @param[in] FrameworkHandle A pointer to the framework that is being = persisted. - @param[in] SaveData A pointer pointer that will be updated wi= th the address + @param[out] SaveData A pointer that will be updated with the = address of the loaded data buffer. =20 @retval EFI_SUCCESS Data has been loaded successfully and SaveData i= s updated diff --git a/UnitTestFrameworkPkg/PrivateInclude/Library/UnitTestPersiste= nceLib.h b/UnitTestFrameworkPkg/PrivateInclude/Library/UnitTestPersistenc= eLib.h index be29e079ec3e..f2806cadd2a8 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. =20 @param[in] FrameworkHandle A pointer to the framework that is being= persisted. - @param[in] SaveData A pointer pointer that will be updated w= ith the address + @param[out] SaveData A pointer that will be updated with the= address of the loaded data buffer. =20 @retval EFI_SUCCESS Data has been loaded successfully and Sa= veData 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 -- `AddTestCa= se` 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 o= ptional pointer to a context structure. +function pointers for prerequisite check and cleanup routines; and optio= nal pointer to a context structure. =20 Okay, that's a lot. Let's take it one piece at a time. The description a= nd class name strings are very similar in usage to the suite title and package name strings in the test suites. Th= e former is for user presentation and the @@ -268,8 +268,8 @@ stuart_ci_build -c .pytool/CISettings.py TOOL_CHAIN_T= AG=3DVS2019 -p MdePkg -t NOOP =20 ## Building and Running Host-Based Tests =20 -The EDK2 CI infrastructure provides a convenient way to run all host-bas= ed tests -- in the the entire tree or just -selected packages -- and aggregate all the the reports, including highli= ghting any failures. This functionality is +The EDK2 CI infrastructure provides a convenient way to run all host-bas= ed tests -- in the entire tree or just +selected packages -- and aggregate all the reports, including highlighti= ng any failures. This functionality is provided through the Stuart build system (published by EDK2-PyTools) and= the `NOOPT` build target. =20 ### Building Locally --=20 2.25.1