Skip to content

docs: clarify usage message for runtime commands#1

Merged
muchzill4 merged 2 commits into
arm:mainfrom
federicobozzini:usage-improvements
Oct 7, 2025
Merged

docs: clarify usage message for runtime commands#1
muchzill4 merged 2 commits into
arm:mainfrom
federicobozzini:usage-improvements

Conversation

@federicobozzini

Copy link
Copy Markdown
Contributor

Changes

  • Usage messages mention <ID>. EG:
$ remoteproc-runtime create
Error: accepts 1 arg(s), received 0
Usage:
  container-runtime create <ID> [flags]

In some cases it might not be obvious what ID is required.

runc uses <container-id> that is more obvious.

runc create
Incorrect Usage.

NAME:
   runc create - create a container

USAGE:
   runc create [command options] <container-id>

This PR renames ID to container-id for clarity and consistency.

Checklist

  • 🤖 This change is covered by tests as required.
  • 🤹 All required manual testing has been performed.
  • 📖 All documentation updates are complete.

muchzill4
muchzill4 previously approved these changes Oct 7, 2025

@muchzill4 muchzill4 left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

👍

Signed-off-by: federicobozzini <federico.bozzini@gmail.com>
@muchzill4 muchzill4 merged commit b033cfd into arm:main Oct 7, 2025
3 checks passed
@federicobozzini federicobozzini deleted the usage-improvements branch October 7, 2025 10:42
yejseo01 referenced this pull request in yejseo01/remoteproc-runtime Oct 20, 2025
Signed-off-by: federicobozzini <federico.bozzini@gmail.com>
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