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/Sensor/Accuracy.interface.yaml b/yaml/xyz/openbmc_project/Sensor/Accuracy.interface.yaml
index 7d5fa54..cd454b1 100644
--- a/yaml/xyz/openbmc_project/Sensor/Accuracy.interface.yaml
+++ b/yaml/xyz/openbmc_project/Sensor/Accuracy.interface.yaml
@@ -7,10 +7,9 @@
default: NaN
description: >
The accuracy range (+/-) of the sensor Value as a percentage, with a
- value between 0 and 100.
- This is NOT a percentage of the sensor value ranges.
- A value of 0.25 would be 0.25%, a value of 2 would represent 2%.
- A value of 2 for 2% would mean that a reading of 10 would have an
+ value between 0 and 100. This is NOT a percentage of the sensor value
+ ranges. A value of 0.25 would be 0.25%, a value of 2 would represent
+ 2%. A value of 2 for 2% would mean that a reading of 10 would have an
actual value of 9.8 to 10.2.
flags:
- readonly
diff --git a/yaml/xyz/openbmc_project/Sensor/Threshold/Critical.interface.yaml b/yaml/xyz/openbmc_project/Sensor/Threshold/Critical.interface.yaml
index dfd65b7..c2d548e 100644
--- a/yaml/xyz/openbmc_project/Sensor/Threshold/Critical.interface.yaml
+++ b/yaml/xyz/openbmc_project/Sensor/Threshold/Critical.interface.yaml
@@ -1,7 +1,8 @@
description: >
Implement to provide critical class sensor thresholds. Objects implementing
- Sensor.Threshold.Critical must be instantiated in the correct hierarchy within
- the sensors namespace. The following sensor hierarchies are recognized:
+ Sensor.Threshold.Critical must be instantiated in the correct hierarchy
+ within the sensors namespace. The following sensor hierarchies are
+ recognized:
airflow
altitude
current
@@ -33,19 +34,19 @@
- name: CriticalAlarmHigh
type: boolean
description: >
- True if the sensor value has exceeded the defined bound.
- False if the sensor value has not exceeded the defined bound.
+ True if the sensor value has exceeded the defined bound. False if the
+ sensor value has not exceeded the defined bound.
- CriticalAlarmHigh may be set to False to clear an alarm condition.
- The behavior of setting CriticalAlarmHigh to True is undefined.
+ CriticalAlarmHigh may be set to False to clear an alarm condition. The
+ behavior of setting CriticalAlarmHigh to True is undefined.
- name: CriticalAlarmLow
type: boolean
description: >
- True if the sensor value has exceeded the defined bound.
- False if the sensor value has not exceeded the defined bound.
+ True if the sensor value has exceeded the defined bound. False if the
+ sensor value has not exceeded the defined bound.
- CriticalAlarmLow may be set to False to clear an alarm condition.
- The behavior of setting CriticalAlarmLow to True is undefined.
+ CriticalAlarmLow may be set to False to clear an alarm condition. The
+ behavior of setting CriticalAlarmLow to True is undefined.
signals:
- name: CriticalHighAlarmAsserted
description: >
diff --git a/yaml/xyz/openbmc_project/Sensor/Threshold/HardShutdown.interface.yaml b/yaml/xyz/openbmc_project/Sensor/Threshold/HardShutdown.interface.yaml
index dc8d855..0329c33 100644
--- a/yaml/xyz/openbmc_project/Sensor/Threshold/HardShutdown.interface.yaml
+++ b/yaml/xyz/openbmc_project/Sensor/Threshold/HardShutdown.interface.yaml
@@ -35,16 +35,16 @@
- name: HardShutdownAlarmHigh
type: boolean
description: >
- True if the sensor value has exceeded the defined bound.
- False if the sensor value has not exceeded the defined bound.
+ True if the sensor value has exceeded the defined bound. False if the
+ sensor value has not exceeded the defined bound.
HardShutdownAlarmHigh may be set to False to clear an alarm condition.
The behavior of setting HardShutdownAlarmHigh to True is undefined.
- name: HardShutdownAlarmLow
type: boolean
description: >
- True if the sensor value has exceeded the defined bound.
- False if the sensor value has not exceeded the defined bound.
+ True if the sensor value has exceeded the defined bound. False if the
+ sensor value has not exceeded the defined bound.
HardShutdownAlarmLow may be set to False to clear an alarm condition.
The behavior of setting HardShutdownAlarmLow to True is undefined.
diff --git a/yaml/xyz/openbmc_project/Sensor/Threshold/PerformanceLoss.interface.yaml b/yaml/xyz/openbmc_project/Sensor/Threshold/PerformanceLoss.interface.yaml
index 8303572..8ce09c1 100644
--- a/yaml/xyz/openbmc_project/Sensor/Threshold/PerformanceLoss.interface.yaml
+++ b/yaml/xyz/openbmc_project/Sensor/Threshold/PerformanceLoss.interface.yaml
@@ -23,28 +23,28 @@
type: double
default: NaN
description: >
- The upper bound of the warning threshold. A value of 'NaN' is used
- to indicate there is no threshold of this type.
+ The upper bound of the warning threshold. A value of 'NaN' is used to
+ indicate there is no threshold of this type.
- name: PerformanceLossLow
type: double
default: NaN
description: >
- The lower bound of the warning threshold. A value of 'NaN' is used
- to indicate there is no threshold of this type.
+ The lower bound of the warning threshold. A value of 'NaN' is used to
+ indicate there is no threshold of this type.
- name: PerformanceLossAlarmHigh
type: boolean
description: >
- True if the sensor value has exceeded the defined bound.
- False if the sensor value has not exceeded the defined bound.
+ True if the sensor value has exceeded the defined bound. False if the
+ sensor value has not exceeded the defined bound.
PerformanceLossAlarmHigh may be set to False to clear an alarm
- condition. The behavior of setting PerformanceLossAlarmHigh to True
- is undefined.
+ condition. The behavior of setting PerformanceLossAlarmHigh to True is
+ undefined.
- name: PerformanceLossAlarmLow
type: boolean
description: >
- True if the sensor value has exceeded the defined bound.
- False if the sensor value has not exceeded the defined bound.
+ True if the sensor value has exceeded the defined bound. False if the
+ sensor value has not exceeded the defined bound.
PerformanceLossAlarmLow may be set to False to clear an alarm
condition. The behavior of setting PerformanceLossAlarmLow to True is
diff --git a/yaml/xyz/openbmc_project/Sensor/Threshold/SoftShutdown.interface.yaml b/yaml/xyz/openbmc_project/Sensor/Threshold/SoftShutdown.interface.yaml
index ba175f6..6d7184b 100644
--- a/yaml/xyz/openbmc_project/Sensor/Threshold/SoftShutdown.interface.yaml
+++ b/yaml/xyz/openbmc_project/Sensor/Threshold/SoftShutdown.interface.yaml
@@ -34,16 +34,16 @@
- name: SoftShutdownAlarmHigh
type: boolean
description: >
- True if the sensor value has exceeded the defined bound.
- False if the sensor value has not exceeded the defined bound.
+ True if the sensor value has exceeded the defined bound. False if the
+ sensor value has not exceeded the defined bound.
SoftShutdownAlarmHigh may be set to False to clear an alarm condition.
The behavior of setting SoftShutdownAlarmHigh to True is undefined.
- name: SoftShutdownAlarmLow
type: boolean
description: >
- True if the sensor value has exceeded the defined bound.
- False if the sensor value has not exceeded the defined bound.
+ True if the sensor value has exceeded the defined bound. False if the
+ sensor value has not exceeded the defined bound.
SoftShutdownAlarmLow may be set to False to clear an alarm condition.
The behavior of setting SoftShutdownAlarmLow to True is undefined.
diff --git a/yaml/xyz/openbmc_project/Sensor/Threshold/Warning.interface.yaml b/yaml/xyz/openbmc_project/Sensor/Threshold/Warning.interface.yaml
index a141da5..de128f0 100644
--- a/yaml/xyz/openbmc_project/Sensor/Threshold/Warning.interface.yaml
+++ b/yaml/xyz/openbmc_project/Sensor/Threshold/Warning.interface.yaml
@@ -1,7 +1,8 @@
description: >
Implement to provide warning class sensor thresholds. Objects implementing
- Sensor.Threshold.Warning must be instantiated in the correct hierarchy within
- the sensors namespace. The following sensor hierarchies are recognized:
+ Sensor.Threshold.Warning must be instantiated in the correct hierarchy
+ within the sensors namespace. The following sensor hierarchies are
+ recognized:
airflow
altitude
current
@@ -22,30 +23,30 @@
type: double
default: NaN
description: >
- The upper bound of the warning threshold. A value of 'NaN' is used
- to indicate there is no threshold of this type.
+ The upper bound of the warning threshold. A value of 'NaN' is used to
+ indicate there is no threshold of this type.
- name: WarningLow
type: double
default: NaN
description: >
- The lower bound of the warning threshold. A value of 'NaN' is used
- to indicate there is no threshold of this type.
+ The lower bound of the warning threshold. A value of 'NaN' is used to
+ indicate there is no threshold of this type.
- name: WarningAlarmHigh
type: boolean
description: >
- True if the sensor value has exceeded the defined bound.
- False if the sensor value has not exceeded the defined bound.
+ True if the sensor value has exceeded the defined bound. False if the
+ sensor value has not exceeded the defined bound.
- WarningAlarmHigh may be set to False to clear an alarm condition.
- The behavior of setting WarningAlarmHigh to True is undefined.
+ WarningAlarmHigh may be set to False to clear an alarm condition. The
+ behavior of setting WarningAlarmHigh to True is undefined.
- name: WarningAlarmLow
type: boolean
description: >
- True if the sensor value has exceeded the defined bound.
- False if the sensor value has not exceeded the defined bound.
+ True if the sensor value has exceeded the defined bound. False if the
+ sensor value has not exceeded the defined bound.
- WarningAlarmLow may be set to False to clear an alarm condition.
- The behavior of setting WarningAlarmLow to True is undefined.
+ WarningAlarmLow may be set to False to clear an alarm condition. The
+ behavior of setting WarningAlarmLow to True is undefined.
signals:
- name: WarningHighAlarmAsserted
description: >
diff --git a/yaml/xyz/openbmc_project/Sensor/Value.interface.yaml b/yaml/xyz/openbmc_project/Sensor/Value.interface.yaml
index dd80468..f2139a7 100644
--- a/yaml/xyz/openbmc_project/Sensor/Value.interface.yaml
+++ b/yaml/xyz/openbmc_project/Sensor/Value.interface.yaml
@@ -1,8 +1,7 @@
description: >
- Implement to provide sensor readings. Objects implementing
- Sensor.Value must be instantiated in the correct
- hierarchy within the sensors namespace. The following sensor
- hierarchies are recognized:
+ Implement to provide sensor readings. Objects implementing Sensor.Value
+ must be instantiated in the correct hierarchy within the sensors
+ namespace. The following sensor hierarchies are recognized:
airflow
altitude
current
@@ -15,9 +14,8 @@
utilization
voltage
- Any service implementing Sensor.Value on one or more objects must
- implement org.freedesktop.DBus.ObjectManager on
- /xyz/openbmc_project/sensors.
+ Any service implementing Sensor.Value on one or more objects must implement
+ org.freedesktop.DBus.ObjectManager on /xyz/openbmc_project/sensors.
All Sensor.Value properties are read-only.
@@ -39,18 +37,17 @@
- name: Unit
type: enum[self.Unit]
description: >
- The unit of the reading. Immutable once set for a sensor.
- For objects in the airflow namespace, Unit must be "CFM"
- For objects in the altitude namespace, Unit must be "Meters".
- For objects in the current namespace, Unit must be "Amperes".
- For objects in the energy namespace, Unit must be "Joules".
- For objects in the fan_tach namespace, Unit must be "RPMS".
- For objects in the humidity namespace, Unit must be "PercentRH"
- For objects in the power namespace, Unit must be "Watts".
- For objects in the pressure namespace, Unit must be "Pascals"
- For objects in the temperature namespace, Unit must be "DegreesC".
- For objects in the utilization namespace, Unit must be "Percent"
- For objects in the voltage namespace, Unit must be "Volts".
+ The unit of the reading. Immutable once set for a sensor. For objects
+ in the airflow namespace, Unit must be "CFM" For objects in the
+ altitude namespace, Unit must be "Meters". For objects in the current
+ namespace, Unit must be "Amperes". For objects in the energy
+ namespace, Unit must be "Joules". For objects in the fan_tach
+ namespace, Unit must be "RPMS". For objects in the humidity namespace,
+ Unit must be "PercentRH" For objects in the power namespace, Unit must
+ be "Watts". For objects in the pressure namespace, Unit must be
+ "Pascals" For objects in the temperature namespace, Unit must be
+ "DegreesC". For objects in the utilization namespace, Unit must be
+ "Percent" For objects in the voltage namespace, Unit must be "Volts".
enumerations:
- name: Unit
@@ -94,16 +91,16 @@
associations:
- name: inventory
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:
- sensors
required_endpoint_interfaces:
- xyz.openbmc_project.Inventory.Item
- name: monitoring
description: >
- Sensors may monitor the BMC's resource utilization and implement
- an associatoin to the Bmc item.
+ Sensors may monitor the BMC's resource utilization and implement an
+ associatoin to the Bmc item.
reverse_names:
- monitored_by
required_endpoint_interfaces:
diff --git a/yaml/xyz/openbmc_project/Sensor/ValueMutability.interface.yaml b/yaml/xyz/openbmc_project/Sensor/ValueMutability.interface.yaml
index 0ed8fe0..0428740 100644
--- a/yaml/xyz/openbmc_project/Sensor/ValueMutability.interface.yaml
+++ b/yaml/xyz/openbmc_project/Sensor/ValueMutability.interface.yaml
@@ -5,10 +5,8 @@
type: boolean
default: false
description: >
- A hint to a server that provides sensor access
- to external users, such as an IPMI server,
- as to whether or not to allow external users
- to modify the value, via "set sensor value"
- commands or similar. True to allow
- modification (read-write). False to disallow
- modification (read-only).
+ A hint to a server that provides sensor access to external users, such
+ as an IPMI server, as to whether or not to allow external users to
+ modify the value, via "set sensor value" commands or similar. True to
+ allow modification (read-write). False to disallow modification
+ (read-only).