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/Logging/Create.interface.yaml b/yaml/xyz/openbmc_project/Logging/Create.interface.yaml
index 9798b76..0da55b5 100644
--- a/yaml/xyz/openbmc_project/Logging/Create.interface.yaml
+++ b/yaml/xyz/openbmc_project/Logging/Create.interface.yaml
@@ -1,8 +1,7 @@
description: >
- This interface contains a Create method, which can be implemented
- to allow creation of xyz.openbmc_project.Logging.Entry objects
- directly over D-Bus, without needing the errors defined in
- the *.Error/metadata.yaml files.
+ This interface contains a Create method, which can be implemented to allow
+ creation of xyz.openbmc_project.Logging.Entry objects directly over D-Bus,
+ without needing the errors defined in the *.Error/metadata.yaml files.
methods:
- name: Create
@@ -20,8 +19,7 @@
- name: AdditionalData
type: dict[string, string]
description: >
- The AdditionalData property of the event entry.
- e.g.:
+ The AdditionalData property of the event entry. e.g.:
{
"key1": "value1",
"key2": "value2"
@@ -34,9 +32,9 @@
Create an xyz.openbmc_project.Logging.Entry object and pass in an
array of file descriptors for files that contain FFDC (first failure
data capture) data which may be used by event log extensions that
- support storing it with their event logs. The other arguments are
- the same as with Create(). The FFDC argument is ignored by the
- base phosphor-logging event logs.
+ support storing it with their event logs. The other arguments are the
+ same as with Create(). The FFDC argument is ignored by the base
+ phosphor-logging event logs.
When the method call is complete the descriptors must be closed and
the files can be deleted if desired.
@@ -52,8 +50,7 @@
- name: AdditionalData
type: dict[string, string]
description: >
- The AdditionalData property of the event entry.
- e.g.:
+ The AdditionalData property of the event entry. e.g.:
{
"key1": "value1",
"key2": "value2"
@@ -63,20 +60,21 @@
- name: FFDC
type: array[struct[enum[self.FFDCFormat], byte, byte, unixfd]]
description: >
- File descriptors for any files containing FFDC, along with metadata
- about the contents:
+ File descriptors for any files containing FFDC, along with
+ metadata about the contents:
FFDCFormat- The format type of the contained data.
subType - The format subtype, used for the 'Custom' type.
- version - The version of the data format, used for the 'Custom'
+ version - The version of the data format, used for the
+ 'Custom'
type.
unixfd - The file descriptor to the data file.
- e.g.:
- [
- {"xyz.openbmc_project.Logging.Create.FFDCFormat.JSON", 0, 0, 5},
- {"xyz.openbmc_project.Logging.Create.FFDCFormat.Custom", 1, 2, 6}
- ]
+ e.g.: [
+ {"xyz.openbmc_project.Logging.Create.FFDCFormat.JSON", 0, 0,
+ 5},
+ {"xyz.openbmc_project.Logging.Create.FFDCFormat.Custom", 1, 2,
+ 6} ]
enumerations:
- name: FFDCFormat
diff --git a/yaml/xyz/openbmc_project/Logging/Entry.interface.yaml b/yaml/xyz/openbmc_project/Logging/Entry.interface.yaml
index 8ba6617..739b6e6 100644
--- a/yaml/xyz/openbmc_project/Logging/Entry.interface.yaml
+++ b/yaml/xyz/openbmc_project/Logging/Entry.interface.yaml
@@ -1,8 +1,8 @@
description: >
- Implement to provide event/error entry attributes.
- This interface should be instantiated for the phosphor::logging namespace.
- This interface is a collection of objects, therefore it is required to
- implement org.freedesktop.DBus.ObjectManager on the logging namespace root.
+ Implement to provide event/error entry attributes. This interface should be
+ instantiated for the phosphor::logging namespace. This interface is a
+ collection of objects, therefore it is required to implement
+ org.freedesktop.DBus.ObjectManager on the logging namespace root.
Optionally, implement org.openbmc.Object.Delete to allow the deletion of
individual entries.
properties:
@@ -58,10 +58,10 @@
type: uint64
description: >
The timestamp when any property was last modified, in milliseconds
- since the epoch (1 Jan 1970 00:00:00 UTC). As only the
- Resolved property has a reason to change, a value that doesn't
- match the Timestamp property's value (which indicates when the
- log was created) would indicate that Resolved was changed.
+ since the epoch (1 Jan 1970 00:00:00 UTC). As only the Resolved
+ property has a reason to change, a value that doesn't match the
+ Timestamp property's value (which indicates when the log was created)
+ would indicate that Resolved was changed.
enumerations:
- name: Level
@@ -110,8 +110,8 @@
methods:
- name: GetEntry
description: >
- Returns the file descriptor to the raw Entry file, which is a binary blob.
- The mode of the file descriptor is to be reaad-only.
+ Returns the file descriptor to the raw Entry file, which is a binary
+ blob. The mode of the file descriptor is to be reaad-only.
returns:
- name: fd
type: unixfd
diff --git a/yaml/xyz/openbmc_project/Logging/ErrorBlocksTransition.interface.yaml b/yaml/xyz/openbmc_project/Logging/ErrorBlocksTransition.interface.yaml
index 656c75a..fdac519 100644
--- a/yaml/xyz/openbmc_project/Logging/ErrorBlocksTransition.interface.yaml
+++ b/yaml/xyz/openbmc_project/Logging/ErrorBlocksTransition.interface.yaml
@@ -4,10 +4,9 @@
`Logging.Entry` is not `Resolved` or been deleted.
The specific state transition(s) to prevent are left to the implementation.
- A typical use of this would be to prevent the power-on of a
- managed host while a critical error is open. The managed host, via
- systemd transitions, might start the power-on sequence and then wait for
- any object with this `ErrorBlocksTransition` interface to no longer be
- instantiated. Causal ordering of D-Bus operations can prove that
- no critical error needs servicing and the power-on sequence may safely
- continue.
+ A typical use of this would be to prevent the power-on of a managed host
+ while a critical error is open. The managed host, via systemd transitions,
+ might start the power-on sequence and then wait for any object with this
+ `ErrorBlocksTransition` interface to no longer be instantiated. Causal
+ ordering of D-Bus operations can prove that no critical error needs
+ servicing and the power-on sequence may safely continue.
diff --git a/yaml/xyz/openbmc_project/Logging/Event.interface.yaml b/yaml/xyz/openbmc_project/Logging/Event.interface.yaml
index c083fc9..0c79c36 100755
--- a/yaml/xyz/openbmc_project/Logging/Event.interface.yaml
+++ b/yaml/xyz/openbmc_project/Logging/Event.interface.yaml
@@ -4,17 +4,15 @@
# for logging should go in (Logging/Entry).
# https://github.com/openbmc/openbmc/issues/2923
description: >
- Implement to provide event entry attributes.
- This interface should be instantiated for the phosphor::events namespace.
- This interface is a collection of objects, therefore it is required to
- implement org.freedesktop.DBus.ObjectManager on the events namespace root.
- Optionally, implement xyz.openbmc_project.Delete to allow the deletion of
- individual entries.
- The event D-Bus object path would look like
- <PhosphorDbusRoot>/events/<type>/<id>
- Here "type" is the type of event, Could be network/system state event etc.
- Type would be given by the application configuration file which would
- be implementing this interface.
+ Implement to provide event entry attributes. This interface should be
+ instantiated for the phosphor::events namespace. This interface is a
+ collection of objects, therefore it is required to implement
+ org.freedesktop.DBus.ObjectManager on the events namespace root. Optionally,
+ implement xyz.openbmc_project.Delete to allow the deletion of individual
+ entries. The event D-Bus object path would look like
+ <PhosphorDbusRoot>/events/<type>/<id> Here "type" is the type of event,
+ Could be network/system state event etc. Type would be given by the
+ application configuration file which would be implementing this interface.
Here "id" is positive integer starts from 1 and it gets incremented by 1
with any newly created object.
properties:
diff --git a/yaml/xyz/openbmc_project/Logging/IPMI.interface.yaml b/yaml/xyz/openbmc_project/Logging/IPMI.interface.yaml
index e7c4a08..911555c 100644
--- a/yaml/xyz/openbmc_project/Logging/IPMI.interface.yaml
+++ b/yaml/xyz/openbmc_project/Logging/IPMI.interface.yaml
@@ -1,18 +1,17 @@
description: >
- Implement to provide an IPMI System Event Log (SEL) logging interface
- under the path /xyz/openbmc_project/Logging/IPMI.
+ Implement to provide an IPMI System Event Log (SEL) logging interface under
+ the path /xyz/openbmc_project/Logging/IPMI.
- SEL records store system event information and will contain a record ID
- and type followed by type-specific information. The type-specific
- information includes a timestamp, generator ID (used to identify the
- component that is adding the SEL record), sensor number, event
- direction and event-specific data for system type events; or timestamp
- and OEM data for OEM type events.
+ SEL records store system event information and will contain a record ID and
+ type followed by type-specific information. The type-specific information
+ includes a timestamp, generator ID (used to identify the component that is
+ adding the SEL record), sensor number, event direction and event-specific
+ data for system type events; or timestamp and OEM data for OEM type events.
The interface allows adding system or OEM type events. For system type
- events it requires a generator ID (0x20 for BMC), sensor D-Bus path,
- event direction (assertion or de-assertion), and event specific data.
- For OEM type events, it requires the record type and OEM data.
+ events it requires a generator ID (0x20 for BMC), sensor D-Bus path, event
+ direction (assertion or de-assertion), and event specific data. For OEM type
+ events, it requires the record type and OEM data.
It will assign a record ID and timestamp automatically and return the
assigned record ID.
diff --git a/yaml/xyz/openbmc_project/Logging/README.md b/yaml/xyz/openbmc_project/Logging/README.md
index ecee30b..9f9c07f 100644
--- a/yaml/xyz/openbmc_project/Logging/README.md
+++ b/yaml/xyz/openbmc_project/Logging/README.md
@@ -21,41 +21,46 @@
application. Such errors are defined in the application that uses the error.
- Refer to [openpower-debug-collector][openpower-debug-collector].
-[openpower-debug-collector]: https://github.com/openbmc/openpower-debug-collector
+[openpower-debug-collector]:
+ https://github.com/openbmc/openpower-debug-collector
### Error YAML files
- Every error defined will have an error YAML file and a corresponding error
metadata YAML file.
- The error YAML file contains the error name and a one-line description of the
- error.
- An example of an error YAML file can be found [here][error-example].
-- The error metadata YAML file captures required data. The format of the data
- is defined in the error metadata file. An example of an error metadata YAML
- file can be found [here][metadata-example].
+ error. An example of an error YAML file can be found [here][error-example].
+- The error metadata YAML file captures required data. The format of the data is
+ defined in the error metadata file. An example of an error metadata YAML file
+ can be found [here][metadata-example].
-[error-example]: https://github.com/openbmc/phosphor-dbus-interfaces/blob/master/yaml/xyz/openbmc_project/Common/File.errors.yaml
-[metadata-example]: https://github.com/openbmc/phosphor-dbus-interfaces/blob/master/yaml/xyz/openbmc_project/Common/File.metadata.yaml
+[error-example]:
+ https://github.com/openbmc/phosphor-dbus-interfaces/blob/master/yaml/xyz/openbmc_project/Common/File.errors.yaml
+[metadata-example]:
+ https://github.com/openbmc/phosphor-dbus-interfaces/blob/master/yaml/xyz/openbmc_project/Common/File.metadata.yaml
## Logging to journal
-- Applications can log debug/error information to the journal using
- the **log** API
+- Applications can log debug/error information to the journal using the **log**
+ API
- Refer to [log.hpp][log-header].
- Applications can commit errors to the journal using the **report** or
**commit** API
- Refer to [elog.hpp][elog-header].
- Logging entry D-Bus objects are created for the committed errors.
-[log-header]: https://github.com/openbmc/phosphor-logging/blob/master/lib/include/phosphor-logging/log.hpp
-[elog-header]: https://github.com/openbmc/phosphor-logging/blob/master/lib/include/phosphor-logging/elog.hpp
+[log-header]:
+ https://github.com/openbmc/phosphor-logging/blob/master/lib/include/phosphor-logging/log.hpp
+[elog-header]:
+ https://github.com/openbmc/phosphor-logging/blob/master/lib/include/phosphor-logging/elog.hpp
## Delete All interface
- Use the [DeleteAll.interface.yaml][deleteall] for deleting all the logging
entries.
-[deleteall]: https://github.com/openbmc/phosphor-dbus-interfaces/blob/master/yaml/xyz/openbmc_project/Collection/DeleteAll.interface.yaml
+[deleteall]:
+ https://github.com/openbmc/phosphor-dbus-interfaces/blob/master/yaml/xyz/openbmc_project/Collection/DeleteAll.interface.yaml
## REST commands
diff --git a/yaml/xyz/openbmc_project/Logging/Settings.interface.yaml b/yaml/xyz/openbmc_project/Logging/Settings.interface.yaml
index fb9f7c3..e89412f 100644
--- a/yaml/xyz/openbmc_project/Logging/Settings.interface.yaml
+++ b/yaml/xyz/openbmc_project/Logging/Settings.interface.yaml
@@ -6,5 +6,5 @@
type: boolean
default: false
description: >
- If true, a hardware failure within the system will result in a
- Quiesce of the BMC state. If false, no action is taken.
+ If true, a hardware failure within the system will result in a Quiesce
+ of the BMC state. If false, no action is taken.