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/Inventory/Connector/Slot.interface.yaml b/yaml/xyz/openbmc_project/Inventory/Connector/Slot.interface.yaml
index e3c6855..c19d4ae 100644
--- a/yaml/xyz/openbmc_project/Inventory/Connector/Slot.interface.yaml
+++ b/yaml/xyz/openbmc_project/Inventory/Connector/Slot.interface.yaml
@@ -1,4 +1,4 @@
description: >
- Implement to provide slot connector attributes. An slot component is
- a swappable component that can be removed by a user and considered
+ Implement to provide slot connector attributes. An slot component is a
+ swappable component that can be removed by a user and considered
field-replaceable. The slot compoment represents a PCIe slot connections.
diff --git a/yaml/xyz/openbmc_project/Inventory/Decorator/Asset.interface.yaml b/yaml/xyz/openbmc_project/Inventory/Decorator/Asset.interface.yaml
index 5db5c00..ac8a440 100644
--- a/yaml/xyz/openbmc_project/Inventory/Decorator/Asset.interface.yaml
+++ b/yaml/xyz/openbmc_project/Inventory/Decorator/Asset.interface.yaml
@@ -16,10 +16,9 @@
- name: BuildDate
type: string
description: >
- The date of item manufacture in ISO 8601 format, either as
- YYYYMMDD or YYYYMMDDThhmmssZ. Where 'T' is a literal character
- to separate date fields from time and 'Z' is a literal character
- to indicate UTC.
+ The date of item manufacture in ISO 8601 format, either as YYYYMMDD or
+ YYYYMMDDThhmmssZ. Where 'T' is a literal character to separate date
+ fields from time and 'Z' is a literal character to indicate UTC.
- name: Model
type: string
description: >
@@ -32,9 +31,8 @@
- name: SparePartNumber
type: string
description: >
- An alternative PartNumber used for field replacement of the
- Asset.
- A default value (empty string) indicates that the Asset has
- no specific SparePartNumber and instead PartNumber should
- be used in user interfaces.
+ An alternative PartNumber used for field replacement of the Asset. A
+ default value (empty string) indicates that the Asset has no specific
+ SparePartNumber and instead PartNumber should be used in user
+ interfaces.
default: ""
diff --git a/yaml/xyz/openbmc_project/Inventory/Decorator/Cacheable.interface.yaml b/yaml/xyz/openbmc_project/Inventory/Decorator/Cacheable.interface.yaml
index 36019dc..88938ed 100644
--- a/yaml/xyz/openbmc_project/Inventory/Decorator/Cacheable.interface.yaml
+++ b/yaml/xyz/openbmc_project/Inventory/Decorator/Cacheable.interface.yaml
@@ -4,5 +4,5 @@
- name: Cached
type: boolean
description: >
- Whether or not the item is cached. When true, the item
- and its remaining attributes are undefined.
+ Whether or not the item is cached. When true, the item and its
+ remaining attributes are undefined.
diff --git a/yaml/xyz/openbmc_project/Inventory/Decorator/Compatible.interface.yaml b/yaml/xyz/openbmc_project/Inventory/Decorator/Compatible.interface.yaml
index 1f86b3a..1743b87 100644
--- a/yaml/xyz/openbmc_project/Inventory/Decorator/Compatible.interface.yaml
+++ b/yaml/xyz/openbmc_project/Inventory/Decorator/Compatible.interface.yaml
@@ -3,9 +3,9 @@
(xyz.openbmc_project.Inventory.Decorator.Asset) for their components that
don't require different software configurations.
- xyz.openbmc_project.Inventory.Decorator.Compatible can be implemented to
- add an additional, more generalized dimension of classification to
- inventory components.
+ xyz.openbmc_project.Inventory.Decorator.Compatible can be implemented to add
+ an additional, more generalized dimension of classification to inventory
+ components.
properties:
- name: Names
type: array[string]
diff --git a/yaml/xyz/openbmc_project/Inventory/Decorator/CoolingType.interface.yaml b/yaml/xyz/openbmc_project/Inventory/Decorator/CoolingType.interface.yaml
index 759cbda..9139c20 100644
--- a/yaml/xyz/openbmc_project/Inventory/Decorator/CoolingType.interface.yaml
+++ b/yaml/xyz/openbmc_project/Inventory/Decorator/CoolingType.interface.yaml
@@ -1,5 +1,6 @@
description: >
- Implement properties to indicate the element cooling type (air, water, etc.).
+ Implement properties to indicate the element cooling type (air, water,
+ etc.).
properties:
- name: AirCooled
type: boolean
diff --git a/yaml/xyz/openbmc_project/Inventory/Decorator/LocationCode.interface.yaml b/yaml/xyz/openbmc_project/Inventory/Decorator/LocationCode.interface.yaml
index 3ca7145..81de698 100644
--- a/yaml/xyz/openbmc_project/Inventory/Decorator/LocationCode.interface.yaml
+++ b/yaml/xyz/openbmc_project/Inventory/Decorator/LocationCode.interface.yaml
@@ -3,9 +3,9 @@
properties:
- name: LocationCode
type: string
- description: A free form, implementation defined string to provide
- location code of an Inventory Item.
- Location codes can be used to identify specific parts
- in a system. Although this field should not be used for
+ description:
+ A free form, implementation defined string to provide location code of
+ an Inventory Item. Location codes can be used to identify specific
+ parts in a system. Although this field should not be used for
programmatic interrogation of an inventory object.
default: ""
diff --git a/yaml/xyz/openbmc_project/Inventory/Decorator/ManufacturerExt.interface.yaml b/yaml/xyz/openbmc_project/Inventory/Decorator/ManufacturerExt.interface.yaml
index d2b6831..d0a8449 100644
--- a/yaml/xyz/openbmc_project/Inventory/Decorator/ManufacturerExt.interface.yaml
+++ b/yaml/xyz/openbmc_project/Inventory/Decorator/ManufacturerExt.interface.yaml
@@ -5,11 +5,11 @@
- name: ExtendedMFGData
type: dict[string, string]
description: >
- A dictionary of manufacturer-specific extended data fields, which
- may contain fields such as manufacturing plant, lot number, etc.
+ A dictionary of manufacturer-specific extended data fields, which may
+ contain fields such as manufacturing plant, lot number, etc.
- These fields must not be used for programmatic interrogation of
- an inventory object but may be useful for various human-oriented
- tasks, such as part failure analysis. Any field needed for
- programmatic interrogation should be promoted to a first-class
- property in another Item or Decorator interface.
+ These fields must not be used for programmatic interrogation of an
+ inventory object but may be useful for various human-oriented tasks,
+ such as part failure analysis. Any field needed for programmatic
+ interrogation should be promoted to a first-class property in another
+ Item or Decorator interface.
diff --git a/yaml/xyz/openbmc_project/Inventory/Decorator/MeetsMinimumShipLevel.interface.yaml b/yaml/xyz/openbmc_project/Inventory/Decorator/MeetsMinimumShipLevel.interface.yaml
index bc7b7f1..2869c30 100644
--- a/yaml/xyz/openbmc_project/Inventory/Decorator/MeetsMinimumShipLevel.interface.yaml
+++ b/yaml/xyz/openbmc_project/Inventory/Decorator/MeetsMinimumShipLevel.interface.yaml
@@ -1,11 +1,11 @@
description: >
'Applications may implement the MeetsMinimumShipLevel (MSL) decorator on an
- object in the inventory namespace to denote that the item does or does
- not meet an implementation defined minimum level for shipment requirement.
+ object in the inventory namespace to denote that the item does or does not
+ meet an implementation defined minimum level for shipment requirement.
There are no requirements on how implementations react to inventory items
- that do or do not meet the MSL. Typical reactions might be to prevent
- a system from powering on or logging events.'
+ that do or do not meet the MSL. Typical reactions might be to prevent a
+ system from powering on or logging events.'
properties:
- name: MeetsMinimumShipLevel
diff --git a/yaml/xyz/openbmc_project/Inventory/Decorator/UniqueIdentifier.interface.yaml b/yaml/xyz/openbmc_project/Inventory/Decorator/UniqueIdentifier.interface.yaml
index fbfc423..adc0e70 100644
--- a/yaml/xyz/openbmc_project/Inventory/Decorator/UniqueIdentifier.interface.yaml
+++ b/yaml/xyz/openbmc_project/Inventory/Decorator/UniqueIdentifier.interface.yaml
@@ -5,6 +5,6 @@
type: string
description: >
A free form, implementation defined string which uniquely and
- permanently identifies a specific inventory item. This is complementary
- to the item's serial number. This field should not be used for
- programmatic interrogation of an object.
+ permanently identifies a specific inventory item. This is
+ complementary to the item's serial number. This field should not be
+ used for programmatic interrogation of an object.
diff --git a/yaml/xyz/openbmc_project/Inventory/Decorator/VendorInformation.interface.yaml b/yaml/xyz/openbmc_project/Inventory/Decorator/VendorInformation.interface.yaml
index 6d4eadc..1d9535b 100644
--- a/yaml/xyz/openbmc_project/Inventory/Decorator/VendorInformation.interface.yaml
+++ b/yaml/xyz/openbmc_project/Inventory/Decorator/VendorInformation.interface.yaml
@@ -1,6 +1,5 @@
description: >
- Implement to provide custom properties added to an item by the
- item vendor.
+ Implement to provide custom properties added to an item by the item vendor.
properties:
- name: CustomField1
type: string
diff --git a/yaml/xyz/openbmc_project/Inventory/Item.interface.yaml b/yaml/xyz/openbmc_project/Inventory/Item.interface.yaml
index 44f8d8c..4ef840b 100644
--- a/yaml/xyz/openbmc_project/Inventory/Item.interface.yaml
+++ b/yaml/xyz/openbmc_project/Inventory/Item.interface.yaml
@@ -1,6 +1,6 @@
description: >
- Implement to provide basic item attributes. Required by all objects
- within the inventory namespace.
+ Implement to provide basic item attributes. Required by all objects within
+ the inventory namespace.
Any service implementing Inventory.Item on one or more objects must
implement org.freedesktop.DBus.ObjectManager on
@@ -20,8 +20,8 @@
- name: containing
description: >
Any inventory Items (usually Boards or Chassis) can optionally
- implement the 'containing' association to provide one or more links
- to Items which it physically contains.
+ implement the 'containing' association to provide one or more links to
+ Items which it physically contains.
reverse_name: contained_by
required_endpoint_interfaces:
- xyz.openbmc_project.Inventory.Item
@@ -35,40 +35,39 @@
- xyz.openbmc_project.Inventory.Item
- name: sensors
description: >
- Sensors may implement an 'inventory' to 'sensors' association with
- the inventory item related to it.
+ Sensors may implement an 'inventory' to 'sensors' association with the
+ inventory item related to it.
reverse_names:
- inventory
required_endpoint_interfaces:
- xyz.openbmc_project.Sensor.Value
- name: cooled_by
description: >
- Objects that implement Item can optionally implement the
- 'cooled_by' association to provide a link to one or more fans.
+ Objects that implement Item can optionally implement the 'cooled_by'
+ association to provide a link to one or more fans.
reverse_name: cooling
required_endpoint_interfaces:
- xyz.openbmc_project.Inventory.Item.Fan
- name: identified_by
description: >
Objects that implement Item can optionally implement the
- 'identified_by' association to provide a link to one or more
- LED Groups.
+ 'identified_by' association to provide a link to one or more LED
+ Groups.
reverse_name: identifying
required_endpoint_interfaces:
- xyz.openbmc_project.Led.Group
- name: fault_identified_by
description: >
Objects that implement Item can optionally implement the
- 'fault_identified_by' association to provide a link to one or more
- LED Groups.
+ 'fault_identified_by' association to provide a link to one or more LED
+ Groups.
reverse_name: fault_identifying
required_endpoint_interfaces:
- xyz.openbmc_project.Led.Group
- name: powered_by
description: >
- Objects that implement Item can optionally implement the
- 'powered_by' association to provide a link to one or more
- power supplies.
+ Objects that implement Item can optionally implement the 'powered_by'
+ association to provide a link to one or more power supplies.
reverse_name: powering
required_endpoint_interfaces:
- xyz.openbmc_project.Inventory.Item.PowerSupply
diff --git a/yaml/xyz/openbmc_project/Inventory/Item/Accelerator.interface.yaml b/yaml/xyz/openbmc_project/Inventory/Item/Accelerator.interface.yaml
index b6ed9d5..e88b9c6 100644
--- a/yaml/xyz/openbmc_project/Inventory/Item/Accelerator.interface.yaml
+++ b/yaml/xyz/openbmc_project/Inventory/Item/Accelerator.interface.yaml
@@ -1,8 +1,8 @@
description: >
- Implement to provide hardware accelerator attributes. A hardware
- accelerator used to perform some functions more efficiently than is
- possible in software running on a general-purpose CPU. Examples of
- possible hardware accelerators include: GPUs, FPGAs, and ASICs.
+ Implement to provide hardware accelerator attributes. A hardware accelerator
+ used to perform some functions more efficiently than is possible in software
+ running on a general-purpose CPU. Examples of possible hardware accelerators
+ include: GPUs, FPGAs, and ASICs.
properties:
- name: Type
diff --git a/yaml/xyz/openbmc_project/Inventory/Item/Bmc.interface.yaml b/yaml/xyz/openbmc_project/Inventory/Item/Bmc.interface.yaml
index 0472bab..5ca97bf 100644
--- a/yaml/xyz/openbmc_project/Inventory/Item/Bmc.interface.yaml
+++ b/yaml/xyz/openbmc_project/Inventory/Item/Bmc.interface.yaml
@@ -1,15 +1,13 @@
description: >
- Implement to provide BMC attributes. Example attributes are
- the resource utilization of the BMC itself (BMC's CPU and memory,
- etc).
+ Implement to provide BMC attributes. Example attributes are the resource
+ utilization of the BMC itself (BMC's CPU and memory, etc).
associations:
- name: monitored_by
description: >
- Objects that implement Bmc can implement the
- 'monitored_by' association to link to utilization sensors
- for indicating the utilization sensors are for the BMC and
- not the host.
+ Objects that implement Bmc can implement the 'monitored_by'
+ association to link to utilization sensors for indicating the
+ utilization sensors are for the BMC and not the host.
reverse_names: monitoring
required_endpoint_interfaces:
- - xyz.openbmc_project.Sensor.Value
+ - xyz.openbmc_project.Sensor.Value
diff --git a/yaml/xyz/openbmc_project/Inventory/Item/Cable.interface.yaml b/yaml/xyz/openbmc_project/Inventory/Item/Cable.interface.yaml
index d2f32a2..74d7a56 100644
--- a/yaml/xyz/openbmc_project/Inventory/Item/Cable.interface.yaml
+++ b/yaml/xyz/openbmc_project/Inventory/Item/Cable.interface.yaml
@@ -12,8 +12,8 @@
type: string
default: ""
description: >
- A free form, implementation defined string used to provide the type
- of a cable, such as optical or copper. The cable type can be shown
- in user interfaces but this field should not be used for programmatic
+ A free form, implementation defined string used to provide the type of
+ a cable, such as optical or copper. The cable type can be shown in
+ user interfaces but this field should not be used for programmatic
interrogation of a cable beyond ignoring the default value of the
empty string.
diff --git a/yaml/xyz/openbmc_project/Inventory/Item/Chassis.interface.yaml b/yaml/xyz/openbmc_project/Inventory/Item/Chassis.interface.yaml
index 597ec4b..f82639c 100644
--- a/yaml/xyz/openbmc_project/Inventory/Item/Chassis.interface.yaml
+++ b/yaml/xyz/openbmc_project/Inventory/Item/Chassis.interface.yaml
@@ -41,5 +41,16 @@
An unknown chassis type.
- name: Zone
description: >
- A logical division or portion of a physical chassis that contains
- multiple devices or systems that cannot be physically separated.
+ A logical division or portion of a physical chassis that
+ contains multiple devices or systems that cannot be physically
+ separated.
+
+associations:
+ - name: powered_by
+ description: >
+ Objects that implement Chassis can optionally implement the
+ 'powered_by' association to provide a link to one or more power
+ supplies.
+ reverse_name: powering
+ required_endpoint_interfaces:
+ - xyz.openbmc_project.Inventory.Item.PowerSupply
diff --git a/yaml/xyz/openbmc_project/Inventory/Item/Connector.interface.yaml b/yaml/xyz/openbmc_project/Inventory/Item/Connector.interface.yaml
index f6aeed4..f95d850 100644
--- a/yaml/xyz/openbmc_project/Inventory/Item/Connector.interface.yaml
+++ b/yaml/xyz/openbmc_project/Inventory/Item/Connector.interface.yaml
@@ -1,4 +1,3 @@
description: >
- Implement to provide connector attributes. A connector is
- typically an external port or a slot into which cables are
- plugged.
+ Implement to provide connector attributes. A connector is typically an
+ external port or a slot into which cables are plugged.
diff --git a/yaml/xyz/openbmc_project/Inventory/Item/Cpu.interface.yaml b/yaml/xyz/openbmc_project/Inventory/Item/Cpu.interface.yaml
index 74f5671..7b81528 100644
--- a/yaml/xyz/openbmc_project/Inventory/Item/Cpu.interface.yaml
+++ b/yaml/xyz/openbmc_project/Inventory/Item/Cpu.interface.yaml
@@ -9,31 +9,29 @@
- name: Family
type: string
description: >
- A free form string indicates processor family type.
- For example, values can be "Intel Xeon
- processor", "AS400 Family", etc.
+ A free form string indicates processor family type. For example,
+ values can be "Intel Xeon processor", "AS400 Family", etc.
default: ""
- name: EffectiveFamily
type: uint16
description: >
- The effective Family information as provided by the
- manufacturer of this processor in unsigned integer.
- Default set to 0x02 which is defined as "Unknown" Processor
- Family in DSP0134 section 7.5.2.
+ The effective Family information as provided by the manufacturer of
+ this processor in unsigned integer. Default set to 0x02 which is
+ defined as "Unknown" Processor Family in DSP0134 section 7.5.2.
default: 0x02
- name: EffectiveModel
type: uint16
description: >
- The effective Model information as provided by the
- manufacturer of this processor in unsigned integer.
+ The effective Model information as provided by the manufacturer of
+ this processor in unsigned integer.
default: 0
- name: Id
type: uint64
description: >
- This Processor ID field contains processor-specific information
- that describes the processor's features. Details depend on
- processor architecture.
- For x86 and ARM processors, DMTF DSP0134 Section 7.5.3 is used.
+ This Processor ID field contains processor-specific information that
+ describes the processor's features. Details depend on processor
+ architecture. For x86 and ARM processors, DMTF DSP0134 Section 7.5.3
+ is used.
default: 0
- name: MaxSpeedInMhz
type: uint32
@@ -42,9 +40,9 @@
- name: Characteristics
type: array[enum[self.Capability]]
description: >
- The set of boolean flags for processor's capability, such as
- 64-bit Capable, Multi-Core, Hardware Thread, Execute Protection,
- Enhanced Virtualization, Power/Performance Control etc.
+ The set of boolean flags for processor's capability, such as 64-bit
+ Capable, Multi-Core, Hardware Thread, Execute Protection, Enhanced
+ Virtualization, Power/Performance Control etc.
- name: CoreCount
type: uint16
description: >
@@ -67,8 +65,8 @@
enumerations:
- name: Capability
description: >
- List of capabilities that a processor can support.
- Values are based off DMTF DSP0134 specification.
+ List of capabilities that a processor can support. Values are based
+ off DMTF DSP0134 specification.
values:
- name: Capable64bit
description: >
diff --git a/yaml/xyz/openbmc_project/Inventory/Item/Cpu/OperatingConfig.interface.yaml b/yaml/xyz/openbmc_project/Inventory/Item/Cpu/OperatingConfig.interface.yaml
index 2460505..cc30d90 100644
--- a/yaml/xyz/openbmc_project/Inventory/Item/Cpu/OperatingConfig.interface.yaml
+++ b/yaml/xyz/openbmc_project/Inventory/Item/Cpu/OperatingConfig.interface.yaml
@@ -24,7 +24,8 @@
- name: MaxSpeed
type: uint32
description: >
- The maximum clock speed to which the processor can be configured in MHz.
+ The maximum clock speed to which the processor can be configured in
+ MHz.
flags:
- readonly
- name: PowerLimit
@@ -43,7 +44,8 @@
type: array[struct[uint32, size]]
description: >
An array of objects that specify the turbo profile for a set of active
- cores. Each entry contains two members, first is the maximum turbo clock
- speed in MHz, and second is number of cores which can run at that speed.
+ cores. Each entry contains two members, first is the maximum turbo
+ clock speed in MHz, and second is number of cores which can run at
+ that speed.
flags:
- readonly
diff --git a/yaml/xyz/openbmc_project/Inventory/Item/Dimm.interface.yaml b/yaml/xyz/openbmc_project/Inventory/Item/Dimm.interface.yaml
index 0a18cfb..1c668b1 100644
--- a/yaml/xyz/openbmc_project/Inventory/Item/Dimm.interface.yaml
+++ b/yaml/xyz/openbmc_project/Inventory/Item/Dimm.interface.yaml
@@ -43,8 +43,8 @@
description: >
CAS Latency (CL) values are supported. The CAS latency is the delay
between the time at which the column address and the column address
- strobe signal are presented to the memory module and the time at
- which the corresponding data is made available by the memory module.
+ strobe signal are presented to the memory module and the time at which
+ the corresponding data is made available by the memory module.
- name: RevisionCode
type: uint16
description: >
@@ -111,7 +111,8 @@
and volatile memory.
- name: IntelOptane
description: >
- The memory module is an Intel Optane DC Persistent Memory Module.
+ The memory module is an Intel Optane DC Persistent Memory
+ Module.
- name: DeviceType
description: >
This property shall contain the Memory Device Type as defined by
diff --git a/yaml/xyz/openbmc_project/Inventory/Item/Dimm/MemoryLocation.interface.yaml b/yaml/xyz/openbmc_project/Inventory/Item/Dimm/MemoryLocation.interface.yaml
index 6e9e48d..8c742f6 100644
--- a/yaml/xyz/openbmc_project/Inventory/Item/Dimm/MemoryLocation.interface.yaml
+++ b/yaml/xyz/openbmc_project/Inventory/Item/Dimm/MemoryLocation.interface.yaml
@@ -1,6 +1,6 @@
description: >
- Implement to provide Memory connection information to sockets
- and memory controllers.
+ Implement to provide Memory connection information to sockets and memory
+ controllers.
properties:
- name: Socket
type: byte
diff --git a/yaml/xyz/openbmc_project/Inventory/Item/DiskBackplane.interface.yaml b/yaml/xyz/openbmc_project/Inventory/Item/DiskBackplane.interface.yaml
index db0c666..3a1b109 100644
--- a/yaml/xyz/openbmc_project/Inventory/Item/DiskBackplane.interface.yaml
+++ b/yaml/xyz/openbmc_project/Inventory/Item/DiskBackplane.interface.yaml
@@ -1,4 +1,3 @@
description: >
- Implement to provide disk backplane attributes. A disk
- backplane is a card that typically houses storage disks
- such as hard drives and SSDs.
+ Implement to provide disk backplane attributes. A disk backplane is a card
+ that typically houses storage disks such as hard drives and SSDs.
diff --git a/yaml/xyz/openbmc_project/Inventory/Item/Drive.interface.yaml b/yaml/xyz/openbmc_project/Inventory/Item/Drive.interface.yaml
index 12fa508..56dca8d 100644
--- a/yaml/xyz/openbmc_project/Inventory/Item/Drive.interface.yaml
+++ b/yaml/xyz/openbmc_project/Inventory/Item/Drive.interface.yaml
@@ -26,8 +26,8 @@
default: Unknown
type: enum[self.DriveLockState]
description: >
- Indicates if the data on the drive is accessible.
- This does not correspond to write locked
+ Indicates if the data on the drive is accessible. This does not
+ correspond to write locked
- name: PredictedMediaLifeLeftPercent
default: maxint
type: byte
diff --git a/yaml/xyz/openbmc_project/Inventory/Item/FabricAdapter.interface.yaml b/yaml/xyz/openbmc_project/Inventory/Item/FabricAdapter.interface.yaml
index b355c9c..315f6bb 100644
--- a/yaml/xyz/openbmc_project/Inventory/Item/FabricAdapter.interface.yaml
+++ b/yaml/xyz/openbmc_project/Inventory/Item/FabricAdapter.interface.yaml
@@ -1,6 +1,4 @@
description: >
- Implement to provide fabric adapter attributes.
- A physical fabric adapter capable of connecting
- to an interconnect fabric. Examples include but
- are not limited to Ethernet, NVMe over Fabrics,
- etc.
+ Implement to provide fabric adapter attributes. A physical fabric adapter
+ capable of connecting to an interconnect fabric. Examples include but are
+ not limited to Ethernet, NVMe over Fabrics, etc.
diff --git a/yaml/xyz/openbmc_project/Inventory/Item/Fan.interface.yaml b/yaml/xyz/openbmc_project/Inventory/Item/Fan.interface.yaml
index 2b6ba4b..bd5b6d7 100644
--- a/yaml/xyz/openbmc_project/Inventory/Item/Fan.interface.yaml
+++ b/yaml/xyz/openbmc_project/Inventory/Item/Fan.interface.yaml
@@ -4,8 +4,8 @@
associations:
- name: cooling
description: >
- Objects that implement Fan can optionally implement the
- 'cooling' association to provide a link back to a Item.
+ Objects that implement Fan can optionally implement the 'cooling'
+ association to provide a link back to a Item.
reverse_name: cooled_by
required_endpoint_interfaces:
- - xyz.openbmc_project.Inventory.Item
\ No newline at end of file
+ - xyz.openbmc_project.Inventory.Item
diff --git a/yaml/xyz/openbmc_project/Inventory/Item/PCIeDevice.interface.yaml b/yaml/xyz/openbmc_project/Inventory/Item/PCIeDevice.interface.yaml
index d0a2187..f2a7954 100644
--- a/yaml/xyz/openbmc_project/Inventory/Item/PCIeDevice.interface.yaml
+++ b/yaml/xyz/openbmc_project/Inventory/Item/PCIeDevice.interface.yaml
@@ -1,7 +1,7 @@
description: >
- This defines a PCIe device to be exposed for system management. It
- includes the device properties and function properties for all 8
- possible functions that are needed for the device identification.
+ This defines a PCIe device to be exposed for system management. It includes
+ the device properties and function properties for all 8 possible functions
+ that are needed for the device identification.
properties:
- name: DeviceType
diff --git a/yaml/xyz/openbmc_project/Inventory/Item/PCIeSlot.interface.yaml b/yaml/xyz/openbmc_project/Inventory/Item/PCIeSlot.interface.yaml
index 224b2d6..7c42a75 100644
--- a/yaml/xyz/openbmc_project/Inventory/Item/PCIeSlot.interface.yaml
+++ b/yaml/xyz/openbmc_project/Inventory/Item/PCIeSlot.interface.yaml
@@ -1,6 +1,6 @@
description: >
- This defines a PCIe slot to be exposed for system management.
- It includes the slot properties.
+ This defines a PCIe slot to be exposed for system management. It includes
+ the slot properties.
properties:
- name: Generation
diff --git a/yaml/xyz/openbmc_project/Inventory/Item/Panel.interface.yaml b/yaml/xyz/openbmc_project/Inventory/Item/Panel.interface.yaml
index a1c2d57..2f84646 100644
--- a/yaml/xyz/openbmc_project/Inventory/Item/Panel.interface.yaml
+++ b/yaml/xyz/openbmc_project/Inventory/Item/Panel.interface.yaml
@@ -1,5 +1,4 @@
description: >
- Implement to provide Panel FRU attributes. A panel
- is typically found on the chassis of a system and can
- be used to physically control the system and/or display
- system status.
+ Implement to provide Panel FRU attributes. A panel is typically found on the
+ chassis of a system and can be used to physically control the system and/or
+ display system status.
diff --git a/yaml/xyz/openbmc_project/Inventory/Item/PersistentMemory.interface.yaml b/yaml/xyz/openbmc_project/Inventory/Item/PersistentMemory.interface.yaml
index 16c9d08..5f31c48 100644
--- a/yaml/xyz/openbmc_project/Inventory/Item/PersistentMemory.interface.yaml
+++ b/yaml/xyz/openbmc_project/Inventory/Item/PersistentMemory.interface.yaml
@@ -13,8 +13,8 @@
- name: SubsystemVendorID
type: uint16
description: >
- The manufacturer ID of the memory subsystem controller of this
- memory module as defined by JEDEC in JEP-106.
+ The manufacturer ID of the memory subsystem controller of this memory
+ module as defined by JEDEC in JEP-106.
- name: SubsystemDeviceID
type: uint16
description: >
diff --git a/yaml/xyz/openbmc_project/Inventory/Item/PersistentMemory/PowerManagementPolicy.interface.yaml b/yaml/xyz/openbmc_project/Inventory/Item/PersistentMemory/PowerManagementPolicy.interface.yaml
index 5d067ec..9b30844 100644
--- a/yaml/xyz/openbmc_project/Inventory/Item/PersistentMemory/PowerManagementPolicy.interface.yaml
+++ b/yaml/xyz/openbmc_project/Inventory/Item/PersistentMemory/PowerManagementPolicy.interface.yaml
@@ -1,6 +1,5 @@
description: >
- Implement to provide the power management policy for the current
- resource.
+ Implement to provide the power management policy for the current resource.
properties:
- name: PolicyEnabled
type: boolean
diff --git a/yaml/xyz/openbmc_project/Inventory/Item/PersistentMemory/SecurityCapabilities.interface.yaml b/yaml/xyz/openbmc_project/Inventory/Item/PersistentMemory/SecurityCapabilities.interface.yaml
index 09a6856..727c5a0 100644
--- a/yaml/xyz/openbmc_project/Inventory/Item/PersistentMemory/SecurityCapabilities.interface.yaml
+++ b/yaml/xyz/openbmc_project/Inventory/Item/PersistentMemory/SecurityCapabilities.interface.yaml
@@ -20,5 +20,5 @@
- name: PassphraseLockLimit
type: uint32
description: >
- The maximum number of incorrect passphrase attempts
- allowed before memory is locked.
+ The maximum number of incorrect passphrase attempts allowed before
+ memory is locked.
diff --git a/yaml/xyz/openbmc_project/Inventory/Item/README.md b/yaml/xyz/openbmc_project/Inventory/Item/README.md
index b81d553..086e285 100644
--- a/yaml/xyz/openbmc_project/Inventory/Item/README.md
+++ b/yaml/xyz/openbmc_project/Inventory/Item/README.md
@@ -6,19 +6,21 @@
accessed, such as a board, a chassis and a drive. Some objects are embedded in
other objects, such as a BMC embedded in a board, or a core in a CPU. The DBus
interfaces in this directory describe the DBus representation of those physical
-objects. A graph consisting of Inventory objects as vertexes and Association
-as edges can be constructed that represents the relationship between different
+objects. A graph consisting of Inventory objects as vertexes and Association as
+edges can be constructed that represents the relationship between different
parts (such as chassis, drive, sensors, etc) of the system.
-# Inventory Association
+## Inventory Association
-DBus objects with xyz.opebmc_project.Inventory.Item.${ItemType} interface might
-be associated with other inventory objects. Such association can be translated
-to Redfish schemas and then indicate the system topology.
+DBus objects with `xyz.opebmc_project.Inventory.Item.${ItemType}` interface
+might be associated with other inventory objects. Such association can be
+translated to Redfish schemas and then indicate the system topology.
Document ObjectMapper association forward and reverse names as follows:
-* Item and Item: [containing, contained_by]
-* Sensor.Value and Bmc: [monitoring, monitored_by]
-* fan and item: [cooling, cooled_by]
-* led and item : [identifying, identified_by] [fault_identifying, fault_identified_by]
-* powerSupply and item : [powering, powered_by]
+
+- Item and Item: `{containing, contained_by}`
+- Sensor.Value and Bmc: `{monitoring, monitored_by}`
+- fan and item: `{cooling, cooled_by}`
+- led and item: `{identifying, identified_by}`
+ `{fault_identifying, fault_identified_by}`
+- powerSupply and item: `{powering, powered_by}`
diff --git a/yaml/xyz/openbmc_project/Inventory/Item/Rotor.interface.yaml b/yaml/xyz/openbmc_project/Inventory/Item/Rotor.interface.yaml
index c403032..d044832 100644
--- a/yaml/xyz/openbmc_project/Inventory/Item/Rotor.interface.yaml
+++ b/yaml/xyz/openbmc_project/Inventory/Item/Rotor.interface.yaml
@@ -1,7 +1,7 @@
description: >
- Implement to provide Rotor attributes.
- This interface should be at the same object path as a Fan for single-rotor
- fans or as a set of sub-path for multi-rotor fan design.
+ Implement to provide Rotor attributes. This interface should be at the same
+ object path as a Fan for single-rotor fans or as a set of sub-path for
+ multi-rotor fan design.
properties:
- name: NominalVoltage
diff --git a/yaml/xyz/openbmc_project/Inventory/Item/Vrm.interface.yaml b/yaml/xyz/openbmc_project/Inventory/Item/Vrm.interface.yaml
index 749563b..4e3fca1 100644
--- a/yaml/xyz/openbmc_project/Inventory/Item/Vrm.interface.yaml
+++ b/yaml/xyz/openbmc_project/Inventory/Item/Vrm.interface.yaml
@@ -1,3 +1,3 @@
description: >
- Implement to provide VRM FRU attributes. A VRM is
- a volatge regulator module.
+ Implement to provide VRM FRU attributes. A VRM is a volatge regulator
+ module.
diff --git a/yaml/xyz/openbmc_project/Inventory/Manager.interface.yaml b/yaml/xyz/openbmc_project/Inventory/Manager.interface.yaml
index 5045507..84edaba 100644
--- a/yaml/xyz/openbmc_project/Inventory/Manager.interface.yaml
+++ b/yaml/xyz/openbmc_project/Inventory/Manager.interface.yaml
@@ -1,10 +1,10 @@
description: >
Implement to provide inventory management features.
- An OpenBMC implementation providing inventory functions may provide zero
- or one implementation on the inventory namespace root. An implementing
- service should additionally implement org.freedesktop.DBus.ObjectManager
- on the inventory namespace root.
+ An OpenBMC implementation providing inventory functions may provide zero or
+ one implementation on the inventory namespace root. An implementing service
+ should additionally implement org.freedesktop.DBus.ObjectManager on the
+ inventory namespace root.
methods:
- name: Notify
description: >