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/Control/Service/README.md b/yaml/xyz/openbmc_project/Control/Service/README.md
index f0ae013..38a016e 100644
--- a/yaml/xyz/openbmc_project/Control/Service/README.md
+++ b/yaml/xyz/openbmc_project/Control/Service/README.md
@@ -4,9 +4,9 @@
Applications must use service manager daemon to configure services like
phosphor-ipmi-net, bmcweb, obmc-console etc in the system, instead of directly
-controlling the same using 'systemd' or 'iptables'. This way client
-applications doesn't need to change to configure services, when the
-implementations differ. The list of services supported are:
+controlling the same using 'systemd' or 'iptables'. This way client applications
+doesn't need to change to configure services, when the implementations differ.
+The list of services supported are:
- "bmcweb"
- "obmc-console"`
@@ -16,16 +16,15 @@
## Implementation Details
-Service manager daemon will create D-Bus objects for configurable services
-in the system under the object path `/xyz/openbmc_project/control/service`. For
+Service manager daemon will create D-Bus objects for configurable services in
+the system under the object path `/xyz/openbmc_project/control/service`. For
each instance of the service there will be a D-Bus object
-`/xyz/openbmc_project/control/service/<service-name>`.
-For example, if there are two instances of `phosphor-ipmi-net` then there
-will be two D-Bus objects
-`/xyz/openbmc_project/control/service/phosphor_2dipmi_2dnet_40eth0`
-and `/xyz/openbmc_project/control/service/phosphor_2dipmi_2dnet_40eth1`.
-The D-Bus object manages both the associated service and socket unit files.
-The D-Bus object implements the interface
+`/xyz/openbmc_project/control/service/<service-name>`. For example, if there are
+two instances of `phosphor-ipmi-net` then there will be two D-Bus objects
+`/xyz/openbmc_project/control/service/phosphor_2dipmi_2dnet_40eth0` and
+`/xyz/openbmc_project/control/service/phosphor_2dipmi_2dnet_40eth1`. The D-Bus
+object manages both the associated service and socket unit files. The D-Bus
+object implements the interface
`xyz.openbmc_project.Control.Service.Attributes`. Network services like bmcweb,
phosphor-ipmi-net also implements the
`xyz.openbmc_project.Control.Service.SocketAttributes` interface.
@@ -47,25 +46,24 @@
other service dependencies to satisfy. The service cannot be enabled if the
service is masked.
-- Masked - indicates whether the service is masked, `true` indicates the
- service is permanently disabled and `false` indicates the service
- is enabled. If the property is set to `true`, then the service is
- permanently disabled and the service is stopped. If the property
- is set to `false` then the service is enabled and starts running.
+- Masked - indicates whether the service is masked, `true` indicates the service
+ is permanently disabled and `false` indicates the service is enabled. If the
+ property is set to `true`, then the service is permanently disabled and the
+ service is stopped. If the property is set to `false` then the service is
+ enabled and starts running.
-- Running - indicates the current state of the service, `true` if the service
- is running and `false` if the service is not running. This property
- can be used to change the running state of the service, to start the
- service set to `true` and to stop the service set to `false`. The
- service cannot be started if the service is Masked.
+- Running - indicates the current state of the service, `true` if the service is
+ running and `false` if the service is not running. This property can be used
+ to change the running state of the service, to start the service set to `true`
+ and to stop the service set to `false`. The service cannot be started if the
+ service is Masked.
### xyz.openbmc_project.Control.Service.SocketAttributes interface
#### properties
-- Port - Port number to which the service is configured to listen, if
- applicable for service. Services like obmc-console will not
- implement this interface.
+- Port - Port number to which the service is configured to listen, if applicable
+ for service. Services like obmc-console will not implement this interface.
## Usage
diff --git a/yaml/xyz/openbmc_project/Control/Service/SocketAttributes.interface.yaml b/yaml/xyz/openbmc_project/Control/Service/SocketAttributes.interface.yaml
index 67a73a7..0c8ba2a 100644
--- a/yaml/xyz/openbmc_project/Control/Service/SocketAttributes.interface.yaml
+++ b/yaml/xyz/openbmc_project/Control/Service/SocketAttributes.interface.yaml
@@ -3,7 +3,8 @@
activation. Applications can expose the port number of a network service by
implementing this interface. For example, application like
service-config-manager will implement this interface for network services
- like bmcweb and phosphor-ipmi-net and allow the port number to be configured.
+ like bmcweb and phosphor-ipmi-net and allow the port number to be
+ configured.
properties:
- name: Port