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/com/ibm/Dump/Create.interface.yaml b/yaml/com/ibm/Dump/Create.interface.yaml
index 847b64a..80147c0 100644
--- a/yaml/com/ibm/Dump/Create.interface.yaml
+++ b/yaml/com/ibm/Dump/Create.interface.yaml
@@ -1,7 +1,7 @@
description: >
- Implement this to pass additional parameters to the create dump.
- Each required parameter for the dump in the ibm domain should be added
- here as an enum.
+ Implement this to pass additional parameters to the create dump. Each
+ required parameter for the dump in the ibm domain should be added here as an
+ enum.
enumerations:
- name: CreateParameters
@@ -10,11 +10,10 @@
values:
- name: "VSPString"
description: >
- The resouce dump is collected from various host resources.
- The resource to collect the dump is indicated by using the
- resource selector.
- The resource selector string needs to be passed to host to
- generate a resource dump.
+ The resouce dump is collected from various host resources. The
+ resource to collect the dump is indicated by using the resource
+ selector. The resource selector string needs to be passed to
+ host to generate a resource dump.
- name: "Password"
description: >
The password for authenticating the resource dump request.
diff --git a/yaml/com/ibm/Dump/Entry/Hardware.interface.yaml b/yaml/com/ibm/Dump/Entry/Hardware.interface.yaml
index fd9ac4b..9053cee 100644
--- a/yaml/com/ibm/Dump/Entry/Hardware.interface.yaml
+++ b/yaml/com/ibm/Dump/Entry/Hardware.interface.yaml
@@ -1,7 +1,7 @@
description: >
Implement this to add Hardware dump management.
- Hardware dump is a collection hardware state information,
- including various registers, and it is used for debugging
- system checkstop. checkstop is the descriptive term for
- entire system termination by the hardware due to a detected error.
+ Hardware dump is a collection hardware state information, including various
+ registers, and it is used for debugging system checkstop. checkstop is the
+ descriptive term for entire system termination by the hardware due to a
+ detected error.
diff --git a/yaml/com/ibm/Dump/Entry/Hostboot.interface.yaml b/yaml/com/ibm/Dump/Entry/Hostboot.interface.yaml
index da8a0f6..f2b5f2f 100644
--- a/yaml/com/ibm/Dump/Entry/Hostboot.interface.yaml
+++ b/yaml/com/ibm/Dump/Entry/Hostboot.interface.yaml
@@ -1,6 +1,5 @@
description: >
Implement this to add Hostboot dump management.
- Hostboot dump collects memory and hardware states
- in the case of a failure during hostboot booting
- phase.
+ Hostboot dump collects memory and hardware states in the case of a failure
+ during hostboot booting phase.
diff --git a/yaml/com/ibm/Dump/Entry/Resource.interface.yaml b/yaml/com/ibm/Dump/Entry/Resource.interface.yaml
index 17a38d9..ffedff4 100644
--- a/yaml/com/ibm/Dump/Entry/Resource.interface.yaml
+++ b/yaml/com/ibm/Dump/Entry/Resource.interface.yaml
@@ -1,20 +1,19 @@
description: >
Implement this to add Resource dump management.
- The resource dumps are special types of dumps
- generated by host hypervisor. The dump is generated
- based on the resource selector. Hyperviosr needs
- a password to validate the request before creating the dump.
+ The resource dumps are special types of dumps generated by host hypervisor.
+ The dump is generated based on the resource selector. Hyperviosr needs a
+ password to validate the request before creating the 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
- resource 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 resource 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: VSPString
type: string
description: >
diff --git a/yaml/com/ibm/Logging/Policy.interface.yaml b/yaml/com/ibm/Logging/Policy.interface.yaml
index 2dc6d05..8b971e7 100644
--- a/yaml/com/ibm/Logging/Policy.interface.yaml
+++ b/yaml/com/ibm/Logging/Policy.interface.yaml
@@ -4,8 +4,8 @@
- name: EventID
type: string
description: >
- This ID is defined by IBM service to uniquely identify an error
- in the service documentation.
+ This ID is defined by IBM service to uniquely identify an error in the
+ service documentation.
- name: Description
type: string
description: >
diff --git a/yaml/com/ibm/VPD.errors.yaml b/yaml/com/ibm/VPD.errors.yaml
index a69e8c1..da408f0 100644
--- a/yaml/com/ibm/VPD.errors.yaml
+++ b/yaml/com/ibm/VPD.errors.yaml
@@ -9,16 +9,14 @@
- name: KeywordNotFound
description: Keyword is not found.
- name: BlankSystemVPD
- description: System VPD is blank on both hardware and cache.
- On IBM systems, certain VPD data must be available
- for the system to boot. This error is used to
+ description:
+ System VPD is blank on both hardware and cache. On IBM systems, certain
+ VPD data must be available for the system to boot. This error is used to
indicate that no valid data was found by the BMC.
- name: InvalidEepromPath
- description: EEPROM path is invalid. Parser failed to access the
- path.
+ description: EEPROM path is invalid. Parser failed to access the path.
- name: InvalidVPD
- description: VPD file is not valid. Mandatory records are missing
- in VPD file.
+ description: VPD file is not valid. Mandatory records are missing in VPD file.
- name: EccCheckFailed
desciption: Invalid VPD data. Ecc check for the data failed.
- name: InvalidJson
diff --git a/yaml/com/ibm/VPD/Manager.interface.yaml b/yaml/com/ibm/VPD/Manager.interface.yaml
index 2dfae1b..8d1409d 100644
--- a/yaml/com/ibm/VPD/Manager.interface.yaml
+++ b/yaml/com/ibm/VPD/Manager.interface.yaml
@@ -29,8 +29,8 @@
- name: GetFRUsByUnexpandedLocationCode
description: >
- A method to get list of FRU D-BUS object paths for a given
- unexpanded location code.
+ A method to get list of FRU D-BUS object paths for a given unexpanded
+ location code.
parameters:
- name: locationCode
type: string
@@ -39,8 +39,8 @@
- name: nodeNumber
type: uint16
description: >
- Denotes the node in case of a multi-node configuration,
- ignored on a single node system.
+ Denotes the node in case of a multi-node configuration, ignored
+ on a single node system.
returns:
- name: inventoryList
type: array[object_path]
@@ -75,8 +75,8 @@
- name: GetExpandedLocationCode
description: >
An api to get expanded location code corresponding to a given
- un-expanded location code.
- Expanded location codes gives the location of the FRU in the system.
+ un-expanded location code. Expanded location codes gives the location
+ of the FRU in the system.
parameters:
- name: locationCode
type: string
@@ -85,8 +85,8 @@
- name: nodeNumber
type: uint16
description: >
- Denotes the node in case of multi-node configuration.
- Ignored in case of single node configuration.
+ Denotes the node in case of multi-node configuration. Ignored in
+ case of single node configuration.
returns:
- name: locationCode
type: string
diff --git a/yaml/com/ibm/ipzvpd/CP00.interface.yaml b/yaml/com/ibm/ipzvpd/CP00.interface.yaml
index bbc5652..9016512 100644
--- a/yaml/com/ibm/ipzvpd/CP00.interface.yaml
+++ b/yaml/com/ibm/ipzvpd/CP00.interface.yaml
@@ -32,8 +32,7 @@
- name: PZ
type: array[byte]
description: >
- PZ keyword.On Chip Precision Voltage Reference,
- PVREF.
+ PZ keyword.On Chip Precision Voltage Reference, PVREF.
- name: AW
type: array[byte]
description: >
diff --git a/yaml/com/ibm/ipzvpd/CRP0.interface.yaml b/yaml/com/ibm/ipzvpd/CRP0.interface.yaml
index 558c450..c5d2a91 100644
--- a/yaml/com/ibm/ipzvpd/CRP0.interface.yaml
+++ b/yaml/com/ibm/ipzvpd/CRP0.interface.yaml
@@ -44,8 +44,7 @@
- name: PD_W
type: array[byte]
description: >
- The "#W" keyword.DDS configuration and calibration
- settings.
+ The "#W" keyword.DDS configuration and calibration settings.
- name: PD_V
type: array[byte]
description: >
diff --git a/yaml/com/ibm/ipzvpd/Location.interface.yaml b/yaml/com/ibm/ipzvpd/Location.interface.yaml
index c64e7a8..5244db8 100644
--- a/yaml/com/ibm/ipzvpd/Location.interface.yaml
+++ b/yaml/com/ibm/ipzvpd/Location.interface.yaml
@@ -4,5 +4,5 @@
- name: LocationCode
type: string
description: >
- A string describing the physical location of the FRU.
- The location is determined based on the system design.
+ A string describing the physical location of the FRU. The location is
+ determined based on the system design.
diff --git a/yaml/com/ibm/ipzvpd/README.md b/yaml/com/ibm/ipzvpd/README.md
index 6604577..839a114 100644
--- a/yaml/com/ibm/ipzvpd/README.md
+++ b/yaml/com/ibm/ipzvpd/README.md
@@ -1,12 +1,12 @@
# IPZ VPD D-Bus Interfaces
-IPZ is a VPD (Vital Product Data) format used in IBM Power systems.
-The format consists of keywords that are stored as key-value
-pairs (Keyword name and its value). Keywords are grouped into records,
-usually with similar function grouped into a single record.
+IPZ is a VPD (Vital Product Data) format used in IBM Power systems. The format
+consists of keywords that are stored as key-value pairs (Keyword name and its
+value). Keywords are grouped into records, usually with similar function grouped
+into a single record.
-The [OpenPower VPD] [1] format is quite similar to the IPZ format
-and describes the record-keyword structure.
+The [OpenPower VPD] [1] format is quite similar to the IPZ format and describes
+the record-keyword structure.
Also refer to the [VPD Collection design document] [2] that describes how the
VPD collection application on the BMC will parse and publish the VPD data for
@@ -14,8 +14,9 @@
The D-Bus interfaces defined here describe how IPZ VPD will be made available on
D-Bus. Each YAML here represents a record in the IPZ VPD and keywords that
-belong to that record are represented as properties under that interface.
-The type of every property shall be a byte array.
+belong to that record are represented as properties under that interface. The
+type of every property shall be a byte array.
-[1]: https://www-355.ibm.com/systems/power/openpower/posting.xhtml?postingId=1D060729AC96891885257E1B0053BC95
+[1]:
+ https://www-355.ibm.com/systems/power/openpower/posting.xhtml?postingId=1D060729AC96891885257E1B0053BC95
[2]: https://github.com/openbmc/docs/blob/master/designs/vpd-collection.md
diff --git a/yaml/com/ibm/ipzvpd/VER0.interface.yaml b/yaml/com/ibm/ipzvpd/VER0.interface.yaml
index 1c0d3c8..413a6ea 100644
--- a/yaml/com/ibm/ipzvpd/VER0.interface.yaml
+++ b/yaml/com/ibm/ipzvpd/VER0.interface.yaml
@@ -1,6 +1,6 @@
description: >
- Implement to represent the VER0 record (contains vendor repair data)
- in IPZ VPD
+ Implement to represent the VER0 record (contains vendor repair data) in IPZ
+ VPD
properties:
- name: RT
type: array[byte]