summaryrefslogtreecommitdiffstats
path: root/extensions/openpower-pels
diff options
context:
space:
mode:
authorMatt Spinler <spinler@us.ibm.com>2019-10-25 11:12:46 -0500
committerMatt Spinler <spinler@us.ibm.com>2019-11-04 16:18:29 -0600
commitda031717543b48a75e193d5e4d846a80279ca90b (patch)
treef9db69eb968bcb4d0bb17dfb40270bf605cd321c /extensions/openpower-pels
parentafa857c70ad78fd91f50871005d8a2ef8bf6a59b (diff)
downloadphosphor-logging-da031717543b48a75e193d5e4d846a80279ca90b.tar.gz
phosphor-logging-da031717543b48a75e193d5e4d846a80279ca90b.zip
PEL: Document UserData sections
Add a section in the PEL README to document the UserData sections that will be created in every new PEL. Change-Id: I9ff9a69f1d22b56aa8bb9d559802d0595d787c0a Signed-off-by: Matt Spinler <spinler@us.ibm.com>
Diffstat (limited to 'extensions/openpower-pels')
-rw-r--r--extensions/openpower-pels/README.md9
1 files changed, 9 insertions, 0 deletions
diff --git a/extensions/openpower-pels/README.md b/extensions/openpower-pels/README.md
index bb47cce..14fade2 100644
--- a/extensions/openpower-pels/README.md
+++ b/extensions/openpower-pels/README.md
@@ -41,6 +41,15 @@ e.g.
_PID="12345"
```
+## Default UserData sections for BMC created PELs
+
+The extension code that creates PELs will add these UserData sections to every
+PEL:
+
+- The AdditionalData property contents
+ - If the AdditionalData property in the OpenBMC event log has anything in it,
+ it will be saved in a UserData section as a JSON string.
+
## The PEL Message Registry
The PEL message registry is used to create PELs from OpenBMC event logs.
OpenPOWER on IntegriCloud