commit 4e41bf77b367752def5a44d8c2142824134100a9
author Andrew Geissler <geissonator@yahoo.com> Mon Jan 06 13:40:23 2020 -0600
committer Brad Bishop <bradleyb@fuzziesquirrel.com> Tue Feb 04 13:33:57 2020 +0000
tree 622ac18481cf2ff645a58203237494561150d2b3
parent 7adacdcbb6b5cbee833eb647e431f80b13ffe04d

clarify xyz.openbmc_project.Software.Version usage

There were some implied assumptions that were not documented properly
with this interface. openbmc/bmcweb#109 is a result of that lack of
clarity.

https://gerrit.openbmc-project.xyz/c/openbmc/bmcweb/+/28238 will ensure
this is implemented within bmcweb.

Change-Id: Idc3ffa2964920a78c7f387d6cc77375c16d64248
Signed-off-by: Andrew Geissler <geissonator@yahoo.com>

xyz/openbmc_project/Software/Version.interface.yaml

diff --git a/xyz/openbmc_project/Software/Version.interface.yaml b/xyz/openbmc_project/Software/Version.interface.yaml
index e769bf7..345e5b5 100644
--- a/xyz/openbmc_project/Software/Version.interface.yaml
+++ b/xyz/openbmc_project/Software/Version.interface.yaml
@@ -1,5 +1,10 @@
 description: >
-    Simple definition of a Software or Firmware version.
+    Simple definition of a Software or Firmware version. Note that this
+    interface may be implemented by D-Bus objects that do not necessarily
+    contain a software level. For example an OpenBMC log may implement this
+    interface to store the software level of the BMC or Host for debug purposes.
+    If looking for real software versions associated with a device then ensure
+    this interface is under the /xyz/openbmc_project/software object path.
 properties:
     - name: Version
       type: string