[PATCH v1 1/1] ShellPkg: Add comment that ItemPtr is set after validation

[PATCH v1 1/1] ShellPkg: Add comment that ItemPtr is set after validation

[Chris Jones]

Add a comment to clarify that in Acpiview the ItemPtr is not set until
after the FieldValidator has been called.

Signed-off-by: Chris Jones <christopher.jones@arm.com>
---
 ShellPkg/Library/UefiShellAcpiViewCommandLib/AcpiParser.h | 4 +++-
 1 file changed, 3 insertions(+), 1 deletion(-)

diff --git a/ShellPkg/Library/UefiShellAcpiViewCommandLib/AcpiParser.h b/ShellPkg/Library/UefiShellAcpiViewCommandLib/AcpiParser.h
index 0b7726b9d5807ad2f5c5447408c4c5451718938b..5e34a70c8baeaaa05ecd797d405f1fc62a44a305 100644
--- a/ShellPkg/Library/UefiShellAcpiViewCommandLib/AcpiParser.h
+++ b/ShellPkg/Library/UefiShellAcpiViewCommandLib/AcpiParser.h
@@ -283,7 +283,9 @@ typedef struct AcpiParser {
   FNPTR_PRINT_FORMATTER PrintFormatter;
 
   /// Optional pointer which may be set to request the parser to update
-  /// a pointer to the field data. If unused this must be set to NULL.
+  /// a pointer to the field data. This value is set after the FieldValidator
+  /// has been called and therefore should not be used by the FieldValidator.
+  /// If unused this must be set to NULL.
   VOID**                ItemPtr;
 
   /// Optional pointer to a field validator function.
-- 
Guid("CE165669-3EF3-493F-B85D-6190EE5B9759")

Re: [PATCH v1 1/1] ShellPkg: Add comment that ItemPtr is set after validation

[Sami Mujawar]

Hi Chris,

Thanks for adding the comment that clarifies the usage.

Reviewed-by: Sami Mujawar <sami.mujawar@arm.com>

Regards,

Sami Mujawar

On 20/10/2021, 11:47, "Chris Jones" <christopher.jones@arm.com> wrote:

    Add a comment to clarify that in Acpiview the ItemPtr is not set until
    after the FieldValidator has been called.

    Signed-off-by: Chris Jones <christopher.jones@arm.com>
    ---
     ShellPkg/Library/UefiShellAcpiViewCommandLib/AcpiParser.h | 4 +++-
     1 file changed, 3 insertions(+), 1 deletion(-)

    diff --git a/ShellPkg/Library/UefiShellAcpiViewCommandLib/AcpiParser.h b/ShellPkg/Library/UefiShellAcpiViewCommandLib/AcpiParser.h
    index 0b7726b9d5807ad2f5c5447408c4c5451718938b..5e34a70c8baeaaa05ecd797d405f1fc62a44a305 100644
    --- a/ShellPkg/Library/UefiShellAcpiViewCommandLib/AcpiParser.h
    +++ b/ShellPkg/Library/UefiShellAcpiViewCommandLib/AcpiParser.h
    @@ -283,7 +283,9 @@ typedef struct AcpiParser {
       FNPTR_PRINT_FORMATTER PrintFormatter;

       /// Optional pointer which may be set to request the parser to update
    -  /// a pointer to the field data. If unused this must be set to NULL.
    +  /// a pointer to the field data. This value is set after the FieldValidator
    +  /// has been called and therefore should not be used by the FieldValidator.
    +  /// If unused this must be set to NULL.
       VOID**                ItemPtr;

       /// Optional pointer to a field validator function.
    -- 
    Guid("CE165669-3EF3-493F-B85D-6190EE5B9759")

Re: [PATCH v1 1/1] ShellPkg: Add comment that ItemPtr is set after validation

[Gao, Zhichao]

Reviewed-by: Zhichao Gao <zhichao.gao@intel.com>

Thanks,
Zhichao

> -----Original Message-----
> From: Sami Mujawar <Sami.Mujawar@arm.com>
> Sent: Wednesday, October 20, 2021 6:54 PM
> To: Christopher Jones <Christopher.Jones@arm.com>;
> devel@edk2.groups.io
> Cc: Ni, Ray <ray.ni@intel.com>; Gao, Zhichao <zhichao.gao@intel.com>; nd
> <nd@arm.com>
> Subject: Re: [PATCH v1 1/1] ShellPkg: Add comment that ItemPtr is set after
> validation
> 
> Hi Chris,
> 
> Thanks for adding the comment that clarifies the usage.
> 
> Reviewed-by: Sami Mujawar <sami.mujawar@arm.com>
> 
> Regards,
> 
> Sami Mujawar
> 
> On 20/10/2021, 11:47, "Chris Jones" <christopher.jones@arm.com> wrote:
> 
>     Add a comment to clarify that in Acpiview the ItemPtr is not set until
>     after the FieldValidator has been called.
> 
>     Signed-off-by: Chris Jones <christopher.jones@arm.com>
>     ---
>      ShellPkg/Library/UefiShellAcpiViewCommandLib/AcpiParser.h | 4 +++-
>      1 file changed, 3 insertions(+), 1 deletion(-)
> 
>     diff --git a/ShellPkg/Library/UefiShellAcpiViewCommandLib/AcpiParser.h
> b/ShellPkg/Library/UefiShellAcpiViewCommandLib/AcpiParser.h
>     index
> 0b7726b9d5807ad2f5c5447408c4c5451718938b..5e34a70c8baeaaa05ecd797d4
> 05f1fc62a44a305 100644
>     --- a/ShellPkg/Library/UefiShellAcpiViewCommandLib/AcpiParser.h
>     +++ b/ShellPkg/Library/UefiShellAcpiViewCommandLib/AcpiParser.h
>     @@ -283,7 +283,9 @@ typedef struct AcpiParser {
>        FNPTR_PRINT_FORMATTER PrintFormatter;
> 
>        /// Optional pointer which may be set to request the parser to update
>     -  /// a pointer to the field data. If unused this must be set to NULL.
>     +  /// a pointer to the field data. This value is set after the FieldValidator
>     +  /// has been called and therefore should not be used by the
> FieldValidator.
>     +  /// If unused this must be set to NULL.
>        VOID**                ItemPtr;
> 
>        /// Optional pointer to a field validator function.
>     --
>     Guid("CE165669-3EF3-493F-B85D-6190EE5B9759")
> 

Re: [PATCH v1 1/1] ShellPkg: Add comment that ItemPtr is set after validation

[Chris Jones]

[-- Attachment #1: Type: text/plain, Size: 2677 bytes --]

Hi,
It looks like this patch has recieved the relevant approvals and is ready for merge. Could this patch please be merged in time for the edk2-stable202111 release.


Thanks,
Chris
________________________________
From: Gao, Zhichao <zhichao.gao@intel.com>
Sent: Thursday, October 28, 2021 4:15 AM
To: Sami Mujawar <Sami.Mujawar@arm.com>; Christopher Jones <Christopher.Jones@arm.com>; devel@edk2.groups.io <devel@edk2.groups.io>
Cc: Ni, Ray <ray.ni@intel.com>; nd <nd@arm.com>
Subject: RE: [PATCH v1 1/1] ShellPkg: Add comment that ItemPtr is set after validation

Reviewed-by: Zhichao Gao <zhichao.gao@intel.com>

Thanks,
Zhichao

> -----Original Message-----
> From: Sami Mujawar <Sami.Mujawar@arm.com>
> Sent: Wednesday, October 20, 2021 6:54 PM
> To: Christopher Jones <Christopher.Jones@arm.com>;
> devel@edk2.groups.io
> Cc: Ni, Ray <ray.ni@intel.com>; Gao, Zhichao <zhichao.gao@intel.com>; nd
> <nd@arm.com>
> Subject: Re: [PATCH v1 1/1] ShellPkg: Add comment that ItemPtr is set after
> validation
>
> Hi Chris,
>
> Thanks for adding the comment that clarifies the usage.
>
> Reviewed-by: Sami Mujawar <sami.mujawar@arm.com>
>
> Regards,
>
> Sami Mujawar
>
> On 20/10/2021, 11:47, "Chris Jones" <christopher.jones@arm.com> wrote:
>
>     Add a comment to clarify that in Acpiview the ItemPtr is not set until
>     after the FieldValidator has been called.
>
>     Signed-off-by: Chris Jones <christopher.jones@arm.com>
>     ---
>      ShellPkg/Library/UefiShellAcpiViewCommandLib/AcpiParser.h | 4 +++-
>      1 file changed, 3 insertions(+), 1 deletion(-)
>
>     diff --git a/ShellPkg/Library/UefiShellAcpiViewCommandLib/AcpiParser.h
> b/ShellPkg/Library/UefiShellAcpiViewCommandLib/AcpiParser.h
>     index
> 0b7726b9d5807ad2f5c5447408c4c5451718938b..5e34a70c8baeaaa05ecd797d4
> 05f1fc62a44a305 100644
>     --- a/ShellPkg/Library/UefiShellAcpiViewCommandLib/AcpiParser.h
>     +++ b/ShellPkg/Library/UefiShellAcpiViewCommandLib/AcpiParser.h
>     @@ -283,7 +283,9 @@ typedef struct AcpiParser {
>        FNPTR_PRINT_FORMATTER PrintFormatter;
>
>        /// Optional pointer which may be set to request the parser to update
>     -  /// a pointer to the field data. If unused this must be set to NULL.
>     +  /// a pointer to the field data. This value is set after the FieldValidator
>     +  /// has been called and therefore should not be used by the
> FieldValidator.
>     +  /// If unused this must be set to NULL.
>        VOID**                ItemPtr;
>
>        /// Optional pointer to a field validator function.
>     --
>     Guid("CE165669-3EF3-493F-B85D-6190EE5B9759")
>


[-- Attachment #2: Type: text/html, Size: 5302 bytes --]