public inbox for devel@edk2.groups.io
 help / color / mirror / Atom feed
* [PATCH v1 1/1] ShellPkg: Add comment that ItemPtr is set after validation
@ 2021-10-20 10:47 Chris Jones
  2021-10-20 10:53 ` Sami Mujawar
  0 siblings, 1 reply; 4+ messages in thread
From: Chris Jones @ 2021-10-20 10:47 UTC (permalink / raw)
  To: devel; +Cc: ray.ni, zhichao.gao, Sami.Mujawar, nd

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")


^ permalink raw reply related	[flat|nested] 4+ messages in thread

end of thread, other threads:[~2021-11-08 11:08 UTC | newest]

Thread overview: 4+ messages (download: mbox.gz follow: Atom feed
-- links below jump to the message on this page --
2021-10-20 10:47 [PATCH v1 1/1] ShellPkg: Add comment that ItemPtr is set after validation Chris Jones
2021-10-20 10:53 ` Sami Mujawar
2021-10-28  3:15   ` Gao, Zhichao
2021-11-08 11:07     ` Chris Jones

This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox