tree e14d69a51614655f52dab19abc1b688ef582e3cd
parent cb2a8d64993584cdfecb1d1a5027421eddc99e2b
author Zane Shelley <zshelle@us.ibm.com> 1636821247 -0600
committer Matt Spinler <spinler@us.ibm.com> 1637080750 +0000

PEL: allow optional description in "Error Details"

In message_registry.json under "SRC" and "Words6To9", you must define
"AdditionalDataPropSource" for each hex word so that peltool will know
which additional user data field maps to hex words 6 through 9. You can
also define a "Description" field for each hex word, which will be
displayed in the "Error Details" section of the PEL. Currently, if
"AdditionalDataPropSource" is defined, then "Description" must be
defined as well. Otherwise, peltool will throw an error and none of the
PEL will be parsed, not even the user data sections.

The "Description" fields in the message registry are static and can
only have one definition per "ReasonCode". However, some components
need more dynamic descriptions of the hex words, which can be done with
python modules specifically created for SRC parsing. This parser output
will be displayed in the "SRC Details" section of the PEL. When the
parser is defined, there is no need to display any any additional
descriptions in the "Error Details" section. Unfortunately, if the
"Description" field is omitted then the "AdditionalDataPropSource" field
in the message registry would have to be omitted as well. The consequence
of this is that peltool would not know how to map the additional data
fields to hex words 6 through 9, which leave them as zero and breaks the
SRC parser because there no long is any data to parse.

This commit allows the "AdditionalDataPropSource" fields can be defined
without the "Description" field so that the data for hex words 6
through 9 can mapped correctly and not display any useless information
in the "Error Details" section of the PEL.

Signed-off-by: Zane Shelley <zshelle@us.ibm.com>
Change-Id: I3bf439e5d886df92c90b6d8d13410bbcf485a14d