summaryrefslogtreecommitdiffstats
path: root/ShellPkg
diff options
context:
space:
mode:
authorChris Jones <christopher.jones@arm.com>2021-10-20 18:47:18 +0800
committermergify[bot] <37929162+mergify[bot]@users.noreply.github.com>2021-11-09 01:24:41 +0000
commit8c1b1fe634a233ad7570f2243027d6be8a7849a1 (patch)
treeccadf52e79e8d0e6db0c89ac9ee93310dfb3b5fb /ShellPkg
parentfd42dcb1fc416b85bbbee1d546abfb7ac758b5c1 (diff)
downloadedk2-8c1b1fe634a233ad7570f2243027d6be8a7849a1.tar.gz
edk2-8c1b1fe634a233ad7570f2243027d6be8a7849a1.tar.bz2
edk2-8c1b1fe634a233ad7570f2243027d6be8a7849a1.zip
ShellPkg: Add comment that ItemPtr is set after validation
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> Reviewed-by: Sami Mujawar <sami.mujawar@arm.com> Reviewed-by: Zhichao Gao <zhichao.gao@intel.com>
Diffstat (limited to 'ShellPkg')
-rw-r--r--ShellPkg/Library/UefiShellAcpiViewCommandLib/AcpiParser.h4
1 files changed, 3 insertions, 1 deletions
diff --git a/ShellPkg/Library/UefiShellAcpiViewCommandLib/AcpiParser.h b/ShellPkg/Library/UefiShellAcpiViewCommandLib/AcpiParser.h
index 0b7726b9d5..5e34a70c8b 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.