Skip to content

Commit 6dc472e

Browse files
committed
docs/mctpd: Minor wording/formatting fixes
Some small clarifications and alignment of terms to the MCTP spec, and some minor formatting adjustments. Signed-off-by: Jeremy Kerr <jk@codeconstruct.com.au>
1 parent 0601b70 commit 6dc472e

File tree

1 file changed

+9
-10
lines changed

1 file changed

+9
-10
lines changed

docs/mctpd.md

Lines changed: 9 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -26,8 +26,8 @@ Service au.com.codeconstruct.MCTP1:
2626
## Top-level object: `/au/com/codeconstruct/mctp1`
2727

2828
This object serves as the global MCTP daemon namespace.
29-
It hosts `au.com.codeconstruct.MCTP1` dbus interface to modify mctp properties like
30-
supported message types.
29+
It hosts `au.com.codeconstruct.MCTP1` dbus interface to modify properties of
30+
the MCTP stack, such as supported message types.
3131
```
3232
NAME TYPE SIGNATURE RESULT/VALUE FLAGS
3333
au.com.codeconstruct.MCTP1 interface - - -
@@ -37,18 +37,17 @@ au.com.codeconstruct.MCTP1 interface - - -
3737
#### `.RegisterTypeSupport`: `yau`
3838

3939
This method is used to add support for mctp message types other than control
40-
messages. Once called successfully subsequent response for get message type
41-
control command will include this new message type also. Also the versions
42-
passed to this method will be used to respond to get version control command.
40+
messages. Once called successfully subsequent response for Get Message Type
41+
Support control commands will include this new message type. Versions passed to
42+
this method will be used to respond to Get MCTP Version Support commands.
4343

4444
`RegisterTypeSupport <msg type> <versions>`
4545

46-
If message type is already registered then dbus call will fail
46+
If the message type is already registered, then dbus call will fail.
4747

48-
`<msg type>` Message type defined in DSP0239
49-
50-
`<versions>` Versions supported for this message type formatted as uint32 integers as
51-
specified in DSP0236
48+
- `<msg type>` Message type, as defined in DSP0239.
49+
- `<versions>` Versions supported for this message type formatted as uint32
50+
integers as specified in DSP0236
5251

5352
De-registration is automatic - the specified types (and versions) are registered
5453
for as long as the dbus sender remains attached to the message bus, and are

0 commit comments

Comments
 (0)