Take a stab at a proper DBUS API document. (#25)
A message that is not in the archive (sent off-list or not yet received): openbmc/docs/pull/[email protected]
A message that is not in the archive (sent off-list or not yet received): openbmc/docs/pull/25/[email protected]
Thanks Chris!
Quoted 10 lines · Chris Austen
Review status: 0 of 1 files reviewed at latest revision, 4 unresolved discussions.
dbus-interfaces.md, line 50 [r1] (raw file):
| ------------------------- | ---------------------------------------- | ---------------------------------------- | | /org/openbmc/HostIpmi/<n> | Yes on systems with the host-ipmi machine feature, otherwise no. | n: IPMI interface number. If implemented, at least one IPMI interface must exist. |n: you did not specify where n comes from. The tag does not translate in md. maybe you need <n> ?
added backticks and it shows up now.
Quoted 8 lines
dbus-interfaces.md, line 62 [r1] (raw file):
| ------------ | ------------ | ------------- | ---------------------------------------- | | SoftPowerOff | void | x | Prepare the host processor firmware for an orderly shutdown. | | | | x | The result status. |x would be a negative number for bad results, positive for good? Will need someone to define that
Yeah. Can that come later? There are lots of undefined things in here…
Quoted 8 lines
dbus-interfaces.md, line 81 [r1] (raw file):
| ---------- | ------------ | ------------- | ----------------------------- | | setPresent | s | void | Indicate the item is present. | | | s | | true or false |I looked at the code, the first letter is capitalized
I looked too, again, and it isn’t. What are you looking at?
Quoted 8 lines
dbus-interfaces.md, line 192 [r1] (raw file):
| path | required | description | | ------------------------------------- | -------- | ---------------------------------------- | | /org/openbmc/sensors/<class>/<sensor> | No | Any sensor instances must be instantiated in the sensors namespace. |those angled brackets do not show up on the web. HTML must want to use them. perhaps the hexcode for them ?
backticks fixed.
Quoted 7 lines
Comments from Reviewable
—
You are receiving this because you authored the thread. Reply to this email directly or view it on GitHub