Skip to content

ch-remote: sort all commands and args alphabetically #7130

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

Jump to bottom
Merged
rbradford merged 3 commits into from
Jun 12, 2025
Merged

ch-remote: sort all commands and args alphabetically #7130

rbradford merged 3 commits into from
Jun 12, 2025

Conversation

@phip1611
Copy link
Member

@phip1611 phip1611 commented Jun 11, 2025 •
edited
Loading

Same as in #6988 but for ch-remote. This improves the UX for developers and users.

ch-remote --help (new)

Remotely control a cloud-hypervisor VMM.

Usage: ch-remote [OPTIONS] <COMMAND>

Commands:
  add-device         Add VFIO device
  add-disk           Add block device
  add-fs             Add virtio-fs backed fs device
  add-net            Add network device
  add-pmem           Add persistent memory device
  add-user-device    Add userspace device
  add-vdpa           Add vDPA device
  add-vsock          Add vsock device
  boot               Boot a created VM
  coredump           Create a coredump from VM
  counters           Counters from the VM
  create             Create VM from a JSON configuration
  delete             Delete a VM
  info               Info on the VM
  nmi                Trigger NMI
  pause              Pause the VM
  ping               Ping the VMM to check for API server availability
  power-button       Trigger a power button in the VM
  reboot             Reboot the VM
  receive-migration  Receive a VM migration
  remove-device      Remove VFIO and PCI device
  resize             Resize the VM
  resize-zone        Resize a memory zone
  restore            Restore VM from a snapshot
  resume             Resume the VM
  send-migration     Initiate a VM migration
  shutdown           Shutdown the VM
  shutdown-vmm       Shutdown the VMM
  snapshot           Create a snapshot from VM
  help               Print this message or the help of the given subcommand(s)

Options:
      --api-socket <api-socket>  HTTP API socket path (UNIX domain socket).
  -h, --help                     Print help
  -V, --version                  Print version

ch-remote --help old

Remotely control a cloud-hypervisor VMM.

Usage: ch-remote [OPTIONS] <COMMAND>

Commands:
  add-device         Add VFIO device
  add-disk           Add block device
  add-fs             Add virtio-fs backed fs device
  add-pmem           Add persistent memory device
  add-net            Add network device
  add-user-device    Add userspace device
  add-vdpa           Add vDPA device
  add-vsock          Add vsock device
  remove-device      Remove VFIO and PCI device
  info               Info on the VM
  counters           Counters from the VM
  pause              Pause the VM
  reboot             Reboot the VM
  power-button       Trigger a power button in the VM
  resize             Resize the VM
  resize-zone        Resize a memory zone
  resume             Resume the VM
  boot               Boot a created VM
  delete             Delete a VM
  shutdown           Shutdown the VM
  snapshot           Create a snapshot from VM
  restore            Restore VM from a snapshot
  coredump           Create a coredump from VM
  send-migration     Initiate a VM migration
  receive-migration  Receive a VM migration
  create             Create VM from a JSON configuration
  ping               Ping the VMM to check for API server availability
  shutdown-vmm       Shutdown the VMM
  nmi                Trigger NMI
  help               Print this message or the help of the given subcommand(s)

Options:
      --api-socket <api-socket>  HTTP API socket path (UNIX domain socket).
  -h, --help                     Print help
  -V, --version                  Print version

@phip1611 phip1611 requested a review from a team as a code owner June 11, 2025 17:02
@phip1611 phip1611 force-pushed the ch-remote-cli-ops branch from 4f556a0 to 2b76820 Compare June 11, 2025 17:05
@phip1611
ch-remote: move Args and Commands creation to function
956193a 
This enables to sort them alphabetically in a next step, similar
to cloud-hypervisor#6988 / c37c639.

[0] cloud-hypervisor#6988

Signed-off-by: Philipp Schuster <[email protected]>
On-behalf-of: SAP [email protected]
@phip1611 phip1611 force-pushed the ch-remote-cli-ops branch from 2b76820 to 9208ce6 Compare June 11, 2025 17:09
phip1611
phip1611 commented Jun 11, 2025
View reviewed changes
src/test_util.rs
//

#[cfg(test)]
pub mod tests {
Copy link
Member Author

@phip1611 phip1611 Jun 11, 2025

Choose a reason for hiding this comment

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

could drop the module definition, as the whole fike is already module test_util

@phip1611 phip1611 force-pushed the ch-remote-cli-ops branch from 9208ce6 to 661bd43 Compare June 11, 2025 18:01
@phip1611
ch-remote: sort all commands and args alphabetically
e9cfcaf 
Having them sorted alphabetically makes more sense since there are
already many, and the list is growing. This improves the UX for users
and developers.

Signed-off-by: Philipp Schuster <[email protected]>
On-behalf-of: SAP [email protected]
@phip1611 phip1611 force-pushed the ch-remote-cli-ops branch from 661bd43 to e9cfcaf Compare June 11, 2025 18:03
russell-islam
russell-islam reviewed Jun 12, 2025
View reviewed changes
@rbradford rbradford added this pull request to the merge queue Jun 12, 2025
Merged via the queue into cloud-hypervisor:main with commit d594107 Jun 12, 2025
38 of 39 checks passed
@phip1611 phip1611 deleted the ch-remote-cli-ops branch June 12, 2025 16:08
phip1611 added a commit to phip1611/cloud-hypervisor that referenced this pull request Jun 13, 2025
@phip1611
tests: cleanup test_util module
4346a53 
We can remove the `tests` module as the entire file is only
available when running tests.

Follow-up of cloud-hypervisor#7130 / 1f13165.

Signed-off-by: Philipp Schuster <[email protected]>
On-behalf-of: SAP [email protected]
@phip1611 phip1611 mentioned this pull request Jun 13, 2025
Merged
phip1611 added a commit to phip1611/cloud-hypervisor that referenced this pull request Jun 13, 2025
@phip1611
tests: cleanup test_util module
ce471ff 
We can remove the `tests` module as the entire file is only
available when running tests.

Follow-up of cloud-hypervisor#7130 / 1f13165.

Signed-off-by: Philipp Schuster <[email protected]>
On-behalf-of: SAP [email protected]
github-merge-queue bot pushed a commit that referenced this pull request Jun 13, 2025
@phip1611 @likebreath
tests: cleanup test_util module
53e9c94 
We can remove the `tests` module as the entire file is only
available when running tests.

Follow-up of #7130 / 1f13165.

Signed-off-by: Philipp Schuster <[email protected]>
On-behalf-of: SAP [email protected]
@likebreath likebreath moved this from 🆕 New to ✅ Done in Cloud Hypervisor Roadmap Jul 16, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@russell-islam russell-islam russell-islam left review comments

@rbradford rbradford rbradford approved these changes

Assignees

No one assigned

Labels

None yet

Projects

Cloud Hypervisor Roadmap
Status: ✅ Done

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

3 participants

@phip1611 @rbradford @russell-islam