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/freedesktop/UPower/Device.interface.yaml b/yaml/org/freedesktop/UPower/Device.interface.yaml
index cb1ef82..b98c120 100644
--- a/yaml/org/freedesktop/UPower/Device.interface.yaml
+++ b/yaml/org/freedesktop/UPower/Device.interface.yaml
@@ -28,17 +28,21 @@
- name: resolution
type: uint32
description: >
- "The approximate number of points to return. A higher resolution is
+ "The approximate number of points to return. A higher resolution
+ is
more accurate, at the expense of plotting speed."
returns:
- name: data
type: array[struct[uint32, double, uint32]]
description: >
"The history data for the power device, if the device supports
- history. Data is ordered from the earliest in time, to the newest
+ history. Data is ordered from the earliest in time, to the
+ newest
data point. Each element contains the following members:
- time: The time value in seconds from the gettimeofday() method.
- value: The data value, for instance the rate in W or the charge
+ time: The time value in seconds from the gettimeofday()
+ method.
+ value: The data value, for instance the rate in W or the
+ charge
in %.
state: The state of the device, for instance charging or
discharging."
@@ -57,7 +61,8 @@
- name: data
type: array[struct[double, double]]
description: >
- "The statistics data for the power device. Each element contains the
+ "The statistics data for the power device. Each element contains
+ the
following members:
value: The value of the percentage point, usually in seconds.
accuracy: The accuracy of the prediction in percent."
@@ -277,7 +282,8 @@
description: >
"Level of the battery:
0: Unknown
- 1: None (the battery does not use a coarse level of battery reporting)
+ 1: None (the battery does not use a coarse level of battery
+ reporting)
3: Low
4: Critical
6: Normal
diff --git a/yaml/org/open_power/Control/Host.interface.yaml b/yaml/org/open_power/Control/Host.interface.yaml
index 86dcde1..86014c4 100644
--- a/yaml/org/open_power/Control/Host.interface.yaml
+++ b/yaml/org/open_power/Control/Host.interface.yaml
@@ -1,10 +1,10 @@
description: >
- Implement to provide host interface support.
- This will define the interfaces using which, a OpenPower
- machine can communicate with host on agreed commands.
+ Implement to provide host interface support. This will define the interfaces
+ using which, a OpenPower machine can communicate with host on agreed
+ commands.
- This is for Internal use by the Firmware only. The D-Bus object
- is visible for the REST but it must not be used.
+ This is for Internal use by the Firmware only. The D-Bus object is visible
+ for the REST but it must not be used.
methods:
- name: Execute
@@ -39,11 +39,10 @@
values:
- name: OCCReset
description: >
- Host firmware should reset the OCC. This is invoked by
- OCC error monitor application on detecting the error.
- Sensor ID of the failing OCC will be sent as data.
- This command will return once the command has been placed
- in command Queue.
+ Host firmware should reset the OCC. This is invoked by OCC error
+ monitor application on detecting the error. Sensor ID of the
+ failing OCC will be sent as data. This command will return once
+ the command has been placed in command Queue.
- name: Result
description: >
diff --git a/yaml/org/open_power/Control/TPM/SecurityKeys.interface.yaml b/yaml/org/open_power/Control/TPM/SecurityKeys.interface.yaml
index 89f46a4..459c5cc 100644
--- a/yaml/org/open_power/Control/TPM/SecurityKeys.interface.yaml
+++ b/yaml/org/open_power/Control/TPM/SecurityKeys.interface.yaml
@@ -5,15 +5,15 @@
- name: ClearHostSecurityKeys
type: byte
description: >
- This is a bit mask used to specify clearing different security keys
- or resetting those values back to default by the host. Setting this
+ This is a bit mask used to specify clearing different security keys or
+ resetting those values back to default by the host. Setting this
property does not guarantee a successful operation as additional
conditions will be checked by the host to clear/reset the sensitive
data. This property will be mapped to a new IPMI sensor.
- The new property is having an integer value and the default value
- will be zero. The end operation is determined by the bit value set
- and some of the customer use cases which maps to bit value are
+ The new property is having an integer value and the default value will
+ be zero. The end operation is determined by the bit value set and some
+ of the customer use cases which maps to bit value are
Bit 0 - Clear All : Clear/reset all the sensitive data controlled by
platform firmware from the system. System can generate new
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.
diff --git a/yaml/org/open_power/OCC/PassThrough.interface.yaml b/yaml/org/open_power/OCC/PassThrough.interface.yaml
index 1a4ef66..d592b26 100644
--- a/yaml/org/open_power/OCC/PassThrough.interface.yaml
+++ b/yaml/org/open_power/OCC/PassThrough.interface.yaml
@@ -12,8 +12,9 @@
type: array[int32]
description: >
An array of integers representing the command and payload. This
- should still be bytes worth of data (as though using array[byte]),
- so each entry in the array should pack as many bytes as possible.
+ should still be bytes worth of data (as though using
+ array[byte]), so each entry in the array should pack as many
+ bytes as possible.
returns:
- name: response
# TODO via https://github.com/openbmc/openbmc/issues/1160. This should
@@ -21,9 +22,9 @@
# data to int32.
type: array[int32]
description: >
- An array of integers representing the response. This
- should still be bytes worth of data (as though using array[byte]),
- so each entry in the array should pack as many bytes as possible.
+ An array of integers representing the response. This should
+ still be bytes worth of data (as though using array[byte]), so
+ each entry in the array should pack as many bytes as possible.
- name: SetMode
description: >
diff --git a/yaml/org/open_power/Sensor/Aggregation/History/Average.interface.yaml b/yaml/org/open_power/Sensor/Aggregation/History/Average.interface.yaml
index ae2c326..1d6e89f 100644
--- a/yaml/org/open_power/Sensor/Aggregation/History/Average.interface.yaml
+++ b/yaml/org/open_power/Sensor/Aggregation/History/Average.interface.yaml
@@ -7,20 +7,20 @@
- name: Scale
type: int64
description: >
- The reading scaling factor N, where the actual reading is value * 10^N.
- This is immutable once set.
+ The reading scaling factor N, where the actual reading is value *
+ 10^N. This is immutable once set.
- name: Unit
type: enum[self.Unit]
description: >
- The unit of the reading. Immutable once set for a sensor.
- For objects in the temperature namespace, Unit must be "DegreesC".
- For objects in the fan_tach namespace, Unit must be "RPMS".
- For objects in the voltage namespace, Unit must be "Volts".
- For objects in the altitude namespace, Unit must be "Meters".
- For objects in the current namespace, Unit must be "Amperes".
- For objects in the power namespace, Unit must be "Watts".
- For objects in the energy namespace, Unit must be "Joules".
+ The unit of the reading. Immutable once set for a sensor. For objects
+ in the temperature namespace, Unit must be "DegreesC". For objects in
+ the fan_tach namespace, Unit must be "RPMS". For objects in the
+ voltage namespace, Unit must be "Volts". For objects in the altitude
+ namespace, Unit must be "Meters". For objects in the current
+ namespace, Unit must be "Amperes". For objects in the power namespace,
+ Unit must be "Watts". For objects in the energy namespace, Unit must
+ be "Joules".
- name: Values
type: array[struct[uint64,int64]]
diff --git a/yaml/org/open_power/Sensor/Aggregation/History/Maximum.interface.yaml b/yaml/org/open_power/Sensor/Aggregation/History/Maximum.interface.yaml
index 9143ce4..92adeae 100644
--- a/yaml/org/open_power/Sensor/Aggregation/History/Maximum.interface.yaml
+++ b/yaml/org/open_power/Sensor/Aggregation/History/Maximum.interface.yaml
@@ -7,20 +7,20 @@
- name: Scale
type: int64
description: >
- The reading scaling factor N, where the actual reading is value * 10^N.
- This is immutable once set.
+ The reading scaling factor N, where the actual reading is value *
+ 10^N. This is immutable once set.
- name: Unit
type: enum[self.Unit]
description: >
- The unit of the reading. Immutable once set for a sensor.
- For objects in the temperature namespace, Unit must be "DegreesC".
- For objects in the fan_tach namespace, Unit must be "RPMS".
- For objects in the voltage namespace, Unit must be "Volts".
- For objects in the altitude namespace, Unit must be "Meters".
- For objects in the current namespace, Unit must be "Amperes".
- For objects in the power namespace, Unit must be "Watts".
- For objects in the energy namespace, Unit must be "Joules".
+ The unit of the reading. Immutable once set for a sensor. For objects
+ in the temperature namespace, Unit must be "DegreesC". For objects in
+ the fan_tach namespace, Unit must be "RPMS". For objects in the
+ voltage namespace, Unit must be "Volts". For objects in the altitude
+ namespace, Unit must be "Meters". For objects in the current
+ namespace, Unit must be "Amperes". For objects in the power namespace,
+ Unit must be "Watts". For objects in the energy namespace, Unit must
+ be "Joules".
- name: Values
type: array[struct[uint64,int64]]