[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@...>
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 {

/// 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.

Join {devel@edk2.groups.io to automatically receive all group messages.