From nobody Tue Feb 10 22:17:55 2026 Delivered-To: importer@patchew.org Received-SPF: pass (zohomail.com: domain of groups.io designates 66.175.222.108 as permitted sender) client-ip=66.175.222.108; envelope-from=bounce+27952+93208+1787277+3901457@groups.io; helo=mail02.groups.io; Authentication-Results: mx.zohomail.com; dkim=pass; spf=pass (zohomail.com: domain of groups.io designates 66.175.222.108 as permitted sender) smtp.mailfrom=bounce+27952+93208+1787277+3901457@groups.io; dmarc=fail(p=none dis=none) header.from=arm.com ARC-Seal: i=1; a=rsa-sha256; t=1662452996; cv=none; d=zohomail.com; s=zohoarc; b=hUTpxlFTLcvSsdmIl/gIPJfIwkk3jhe0HireR4n9S2J6cvKPo4j8P4MX2hYsPSiBrc5kosW2td3Man7tJGzhrVjNmWMKmkht4QvYyV6/NrLu468CQb9YBstibevTODL0ndaa84wJy5MtzvXZyIjDsql5Z88ci/j3hu3D67s5EYk= ARC-Message-Signature: i=1; a=rsa-sha256; c=relaxed/relaxed; d=zohomail.com; s=zohoarc; t=1662452996; h=Content-Transfer-Encoding:Cc:Date:From:In-Reply-To:List-Subscribe:List-Id:List-Help:List-Unsubscribe:MIME-Version:Message-ID:Reply-To:References:Sender:Subject:To; bh=le/vWNawW7Kadz+KsDP0dwOJWFJWerdTe5D7rY6JkRU=; b=kwo7d/6JMmO9xShYbG5I2lpgyW6j0V5dKPzIE3Zn0GSKzFh9IKeA0XPe7U1mWA2yG7eScD4uO/yWnbJ+oFgr85bw8hyen0wyoz7M4iSm1LuSzPIgcR+cBamzFutfOiULsQFDT2oZDW9JlJTAQJgJRmpSSVBxNr3pRwycF16c5tM= ARC-Authentication-Results: i=1; mx.zohomail.com; dkim=pass; spf=pass (zohomail.com: domain of groups.io designates 66.175.222.108 as permitted sender) smtp.mailfrom=bounce+27952+93208+1787277+3901457@groups.io; dmarc=fail header.from= (p=none dis=none) Received: from mail02.groups.io (mail02.groups.io [66.175.222.108]) by mx.zohomail.com with SMTPS id 1662452996891194.85810971623755; Tue, 6 Sep 2022 01:29:56 -0700 (PDT) Return-Path: X-Received: by 127.0.0.2 with SMTP id qOmaYY1788612xomyQuDszqI; Tue, 06 Sep 2022 01:29:56 -0700 X-Received: from foss.arm.com (foss.arm.com [217.140.110.172]) by mx.groups.io with SMTP id smtpd.web10.1544.1662452995878503503 for ; Tue, 06 Sep 2022 01:29:56 -0700 X-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 D9E3C19F0; Tue, 6 Sep 2022 01:30:01 -0700 (PDT) X-Received: from cam-smtp0.cambridge.arm.com (pierre123.nice.arm.com [10.34.100.114]) by usa-sjc-imap-foss1.foss.arm.com (Postfix) with ESMTPA id B2F753F73D; Tue, 6 Sep 2022 01:29:54 -0700 (PDT) From: "PierreGondois" To: devel@edk2.groups.io Cc: Pierre Gondois , Michael D Kinney , Michael Kubacki , Michael Kubacki Subject: [edk2-devel] [PATCH v2 17/17] UnitTestFrameworkPkg: Remove duplicated words Date: Tue, 6 Sep 2022 10:29:12 +0200 Message-Id: <20220906082912.81795-18-Pierre.Gondois@arm.com> In-Reply-To: <20220906082912.81795-1-Pierre.Gondois@arm.com> References: <20220906082912.81795-1-Pierre.Gondois@arm.com> MIME-Version: 1.0 Precedence: Bulk List-Unsubscribe: List-Subscribe: List-Help: Sender: devel@edk2.groups.io List-Id: Mailing-List: list devel@edk2.groups.io; contact devel+owner@edk2.groups.io Reply-To: devel@edk2.groups.io,pierre.gondois@arm.com X-Gm-Message-State: AlX6ee89VctULvE8bxwhwNa7x1787277AA= Content-Transfer-Encoding: quoted-printable DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/simple; d=groups.io; q=dns/txt; s=20140610; t=1662452996; bh=drxjbuZNFYH5xEXAJ0e1EFB+lFI8a+doP2v4AQ1NkSA=; h=Cc:Date:From:Reply-To:Subject:To; b=Cg1e5vLyR1+5LfPfQvjbN1S0yT5ScS18HrA5+qG7d51QZe2Xy46Pbf7Fvt42gZovI1V dgnSfCLRgQEkSRDK9WBhOBq59mEK4uIE49EJthW3OxGMc6fKpCwJtOyKWPYjh6A9wqZAM RCRLVpThwXm3sBuFRYRymLEIMtn5mdLWqoY= X-ZohoMail-DKIM: pass (identity @groups.io) X-ZM-MESSAGEID: 1662452997986100072 Content-Type: text/plain; charset="utf-8" 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 Reviewed-by: Michael Kubacki Reviewed-by: Michael D Kinney --- 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 !=3D NULL); =20 // - // SetMem() checks for the the ASSERT() condition on Length and returns = Buffer + // SetMem() checks for the ASSERT() condition on Length and returns Buff= er // return SetMem (Buffer, Length, PcdGet8 (PcdDebugClearMemoryValue)); } diff --git a/UnitTestFrameworkPkg/Library/UnitTestLib/Assert.c b/UnitTestFr= ameworkPkg/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() mac= ro. - @param[in] LineNumber The source file line number of the the funct= ion + @param[in] LineNumber The source file line number of the function executing the UT_EXPECT_ASSERT_FAILURE() mac= ro. @param[in] FileName Null-terminated ASCII string of the filename executing the UT_EXPECT_ASSERT_FAILURE() mac= ro. diff --git a/UnitTestFrameworkPkg/Library/UnitTestLib/AssertCmocka.c b/Unit= TestFrameworkPkg/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() mac= ro. - @param[in] LineNumber The source file line number of the the funct= ion + @param[in] LineNumber The source file line number of the function executing the UT_EXPECT_ASSERT_FAILURE() mac= ro. @param[in] FileName Null-terminated ASCII string of the filename executing the UT_EXPECT_ASSERT_FAILURE() mac= ro. diff --git a/UnitTestFrameworkPkg/Library/UnitTestPersistenceLibNull/UnitTe= stPersistenceLibNull.c b/UnitTestFrameworkPkg/Library/UnitTestPersistenceLi= bNull/UnitTestPersistenceLibNull.c index e28327652eaf..064b967b13b3 100644 --- a/UnitTestFrameworkPkg/Library/UnitTestPersistenceLibNull/UnitTestPersi= stenceLibNull.c +++ b/UnitTestFrameworkPkg/Library/UnitTestPersistenceLibNull/UnitTestPersi= stenceLibNull.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 pe= rsisted. - @param[in] SaveData A pointer pointer that will be updated with= the address + @param[out] SaveData A pointer that will be updated with the add= ress of the loaded data buffer. =20 @retval EFI_SUCCESS Data has been loaded successfully and SaveData is = updated diff --git a/UnitTestFrameworkPkg/Library/UnitTestPersistenceLibSimpleFileS= ystem/UnitTestPersistenceLibSimpleFileSystem.c b/UnitTestFrameworkPkg/Libra= ry/UnitTestPersistenceLibSimpleFileSystem/UnitTestPersistenceLibSimpleFileS= ystem.c index ed4a7d161524..940c7e42d43c 100644 --- a/UnitTestFrameworkPkg/Library/UnitTestPersistenceLibSimpleFileSystem/U= nitTestPersistenceLibSimpleFileSystem.c +++ b/UnitTestFrameworkPkg/Library/UnitTestPersistenceLibSimpleFileSystem/U= nitTestPersistenceLibSimpleFileSystem.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 pe= rsisted. - @param[in] SaveData A pointer pointer that will be updated with= the address + @param[out] SaveData A pointer that will be updated with the add= ress of the loaded data buffer. =20 @retval EFI_SUCCESS Data has been loaded successfully and SaveData is = updated diff --git a/UnitTestFrameworkPkg/PrivateInclude/Library/UnitTestPersistenc= eLib.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. =20 @param[in] FrameworkHandle A pointer to the framework that is being p= ersisted. - @param[in] SaveData A pointer pointer that will be updated wit= h the address + @param[out] SaveData A pointer that will be updated with the ad= dress of the loaded data buffer. =20 @retval EFI_SUCCESS Data has been loaded successfully and Save= Data 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'r= e 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 fo= r the test case itself; additional, optional -function pointers for prerequisite check and cleanup routines; and and opt= ional pointer to a context structure. +function pointers for prerequisite check and cleanup routines; and optiona= l pointer to a context structure. =20 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= =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-based= tests -- in the the entire tree or just -selected packages -- and aggregate all the the reports, including highligh= ting 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 t= he `NOOPT` build target. =20 ### Building Locally --=20 2.25.1 -=3D-=3D-=3D-=3D-=3D-=3D-=3D-=3D-=3D-=3D-=3D- Groups.io Links: You receive all messages sent to this group. View/Reply Online (#93208): https://edk2.groups.io/g/devel/message/93208 Mute This Topic: https://groups.io/mt/93496615/1787277 Group Owner: devel+owner@edk2.groups.io Unsubscribe: https://edk2.groups.io/g/devel/unsub [importer@patchew.org] -=3D-=3D-=3D-=3D-=3D-=3D-=3D-=3D-=3D-=3D-=3D-