Skip to content

Correct documentation and update mctp tool help #164

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
SafetyInObscurity wants to merge 2 commits into
base: main
Choose a base branch
from
Open

Correct documentation and update mctp tool help #164

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
072b9c6
Fix some minor errors in mctpd.md
SafetyInObscurity Jul 2, 2026
970714c
Update mctp help to be consistent with the use of IFNAME
SafetyInObscurity Jul 14, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
17 changes: 10 additions & 7 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -44,23 +44,26 @@ Use `mctp help` for the list of available commands:
mctp link
mctp link show [ifname]
mctp link set <ifname> [up|down] [mtu <mtu>] [network <net>] [bus-owner <physaddr>]
mctp link serial <device>

mctp address
mctp address show [IFNAME]
mctp address add <eid> dev <IFNAME>
mctp address del <eid> dev <IFNAME>
mctp address show [ifname]
mctp address add <eid> dev <ifname>
mctp address del <eid> dev <ifname>

mctp route
mctp route show [net <network>]
mctp route add <eid>[-<eid>] via <dev> [mtu <mtu>]
mctp route add <eid>[-<eid>] via <ifname> [mtu <mtu>]
mctp route add <eid>[-<eid>] gw <eid> [net <net>] [mtu <mtu>]
mctp route del <eid>[-<eid>] via <dev>
mctp route del <eid>[-<eid>] via <ifname>
mctp route del <eid>[-<eid>] gw <eid> [net <net>]

mctp neigh
mctp neigh show [dev <network>]
mctp neigh add <eid> dev <device> lladdr <physaddr>
mctp neigh del <eid> dev <device>
mctp neigh add <eid> dev <ifname> lladdr <physaddr>
mctp neigh del <eid> dev <ifname>

mctp monitor

`mctpd` Usage
-------------
Expand Down
5 changes: 1 addition & 4 deletions docs/mctpd.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -132,9 +132,6 @@ represents the bus-owner side of a transport.

```
NAME TYPE SIGNATURE RESULT/VALUE FLAGS
au.com.codeconstruct.MCTP.Interface1 interface - - -
.NetworkId property u 1 emits-change
.Role property s "BusOwner" emits-change writable
au.com.codeconstruct.MCTP.BusOwner1 interface - - -
.AssignEndpoint method ay yisb -
.AssignEndpointStatic method ayy yisb -
Expand Down Expand Up @@ -248,7 +245,7 @@ reports as a bridge.

Bridge endpoints should be initialised with `AssignEndpoint` instead.

## Network objects: `/au/com/codeconstruct/networks/<net>`
## Network objects: `/au/com/codeconstruct/mctp1/networks/<net>`

These objects represent MCTP networks which have been added use `mctp link`
commands. These will be 1:1 with the MCTP networks on the system.
Expand Down
14 changes: 7 additions & 7 deletions src/mctp.c
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -895,10 +895,10 @@ static int cmd_addr(struct ctx *ctx, int argc, const char **argv)
const char *subcmd;
if (argc == 2 && !strcmp(argv[1], "help")) {
fprintf(stderr, "%s address\n", ctx->top_cmd);
fprintf(stderr, "%s address show [IFNAME]\n", ctx->top_cmd);
fprintf(stderr, "%s address add <eid> dev <IFNAME>\n",
fprintf(stderr, "%s address show [ifname]\n", ctx->top_cmd);
fprintf(stderr, "%s address add <eid> dev <ifname>\n",
ctx->top_cmd);
fprintf(stderr, "%s address del <eid> dev <IFNAME>\n",
fprintf(stderr, "%s address del <eid> dev <ifname>\n",
ctx->top_cmd);
return 255;
}
Expand Down Expand Up @@ -1126,12 +1126,12 @@ static int cmd_route(struct ctx *ctx, int argc, const char **argv)
fprintf(stderr, "%s route show [net <network>]\n",
ctx->top_cmd);
fprintf(stderr,
"%s route add <eid>[-<eid>] via <dev> [mtu <mtu>]\n",
"%s route add <eid>[-<eid>] via <ifname> [mtu <mtu>]\n",
ctx->top_cmd);
fprintf(stderr,
"%s route add <eid>[-<eid>] gw <eid> [net <net>] [mtu <mtu>]\n",
ctx->top_cmd);
fprintf(stderr, "%s route del <eid>[-<eid>] via <dev>\n",
fprintf(stderr, "%s route del <eid>[-<eid>] via <ifname>\n",
ctx->top_cmd);
fprintf(stderr,
"%s route del <eid>[-<eid>] gw <eid> [net <net>]\n",
Expand Down Expand Up @@ -1336,11 +1336,11 @@ static int cmd_neigh(struct ctx *ctx, int argc, const char **argv)
fprintf(stderr, "%s neigh show [dev <network>]\n",
ctx->top_cmd);
fprintf(stderr,
"%s neigh add <eid> dev <device> lladdr <physaddr>\n",
"%s neigh add <eid> dev <ifname> lladdr <physaddr>\n",
ctx->top_cmd);
fprintf(stderr,
" <physaddr> syntax is for example \"1d\" or \"aa:bb:cc:11:22:33\"\n");
fprintf(stderr, "%s neigh del <eid> dev <device>\n",
fprintf(stderr, "%s neigh del <eid> dev <ifname>\n",
ctx->top_cmd);
return 255;
}
Expand Down
Loading