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/xyz/openbmc_project/PLDM/Event.interface.yaml b/yaml/xyz/openbmc_project/PLDM/Event.interface.yaml
index 62fa083..9206782 100644
--- a/yaml/xyz/openbmc_project/PLDM/Event.interface.yaml
+++ b/yaml/xyz/openbmc_project/PLDM/Event.interface.yaml
@@ -1,24 +1,22 @@
description: >
- Implement to emit D-Bus signal for PLDM Event Messages. PLDM Event
- Messages are PLDM monitoring and control messages that are used by
- a PLDM terminus to synchronously or asynchronously report PLDM events
- to a central party called the PLDM Event Receiver.
+ Implement to emit D-Bus signal for PLDM Event Messages. PLDM Event Messages
+ are PLDM monitoring and control messages that are used by a PLDM terminus to
+ synchronously or asynchronously report PLDM events to a central party called
+ the PLDM Event Receiver.
- When the PLDM daemon receives a sensorEvent of type stateSensorState,
- it emits the StateSensorEvent signal.
+ When the PLDM daemon receives a sensorEvent of type stateSensorState, it
+ emits the StateSensorEvent signal.
- This signal would be used by PLDM Requester apps on the BMC, which
- will rely on this signal to determine state changes on a connected
- PLDM entity.
+ This signal would be used by PLDM Requester apps on the BMC, which will rely
+ on this signal to determine state changes on a connected PLDM entity.
- More information about PLDM Event Messages can be found at DSP0248
- version 1.2.0 section 13.
+ More information about PLDM Event Messages can be found at DSP0248 version
+ 1.2.0 section 13.
signals:
- name: StateSensorEvent
description: >
- Signal indicating that a state sensor change EventMessage is
- received.
+ Signal indicating that a state sensor change EventMessage is received.
More information about properties can be found at DSP0248 version
1.2.0 table 19.
properties:
@@ -43,11 +41,11 @@
- name: eventState
type: byte
description: >
- The event state value from the state change that triggered
- the event message.
+ The event state value from the state change that triggered the
+ event message.
- name: previousEventState
type: byte
description: >
- The event state value for the state from which the present
- event state was entered.
+ The event state value for the state from which the present event
+ state was entered.
diff --git a/yaml/xyz/openbmc_project/PLDM/PDR.interface.yaml b/yaml/xyz/openbmc_project/PLDM/PDR.interface.yaml
index dcdec47..a366203 100644
--- a/yaml/xyz/openbmc_project/PLDM/PDR.interface.yaml
+++ b/yaml/xyz/openbmc_project/PLDM/PDR.interface.yaml
@@ -1,7 +1,7 @@
description: >
- Implement to fetch the PDRs. PDRs are Platform Descriptor
- Records which are the collection of information that includes semantic
- and association information.
+ Implement to fetch the PDRs. PDRs are Platform Descriptor Records which are
+ the collection of information that includes semantic and association
+ information.
This API would be used by PLDM Requester apps on the BMC.
@@ -35,8 +35,8 @@
- name: EntityID
type: uint16
description: >
- A numeric value that represents an entity that can be associated to
- a PLDM state set.
+ A numeric value that represents an entity that can be associated
+ to a PLDM state set.
More information is found at
http://dmtf.org/sites/default/files/standards/documents/DSP0249_1.0.0.pdf
@@ -45,8 +45,8 @@
- name: StateSetId
type: uint16
description: >
- A numeric value that identifies the PLDM State Set that is used with
- this sensor.
+ A numeric value that identifies the PLDM State Set that is used
+ with this sensor.
More information is found at
http://dmtf.org/sites/default/files/standards/documents/DSP0249_1.0.0.pdf
@@ -57,25 +57,25 @@
type: array[array[byte]]
description: >
Array of State Effecter PDRs, where a PDR is an array[byte].
- Multiple PDRs of the format present in table 89 of DSP0248 version
- 1.2.0 are returned. Each of the PDRs returned has the common header
- along with all the other fields in table 89 and 90 of
- DSP0248 of version 1.2.0 .
+ Multiple PDRs of the format present in table 89 of DSP0248
+ version 1.2.0 are returned. Each of the PDRs returned has the
+ common header along with all the other fields in table 89 and 90
+ of DSP0248 of version 1.2.0 .
errors:
- xyz.openbmc_project.Common.Error.ResourceNotFound
- name: FindStateSensorPDR
description: >
- Obtain the state sensor PDR, for the input TID,
- entity ID and state set id. If multiple PLDM entity instances
- (in state sensor PDRs) match the EntityId and StateSetId below,
- all the corresponding state sensor PDRs are returned. More than one PDR
- can be returned for the same state set id.
+ Obtain the state sensor PDR, for the input TID, entity ID and state
+ set id. If multiple PLDM entity instances (in state sensor PDRs) match
+ the EntityId and StateSetId below, all the corresponding state sensor
+ PDRs are returned. More than one PDR can be returned for the same
+ state set id.
- When the PDR for the given input TID, entity id
- and state set id is not found, then the
- xyz.openbmc_project.Common.Error.ResourceNotFound exception will be thrown.
+ When the PDR for the given input TID, entity id and state set id is
+ not found, then the xyz.openbmc_project.Common.Error.ResourceNotFound
+ exception will be thrown.
parameters:
- name: TID
@@ -86,25 +86,28 @@
- name: EntityID
type: uint16
description: >
- A numeric value that represents an entity that can be associated to a PLDM state set.
- More information is found at
- http://dmtf.org/sites/default/files/standards/documents/DSP0249_1.0.0.pdf section 7.
+ A numeric value that represents an entity that can be associated
+ to a PLDM state set. More information is found at
+ http://dmtf.org/sites/default/files/standards/documents/DSP0249_1.0.0.pdf
+ section 7.
- name: StateSetId
type: uint16
description: >
- A numeric value that identifies the PLDM State Set that is used with this sensor.
- More information is found at
- http://dmtf.org/sites/default/files/standards/documents/DSP0249_1.0.0.pdf section 6.
+ A numeric value that identifies the PLDM State Set that is used
+ with this sensor. More information is found at
+ http://dmtf.org/sites/default/files/standards/documents/DSP0249_1.0.0.pdf
+ section 6.
returns:
- name: StateSensorPDR
type: array[array[byte]]
description: >
- Array of State Sensor PDRs, where a PDR is an array[byte]. Multiple PDRs of the
- format present in table 80 of DSP0248 version 1.2.0 are returned. Each of the PDRs
- returned has the common header along with all the other fields in table 80 and 81 of
- DSP0248 of version 1.2.0 .
+ Array of State Sensor PDRs, where a PDR is an array[byte].
+ Multiple PDRs of the format present in table 80 of DSP0248
+ version 1.2.0 are returned. Each of the PDRs returned has the
+ common header along with all the other fields in table 80 and 81
+ of DSP0248 of version 1.2.0 .
errors:
- xyz.openbmc_project.Common.Error.ResourceNotFound
diff --git a/yaml/xyz/openbmc_project/PLDM/Provider/Certs/Authority/CSR.interface.yaml b/yaml/xyz/openbmc_project/PLDM/Provider/Certs/Authority/CSR.interface.yaml
index efee306..72606a1 100644
--- a/yaml/xyz/openbmc_project/PLDM/Provider/Certs/Authority/CSR.interface.yaml
+++ b/yaml/xyz/openbmc_project/PLDM/Provider/Certs/Authority/CSR.interface.yaml
@@ -1,17 +1,16 @@
description: >
- Implement this interface to pass CSR string to PLDM
- to get CSR signed by host.
+ Implement this interface to pass CSR string to PLDM to get CSR signed by
+ host.
- xyz.openbmc_project.Certs.ca.authority.Manager object implements
- this interface which is added in the below commit
+ xyz.openbmc_project.Certs.ca.authority.Manager object implements this
+ interface which is added in the below commit
https://gerrit.openbmc-project.xyz/c/openbmc/phosphor-dbus-interfaces/+/31808
properties:
- name: CSR
type: string
description: >
- Certificate signing request content.
- Should be a valid PEM encoded CSR string.
- It's a const property.
+ Certificate signing request content. Should be a valid PEM encoded CSR
+ string. It's a const property.
flags:
- const
diff --git a/yaml/xyz/openbmc_project/PLDM/Requester.interface.yaml b/yaml/xyz/openbmc_project/PLDM/Requester.interface.yaml
index 2585c82..928f7b8 100644
--- a/yaml/xyz/openbmc_project/PLDM/Requester.interface.yaml
+++ b/yaml/xyz/openbmc_project/PLDM/Requester.interface.yaml
@@ -31,17 +31,17 @@
granted to the input eid, then the
xyz.openbmc_project.Common.Error.TooManyResources exception will be
thrown. The recommendation for the caller upon receiving this
- exception is to retry calling this method, at least once, after a
- time period equal to the maximum instance id expiration interval,
- which is 6 seconds as per DSP0240 v1.0.0. If the exception persists
- post this interval, the way of handling the same (further retries,
- report an error, etc) is left to the user.
+ exception is to retry calling this method, at least once, after a time
+ period equal to the maximum instance id expiration interval, which is
+ 6 seconds as per DSP0240 v1.0.0. If the exception persists post this
+ interval, the way of handling the same (further retries, report an
+ error, etc) is left to the user.
parameters:
- name: eid
type: byte
description: >
- The MCTP endpoint, specified by 'eid' (endpoint id), for which the
- new PLDM instance id needs to be generated.
+ The MCTP endpoint, specified by 'eid' (endpoint id), for which
+ the new PLDM instance id needs to be generated.
returns:
- name: instanceid
type: byte