Skip to content

Correct documentation and update mctp tool help#164

Open
SafetyInObscurity wants to merge 2 commits into
CodeConstruct:mainfrom
SafetyInObscurity:md-fixes
Open

Correct documentation and update mctp tool help#164
SafetyInObscurity wants to merge 2 commits into
CodeConstruct:mainfrom
SafetyInObscurity:md-fixes

Conversation

@SafetyInObscurity

Copy link
Copy Markdown

There are some minor errors, inconsistencies, and duplications in the documentation and mctp tool help. I've aimed to make common-sense corrections.

Comment thread src/mctp.c Outdated
Remove duplicate MCTP interface description from the MCTP BusOwner
interface description and correct network objects path in docs/mctpd.md.

Signed-off-by: James Lee <james@codeconstruct.com.au>
The help information for the mctp tool alternated between using <dev>
and <IFNAME> when describing interface names. Switch to use <ifname>,
which should be more helpful than `dev <dev>` and matches the case
conventions of the other options.

Update README.md to reflect the changes and add `mctp monitor` to the
end, which had been ommitted.

Signed-off-by: James Lee <james@codeconstruct.com.au>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants