prettier: re-format
Prettier is enabled in openbmc-build-scripts on Markdown, JSON, and YAML
files to have consistent formatting for these file types. Re-run the
formatter on the whole repository.
Change-Id: I559c9172dec2df448317fa6d7bd3d2660d4f62f3
Signed-off-by: Patrick Williams <patrick@stwcx.xyz>
diff --git a/README.md b/README.md
index 3754998..2b6a463 100644
--- a/README.md
+++ b/README.md
@@ -8,15 +8,15 @@
## key features
-- runtime re-configurable from d-bus (entity-manager or the like)
+- runtime re-configurable from d-bus (entity-manager or the like)
-- isolated: each sensor type is isolated into its own daemon, so a bug in one
- sensor is unlikely to affect another, and single sensor modifications are
- possible
+- isolated: each sensor type is isolated into its own daemon, so a bug in one
+ sensor is unlikely to affect another, and single sensor modifications are
+ possible
-- async single-threaded: uses sdbusplus/asio bindings
+- async single-threaded: uses sdbusplus/asio bindings
-- multiple data inputs: hwmon, d-bus, direct driver access
+- multiple data inputs: hwmon, d-bus, direct driver access
## dbus interfaces
@@ -33,26 +33,38 @@
xyz.openbmc_project.Association.Definitions
```
-Sensor interfaces collection are described [here](https://github.com/openbmc/phosphor-dbus-interfaces/tree/master/yaml/xyz/openbmc_project/Sensor).
-Consumer examples of these interfaces are [Redfish](https://github.com/openbmc/bmcweb/blob/master/redfish-core/lib/sensors.hpp), [Phosphor-Pid-Control](https://github.com/openbmc/phosphor-pid-control), [IPMI SDR](https://github.com/openbmc/phosphor-host-ipmid/blob/master/dbus-sdr/sensorcommands.cpp).
+Sensor interfaces collection are described
+[here](https://github.com/openbmc/phosphor-dbus-interfaces/tree/master/yaml/xyz/openbmc_project/Sensor).
+
+Consumer examples of these interfaces are
+[Redfish](https://github.com/openbmc/bmcweb/blob/master/redfish-core/lib/sensors.hpp),
+[Phosphor-Pid-Control](https://github.com/openbmc/phosphor-pid-control),
+[IPMI SDR](https://github.com/openbmc/phosphor-host-ipmid/blob/master/dbus-sdr/sensorcommands.cpp).
+
## Reactor
+
dbus-sensor daemons are [reactors](https://github.com/openbmc/entity-manager)
-that dynamically create and update sensors configuration when
-system configuration gets updated.
+that dynamically create and update sensors configuration when system
+configuration gets updated.
-Using asio timers and async calls, dbus-sensor daemons read sensor values and check thresholds periodically.
-PropertiesChanged signals will be broadcasted for other services to consume when
-value or threshold status change.
-OperationStatus is set to false if the sensor is determined to be faulty.
+Using asio timers and async calls, dbus-sensor daemons read sensor values and
+check thresholds periodically. PropertiesChanged signals will be broadcasted for
+other services to consume when value or threshold status change. OperationStatus
+is set to false if the sensor is determined to be faulty.
-A simple sensor example can be found [here](https://github.com/openbmc/entity-manager/blob/master/docs/my_first_sensors.md).
+A simple sensor example can be found
+[here](https://github.com/openbmc/entity-manager/blob/master/docs/my_first_sensors.md).
## configuration
-Sensor devices are described using Exposes records in configuration file.
-Name and Type fields are required. Different sensor types have different fields.
-Refer to entity manager [schema](https://github.com/openbmc/entity-manager/blob/master/schemas/legacy.json) for complete list.
+
+Sensor devices are described using Exposes records in configuration file. Name
+and Type fields are required. Different sensor types have different fields.
+Refer to entity manager
+[schema](https://github.com/openbmc/entity-manager/blob/master/schemas/legacy.json)
+for complete list.
+
## sensor documentation
-- [ExternalSensor](https://github.com/openbmc/docs/blob/master/designs/external-sensor.md)
- virtual sensor
+- [ExternalSensor](https://github.com/openbmc/docs/blob/master/designs/external-sensor.md)
+ virtual sensor
