reformat with latest settings
Reformat with the latest settings from openbmc-build-scripts (and
copy latest config files where appropriate). Fix a few minor
markdownlint issues.
Signed-off-by: Patrick Williams <patrick@stwcx.xyz>
Change-Id: I55205817c29dc3f182a165ddf9cd5d4e07b90063
diff --git a/yaml/org/open_power/Logging/PEL.interface.yaml b/yaml/org/open_power/Logging/PEL.interface.yaml
index a3e39f4..2765d64 100644
--- a/yaml/org/open_power/Logging/PEL.interface.yaml
+++ b/yaml/org/open_power/Logging/PEL.interface.yaml
@@ -70,8 +70,8 @@
- name: Message
type: string
description: >
- The Message property of the OpenBMC event log entry.
- This is also the key into the PEL message registry.
+ The Message property of the OpenBMC event log entry. This is
+ also the key into the PEL message registry.
- name: Severity
type: enum[xyz.openbmc_project.Logging.Entry.Level]
description: >
@@ -79,8 +79,7 @@
- name: AdditionalData
type: dict[string, string]
description: >
- The AdditionalData property of the event entry.
- e.g.:
+ The AdditionalData property of the event entry. e.g.:
{
"key1": "value1",
"key2": "value2"
@@ -88,22 +87,25 @@
ends up in AdditionaData like:
["KEY1=value1", "KEY2=value2"]
- name: FFDC
- type: array[struct[enum[xyz.openbmc_project.Logging.Create.FFDCFormat], byte, byte, unixfd]]
+ type:
+ array[struct[enum[xyz.openbmc_project.Logging.Create.FFDCFormat],
+ byte, byte, unixfd]]
description: >
- File descriptors for any files containing FFDC, along with metadata
- about the contents:
+ File descriptors for any files containing FFDC, along with
+ metadata about the contents:
FFDCFormat- The format type of the contained data.
subType - The format subtype, used for the 'Custom' type.
- version - The version of the data format, used for the 'Custom'
+ version - The version of the data format, used for the
+ 'Custom'
type.
unixfd - The file descriptor to the data file.
- e.g.:
- [
- {"xyz.openbmc_project.Logging.Create.FFDCFormat.JSON", 0, 0, 5},
- {"xyz.openbmc_project.Logging.Create.FFDCFormat.Custom", 1, 2, 6}
- ]
+ e.g.: [
+ {"xyz.openbmc_project.Logging.Create.FFDCFormat.JSON", 0, 0,
+ 5},
+ {"xyz.openbmc_project.Logging.Create.FFDCFormat.Custom", 1, 2,
+ 6} ]
returns:
- name: IDs
type: struct[uint32, uint32]
@@ -111,13 +113,13 @@
The IDs of the 2 created logs:
- OpenBMC event log ID
- PEL log ID: The unique ID of the PEL
- Note that the PEL's platform log ID (PLID) field is always
- equal to the PEL log ID for BMC created PELs.
+ Note that the PEL's platform log ID (PLID) field is always equal
+ to the PEL log ID for BMC created PELs.
- name: GetPELIdFromBMCLogId
description: >
- Returns the PEL Id (aka Entry ID (EID)) based on the
- given BMC event log id.
+ Returns the PEL Id (aka Entry ID (EID)) based on the given BMC event
+ log id.
parameters:
- name: bmcLogId
type: uint32
@@ -133,8 +135,8 @@
- name: GetBMCLogIdFromPELId
description: >
- Returns the BMC event log id based on the given PEL id (aka
- Entry ID (EID)).
+ Returns the BMC event log id based on the given PEL id (aka Entry ID
+ (EID)).
parameters:
- name: pelId
type: uint32
@@ -150,8 +152,7 @@
- name: GetPELJSON
description: >
- Returns a string containing the JSON representation
- of the PEL.
+ Returns a string containing the JSON representation of the PEL.
parameters:
- name: bmcLogId
type: uint32
diff --git a/yaml/org/open_power/Logging/PEL/Entry.interface.yaml b/yaml/org/open_power/Logging/PEL/Entry.interface.yaml
index 8576943..ad2a9a3 100644
--- a/yaml/org/open_power/Logging/PEL/Entry.interface.yaml
+++ b/yaml/org/open_power/Logging/PEL/Entry.interface.yaml
@@ -9,10 +9,10 @@
remain hidden from the customer. This event log is visible to
development personnel only, e.g. hardware recovered error, etc. No
service action is required for this type of errors. In general, when
- this value is used, the Error Action Flags has the value of
- "Hidden Error". An event log with this value is used primarily for
- error thresholding design/code debug or as a record to indicate an
- error frequency or trend.
+ this value is used, the Error Action Flags has the value of "Hidden
+ Error". An event log with this value is used primarily for error
+ thresholding design/code debug or as a record to indicate an error
+ frequency or trend.
- name: Subsystem
type: string
description: >
@@ -23,5 +23,5 @@
type: boolean
default: false
description: >
- Notifies the PEL handler that the management system acknowledged a PEL.
- The management system can be any system monitoring the hardware.
+ Notifies the PEL handler that the management system acknowledged a
+ PEL. The management system can be any system monitoring the hardware.