Documentation update to incus evacuate --action

Incus
1

Asking for an addition to Documentation:

Under Options --action please add the posibilities too, just mentioning would be helpfull:
auto migrate live-migrate stop stateful-stop force-stop

Also is it possible to handle this different in a future version?

Original:

incus cluster evacuate pi5n2 --action help
Are you sure you want to evacuate cluster member "pi5n2"? (yes/no) [default=no]: yes
Error: Failed to update cluster member state: Invalid value "help" (not one of [auto migrate live-migrate stop stateful-stop force-stop])

How I think it would should be:

incus cluster evacuate pi5n2 --action (help|--help)
Help: Available commands: [auto migrate live-migrate stop stateful-stop force-stop]

So the idea is, it is not asking to confirm an evacuation but instead gives valuable hints.

2

Not particularly easy to do. The client tool doesn’t know what’s valid or not for a particular Incus server. The validation is done by the server when processing the request, which is done after the client requested user confirmation.

3

But adding it to the documentation would be nice hint. You can send me the raw text from the documentation and I add it (if I can) so you have to only review it.

4

I agree, this is what the help text looks like currently:

# /usr/bin/incus cluster evacuate --help
Description:
  Evacuate cluster member

Usage:
  incus cluster evacuate [<remote>:]<member> [flags]

Aliases:
  evacuate, evac

Flags:
      --action   Force a particular evacuation action
      --force    Force evacuation without user confirmation

Global Flags:
      --debug          Show all debug messages
      --force-local    Force using the local unix socket
  -h, --help           Print help
      --project        Override the source project
  -q, --quiet          Don't show progress information
      --sub-commands   Use with help or --help to view sub-commands
  -v, --verbose        Show all information messages
      --version        Print version number

Simply saying “Force a particular evacuation action” without stating what the possible action values are is not good documentation.

It’s also not stated when simply doing --action:

Error: flag needs an argument: --action