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/Dump/Create.interface.yaml b/yaml/xyz/openbmc_project/Dump/Create.interface.yaml
index e8094d2..bc43fe2 100644
--- a/yaml/xyz/openbmc_project/Dump/Create.interface.yaml
+++ b/yaml/xyz/openbmc_project/Dump/Create.interface.yaml
@@ -1,13 +1,12 @@
description: >
- Implement to capture various types of dumps from the
- host or BMC. This interface is for user to request a particular
- type of dump.
+ Implement to capture various types of dumps from the host or BMC. This
+ interface is for user to request a particular type of dump.
- Any OpenBMC implementation should provide one implementation
- of xyz.openbmc_project.Dump.Create per dump type on
- /xyz/openbmc_project/dump/<dump type>. On multi-host or on multi-BMC
- systems the instance number can be added to the path to differentiate,
- for example /xyz/openbmc_project/dump/<dump type><instance-id>.
+ Any OpenBMC implementation should provide one implementation of
+ xyz.openbmc_project.Dump.Create per dump type on
+ /xyz/openbmc_project/dump/<dump type>. On multi-host or on multi-BMC systems
+ the instance number can be added to the path to differentiate, for example
+ /xyz/openbmc_project/dump/<dump type><instance-id>.
methods:
- name: CreateDump
@@ -17,15 +16,13 @@
- name: AdditionalData
type: dict[string, variant[string,uint64]]
description: >
- The additional data, if any, for initiating the dump.
- The key in this case should be an implementation
- specific enum defined for the specific type of dump
- either in xyz or in a domain.
- The values can be either a string or a 64 bit number.
- The enum-format string is required to come from a
- parallel class with this specific Enum name.
- All of the Enum strings should be in the format
- 'domain.Dump.Create.CreateParameters.ParamName'.
+ The additional data, if any, for initiating the dump. The key in
+ this case should be an implementation specific enum defined for
+ the specific type of dump either in xyz or in a domain. The
+ values can be either a string or a 64 bit number. The
+ enum-format string is required to come from a parallel class
+ with this specific Enum name. All of the Enum strings should be
+ in the format 'domain.Dump.Create.CreateParameters.ParamName'.
e.g.:
{
"key1": "value1",
@@ -38,8 +35,8 @@
type: object_path
description: >
The object path of the object that implements
- xyz.openbmc_project.Common.Progress to track the progress
- of the dump
+ xyz.openbmc_project.Common.Progress to track the progress of the
+ dump
errors:
- xyz.openbmc_project.Common.File.Error.Open
- xyz.openbmc_project.Common.File.Error.Write
@@ -54,13 +51,13 @@
description: >
Additional parameters for creating the dump.
values:
- - name: 'OriginatorId'
- description: >
- Unique Id of the originator of the respective
- operation. This property is defined in xyz.openbmc_project.
- Common.OriginatedBy interface.
- - name: 'OriginatorType'
- description: >
- Type of the originator that initiated the respective
- operation. This property is defined in xyz.openbmc_project.
- Common.OriginatedBy interface.
+ - name: "OriginatorId"
+ description: >
+ Unique Id of the originator of the respective operation. This
+ property is defined in xyz.openbmc_project. Common.OriginatedBy
+ interface.
+ - name: "OriginatorType"
+ description: >
+ Type of the originator that initiated the respective operation.
+ This property is defined in xyz.openbmc_project.
+ Common.OriginatedBy interface.
diff --git a/yaml/xyz/openbmc_project/Dump/Entry.interface.yaml b/yaml/xyz/openbmc_project/Dump/Entry.interface.yaml
index a6de741..34c0868 100644
--- a/yaml/xyz/openbmc_project/Dump/Entry.interface.yaml
+++ b/yaml/xyz/openbmc_project/Dump/Entry.interface.yaml
@@ -2,12 +2,10 @@
Implement to provide Dump attributes.
Object which implements this interface must implement
- xyz.openbmc_project.Time.EpochTime for the Dump
- creation time.
- Object which implements this interface should implement
- xyz.openbmc_project.Object.Delete to allow the deletion of
- individual Dump objects (and its dump object manager should
- implement xyz.openbmc_project.Collection.DeleteAll).
+ xyz.openbmc_project.Time.EpochTime for the Dump creation time. Object which
+ implements this interface should implement xyz.openbmc_project.Object.Delete
+ to allow the deletion of individual Dump objects (and its dump object
+ manager should implement xyz.openbmc_project.Collection.DeleteAll).
methods:
- name: InitiateOffload
@@ -40,10 +38,9 @@
- name: Offloaded
type: boolean
description: >
- Indicates whether the dump is offloaded to a client.
- The BMC application which knows the status of the offload
- operation should set this to true once the entire dump is
- offloaded.
+ Indicates whether the dump is offloaded to a client. The BMC
+ application which knows the status of the offload operation should set
+ this to true once the entire dump is offloaded.
- name: OffloadUri
type: string
description: >
diff --git a/yaml/xyz/openbmc_project/Dump/Entry/BMC.interface.yaml b/yaml/xyz/openbmc_project/Dump/Entry/BMC.interface.yaml
index 562939b..7503cec 100644
--- a/yaml/xyz/openbmc_project/Dump/Entry/BMC.interface.yaml
+++ b/yaml/xyz/openbmc_project/Dump/Entry/BMC.interface.yaml
@@ -1,5 +1,5 @@
description: >
Implement this to add BMC dump management.
- BMC dump is generated on the BMC with debug data
- for debugging the issues encountered on the BMC.
+ BMC dump is generated on the BMC with debug data for debugging the issues
+ encountered on the BMC.
diff --git a/yaml/xyz/openbmc_project/Dump/Entry/FaultLog.interface.yaml b/yaml/xyz/openbmc_project/Dump/Entry/FaultLog.interface.yaml
index 6d74228..5c8b6b8 100644
--- a/yaml/xyz/openbmc_project/Dump/Entry/FaultLog.interface.yaml
+++ b/yaml/xyz/openbmc_project/Dump/Entry/FaultLog.interface.yaml
@@ -11,17 +11,16 @@
- name: AdditionalTypeName
type: string
description: >
- Additional string to further identify the Type (e.g. it
- can indicate the OEM format of a Crashdump)
+ Additional string to further identify the Type (e.g. it can indicate
+ the OEM format of a Crashdump)
flags:
- const
- name: PrimaryLogId
type: string
description: >
- This is intended to be a unique identifier, depending on
- Type, to reference the primary fault data log but is not
- intended otherwise to be programatically interpreted
- (e.g. string parsing)
+ This is intended to be a unique identifier, depending on Type, to
+ reference the primary fault data log but is not intended otherwise to
+ be programatically interpreted (e.g. string parsing)
flags:
- const
@@ -35,6 +34,6 @@
UEFI Common Platform Error Record
- name: Crashdump
description: >
- Collection of processor and chipset register values
- typically gathered for debugging purposes at the time
- of a crash (or sometimes on-demand)
+ Collection of processor and chipset register values typically
+ gathered for debugging purposes at the time of a crash (or
+ sometimes on-demand)
diff --git a/yaml/xyz/openbmc_project/Dump/Entry/System.interface.yaml b/yaml/xyz/openbmc_project/Dump/Entry/System.interface.yaml
index 634c3b7..397aed2 100644
--- a/yaml/xyz/openbmc_project/Dump/Entry/System.interface.yaml
+++ b/yaml/xyz/openbmc_project/Dump/Entry/System.interface.yaml
@@ -1,19 +1,18 @@
description: >
Implement this to add system dump management.
- System dumps are dump of the host memory and hardware states
- generated during a failure in the host firmware. This can be a huge
- dump stored in the host memory, the BMC doesnt store this dump but
- stream this dump to an external client based on the offload request.
- Apart from system generated system dump, users can also request for
- this kind of dump.
+ System dumps are dump of the host memory and hardware states generated
+ during a failure in the host firmware. This can be a huge dump stored in the
+ host memory, the BMC doesnt store this dump but stream this dump to an
+ external client based on the offload request. Apart from system generated
+ system dump, users can also request for this kind of dump.
properties:
- name: SourceDumpId
type: uint32
description: >
- The dump id provided by the source of the dump.
- There are dumps which get generated outside the BMC, like a
- system dump which gets generated and stored in the host memory.
- All dumps will have a unique id but when communicating
- to the source of the dump the SourceDumpId will be used.
+ The dump id provided by the source of the dump. There are dumps which
+ get generated outside the BMC, like a system dump which gets generated
+ and stored in the host memory. All dumps will have a unique id but
+ when communicating to the source of the dump the SourceDumpId will be
+ used.
diff --git a/yaml/xyz/openbmc_project/Dump/NewDump.interface.yaml b/yaml/xyz/openbmc_project/Dump/NewDump.interface.yaml
index 330f1c2..ed603fb 100644
--- a/yaml/xyz/openbmc_project/Dump/NewDump.interface.yaml
+++ b/yaml/xyz/openbmc_project/Dump/NewDump.interface.yaml
@@ -1,9 +1,9 @@
description: >
- Implement to notify the creation of new dump.
- Use this interface when the dump is already created and ready
- to be offloaded. This interface will add a new dump object with the
- properties provided. The existing internal create interface should
- be used when the data is collected and the dump needs to be packaged.
+ Implement to notify the creation of new dump. Use this interface when the
+ dump is already created and ready to be offloaded. This interface will add a
+ new dump object with the properties provided. The existing internal create
+ interface should be used when the data is collected and the dump needs to be
+ packaged.
Any OpenBMC implementation must provide exactly one implementation of
xyz.openbmc_project.Dump.NewDump on /xyz/openbmc_project/dump.
@@ -16,11 +16,11 @@
- name: SourceDumpId
type: uint32
description: >
- The dump id provided by the source of the dump.
- There are dumps which get generated outside the BMC, like a
- system dump which gets generated and stored in the host memory.
- All dumps will have a unique id but when communicating
- to the source of the dump the SourceDumpId will be used.
+ The dump id provided by the source of the dump. There are dumps
+ which get generated outside the BMC, like a system dump which
+ gets generated and stored in the host memory. All dumps will
+ have a unique id but when communicating to the source of the
+ dump the SourceDumpId will be used.
- name: Size
type: uint64
description: >