Reduce Common.Device error messages
The full yaml error description is sent with the error reply message
across D-Bus. These two error messages are unnecessarily verbose for
that purpose, so move most of it into a yaml comment.
Tested:
Used busctl to call method that replied with WriteFailure and confirmed
the error message was reduced.
Signed-off-by: Jonathan Doman <jonathan.doman@intel.com>
Change-Id: Icebf2079a18214435e59d05d0ba39eb05b2094f0
diff --git a/xyz/openbmc_project/Common/Device.errors.yaml b/xyz/openbmc_project/Common/Device.errors.yaml
index 3495de3..e04eaa4 100644
--- a/xyz/openbmc_project/Common/Device.errors.yaml
+++ b/xyz/openbmc_project/Common/Device.errors.yaml
@@ -1,19 +1,15 @@
# xyz.openbmc_project.Common.Device.ReadFailure
- name: ReadFailure
+ # This can be used by any application that gets a failure reading from a
+ # device. It is up to the implementation on how to react to this error based
+ # on the use-case. Refer to the interface specification that references this
+ # for additional information.
description: Failed to read from the device.
- This can be used by any application that
- gets a failure reading from a device.
- It is up to the implementation on how to
- react to this error based on the use-case.
- Refer to the interface specification that
- references this for additional information.
# xyz.openbmc_project.Common.Device.WriteFailure
- name: WriteFailure
+ # This can be used by any application that gets a failure writing to a device.
+ # It is up to the implementation on how to react to this error based on the
+ # use-case. Refer to the interface specification that references this for
+ # additional information.
description: Failed to write to device.
- This can be used by any application that
- gets a failure writing to a device.
- It is up to the implementation on how to
- react to this error based on the use-case.
- Refer to the interface specification that
- references this for additional information.