Re: [edk2-devel] [PATCH v4 15/15] MdePkg/UefiRuntimeLib: Change the comment

["Laszlo Ersek" <lersek@redhat.com>]

Hi,

On 08/12/19 05:07, Gao, Zhichao wrote:
> Change the comment of EfiResetSystem base on the
> UEFI spec 2.8
> 
> Cc: Michael D Kinney <michael.d.kinney@intel.com>
> Cc: Liming Gao <liming.gao@intel.com>
> Signed-off-by: Zhichao Gao <zhichao.gao@intel.com>
> ---
>  MdePkg/Library/UefiRuntimeLib/RuntimeLib.c | 8 ++++----
>  1 file changed, 4 insertions(+), 4 deletions(-)
> 
> diff --git a/MdePkg/Library/UefiRuntimeLib/RuntimeLib.c b/MdePkg/Library/UefiRuntimeLib/RuntimeLib.c
> index 933e0099ceed..28cbf493b665 100644
> --- a/MdePkg/Library/UefiRuntimeLib/RuntimeLib.c
> +++ b/MdePkg/Library/UefiRuntimeLib/RuntimeLib.c
> @@ -218,10 +218,10 @@ EfiGoneVirtual (
>    @param  DataSizeThe size, in bytes, of ResetData.
>    @param  ResetData   For a ResetType of EfiResetCold, EfiResetWarm, or EfiResetShutdown the data buffer starts with a
>                        Null-terminated Unicode string, optionally followed by additional binary data. The string is a
> -                      description that the caller may use to further indicate the reason for the system reset. ResetData
> -                      is only valid if ResetStatus is something other then EFI_SUCCESS. This pointer must be a physical
> -                      address. For a ResetType of EfiRestUpdate the data buffer also starts with a Null-terminated string
> -                      that is followed by a physical VOID * to an EFI_CAPSULE_HEADER.
> +                      description that the caller may use to further indicate the reason for the system reset. This
> +                      pointer must be a physical address. For a ResetType of EfiResetPlatformSpecific the data buffer
> +                      also starts with a Null-terminated string that is followed by an EFI_GUID that describes the
> +                      specific type of reset to perform.
>  
>  **/
>  VOID
> 

given that UefiRuntimeLib is a single-instance library class -- that is,
my understanding is that we never plan to introduce a different instance
for this class --, I would suggest fusing the following two patches into
one:

- [PATCH v4 14/15] MdePkg/UefiRuntimeLib.h: Change the comment
- [PATCH v4 15/15] MdePkg/UefiRuntimeLib: Change the comment

Also, can we please use a better (more specific) subject line?


Obviously I'm not an MdePkg maintainer (or even reviewer), so I defer to
Liming and Mike.

Thanks
Laszlo