Re: [edk2-devel] [PATCH v1 1/2] MdePkg/UnitTestLib.h: Drop FrameworkHandle param from SaveFrameworkState()

["Zhiguang Liu" <zhiguang.liu@intel.com>]

Reviewed-by: Zhiguang Liu <zhiguang.liu@intel.com>

> -----Original Message-----
> From: devel@edk2.groups.io <devel@edk2.groups.io> On Behalf Of Michael
> Kubacki
> Sent: Wednesday, April 22, 2020 2:35 AM
> To: devel@edk2.groups.io
> Cc: Bret Barkelew <brbarkel@microsoft.com>; Gao, Liming
> <liming.gao@intel.com>; Kinney, Michael D <michael.d.kinney@intel.com>
> Subject: [edk2-devel] [PATCH v1 1/2] MdePkg/UnitTestLib.h: Drop
> FrameworkHandle param from SaveFrameworkState()
> 
> From: Michael Kubacki <michael.kubacki@microsoft.com>
> 
> REF:https://bugzilla.tianocore.org/show_bug.cgi?id=2612
> 
> The framework handle can be retrieved from GetActiveFrameworkHandle()
> internal to SaveFrameworkState() so this change removes the parameter
> from the function signature.
> 
> Cc: Bret Barkelew <brbarkel@microsoft.com>
> Cc: Liming Gao <liming.gao@intel.com>
> Cc: Michael D Kinney <michael.d.kinney@intel.com>
> Signed-off-by: Michael Kubacki <michael.kubacki@microsoft.com>
> ---
>  MdePkg/Include/Library/UnitTestLib.h | 9 +++------
>  1 file changed, 3 insertions(+), 6 deletions(-)
> 
> diff --git a/MdePkg/Include/Library/UnitTestLib.h
> b/MdePkg/Include/Library/UnitTestLib.h
> index c06c36bea5aa..a4374580a8d5 100644
> --- a/MdePkg/Include/Library/UnitTestLib.h
> +++ b/MdePkg/Include/Library/UnitTestLib.h
> @@ -313,11 +313,9 @@ FreeUnitTestFramework (
>    at least the current execution count) which will be saved by the framework
> and
>    passed to the test case upon resume.
> 
> -  Generally called from within a test case prior to quitting or rebooting.
> +  This should be called while the current test framework is valid and active. It
> is
> +  generally called from within a test case prior to quitting or rebooting.
> 
> -  @param[in]  FrameworkHandle    A handle to the current running
> framework that
> -                                 dispatched the test.  Necessary for recording
> -                                 certain test events with the framework.
>    @param[in]  ContextToSave      A buffer of test case-specific data to be
> saved
>                                   along with framework state.  Will be passed as
>                                   "Context" to the test case upon resume.  This
> @@ -325,7 +323,7 @@ FreeUnitTestFramework (
>    @param[in]  ContextToSaveSize  Size of the ContextToSave buffer.
> 
>    @retval  EFI_SUCCESS            The framework state and context were saved.
> -  @retval  EFI_INVALID_PARAMETER  FrameworkHandle is NULL.
> +  @retval  EFI_NOT_FOUND          An active framework handle was not found.
>    @retval  EFI_INVALID_PARAMETER  ContextToSave is not NULL and
>                                    ContextToSaveSize is 0.
>    @retval  EFI_INVALID_PARAMETER  ContextToSave is >= 4GB.
> @@ -338,7 +336,6 @@ FreeUnitTestFramework (
>  EFI_STATUS
>  EFIAPI
>  SaveFrameworkState (
> -  IN UNIT_TEST_FRAMEWORK_HANDLE  FrameworkHandle,
>    IN UNIT_TEST_CONTEXT           ContextToSave     OPTIONAL,
>    IN UINTN                       ContextToSaveSize
>    );
> --
> 2.16.3.windows.1
> 
> 
>