From: "Michael Kubacki" <mikuback@linux.microsoft.com>
To: Pierre.Gondois@arm.com, devel@edk2.groups.io
Cc: Michael D Kinney <michael.d.kinney@intel.com>
Subject: Re: [PATCH 24/24] UnitTestFrameworkPkg: Remove duplicated words
Date: Wed, 24 Aug 2022 23:12:11 -0400 [thread overview]
Message-ID: <6eacc9bb-d2b8-c1b7-1959-3be5e658cceb@linux.microsoft.com> (raw)
In-Reply-To: <20220823160031.991072-25-Pierre.Gondois@arm.com>
In these changes:
> - @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
The text "A pointer..." became unaligned with the block. Likely due to
the extra character added when changing "in" to "out".
Can you please try to update the alignment before submission?
Reviewed-by: Michael Kubacki <michael.kubacki@microsoft.com>
On 8/23/2022 12:00 PM, Pierre.Gondois@arm.com wrote:
> From: Pierre Gondois <pierre.gondois@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@intel.com>
> Cc: Michael Kubacki <mikuback@linux.microsoft.com>
> Signed-off-by: Pierre Gondois <pierre.gondois@arm.com>
> ---
> .../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..6cd8e4150465 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..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.
>
> @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..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.
>
> @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
prev parent reply other threads:[~2022-08-25 3:12 UTC|newest]
Thread overview: 51+ messages / expand[flat|nested] mbox.gz Atom feed top
2022-08-23 16:00 [PATCH 00/24] Remove duplicated words PierreGondois
2022-08-23 16:00 ` [PATCH 01/24] .pytool: " PierreGondois
2022-08-23 16:00 ` [PATCH 02/24] ArmPkg: " PierreGondois
2022-08-23 17:13 ` [edk2-devel] " Sami Mujawar
2022-08-24 13:28 ` Leif Lindholm
2022-09-05 13:54 ` Ard Biesheuvel
2022-08-23 16:00 ` [PATCH 03/24] ArmPlatformPkg: " PierreGondois
2022-08-23 17:12 ` [edk2-devel] " Sami Mujawar
2022-08-24 13:26 ` Leif Lindholm
2022-09-05 13:54 ` Ard Biesheuvel
2022-08-23 16:00 ` [PATCH 04/24] ArmVirtPkg: " PierreGondois
2022-08-23 17:12 ` [edk2-devel] " Sami Mujawar
2022-09-05 13:55 ` Ard Biesheuvel
2022-08-23 16:00 ` [PATCH 05/24] BaseTools: " PierreGondois
2022-08-23 16:00 ` [PATCH 06/24] CryptoPkg: " PierreGondois
2022-08-23 16:00 ` [PATCH 07/24] DynamicTablesPkg: " PierreGondois
2022-08-23 17:09 ` Sami Mujawar
2022-08-23 16:00 ` [PATCH 08/24] EmbeddedPkg: " PierreGondois
2022-08-24 13:29 ` Leif Lindholm
2022-08-24 13:31 ` Chang, Abner
2022-09-05 13:54 ` Ard Biesheuvel
2022-08-23 16:00 ` [PATCH 09/24] EmulatorPkg: " PierreGondois
2022-08-23 16:00 ` [PATCH 10/24] FatPkg: " PierreGondois
2022-08-23 16:00 ` [PATCH 11/24] IntelFsp2WrapperPkg: " PierreGondois
2022-08-23 16:55 ` Chiu, Chasel
2022-09-01 23:18 ` [edk2-devel] " Nate DeSimone
2022-09-01 23:24 ` Nate DeSimone
2022-08-23 16:00 ` [PATCH 12/24] MdeModulePkg: " PierreGondois
2022-08-23 16:00 ` [PATCH 13/24] MdePkg: " PierreGondois
2022-08-23 16:00 ` [PATCH 14/24] NetworkPkg: " PierreGondois
2022-09-02 14:31 ` [edk2-devel] " Maciej Rabeda
2022-08-23 16:00 ` [PATCH 15/24] OvmfPkg: " PierreGondois
2022-08-23 23:00 ` Yao, Jiewen
2022-09-05 13:55 ` Ard Biesheuvel
2022-08-23 16:00 ` [PATCH 16/24] PcAtChipsetPkg: " PierreGondois
2022-08-23 16:00 ` [PATCH 17/24] RedfishPkg: " PierreGondois
2022-08-24 13:32 ` Chang, Abner
2022-08-23 16:00 ` [PATCH 18/24] SecurityPkg: " PierreGondois
2022-08-23 16:00 ` [PATCH 19/24] ShellPkg: " PierreGondois
2022-08-24 5:34 ` Gao, Zhichao
2022-08-23 16:00 ` [PATCH 20/24] SourceLevelDebugPkg: " PierreGondois
2022-08-24 0:50 ` Wu, Hao A
2022-08-24 1:06 ` [edk2-devel] " Ni, Ray
2022-08-23 16:00 ` [PATCH 21/24] StandaloneMmPkg: " PierreGondois
2022-08-23 17:11 ` Sami Mujawar
2022-08-23 23:00 ` Yao, Jiewen
2022-09-05 13:55 ` Ard Biesheuvel
2022-08-23 16:00 ` [PATCH 22/24] UefiCpuPkg: " PierreGondois
2022-08-23 16:00 ` [PATCH 23/24] UefiPayloadPkg: " PierreGondois
2022-08-23 16:00 ` [PATCH 24/24] UnitTestFrameworkPkg: " PierreGondois
2022-08-25 3:12 ` Michael Kubacki [this message]
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=6eacc9bb-d2b8-c1b7-1959-3be5e658cceb@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