Skip to content

Conversation

@BengangY
Copy link
Contributor

The previous xe help is as below:

Usage: xe <cmd> [-s server] [-p port] ([-u username] [-pw password] or [-pwf <password file>]) [--traceparent traceparent] <other arguments>

A full list of commands can be obtained by running
	xe help -s <server> -p <port>

The previous xe help output lacked debug-related options and did not provide detailed parameter description.
The new xe help output is as follows:

Usage:
  xe <command>
    [ -s <server> ]            XenServer host
    [ -p <port> ]              XenServer port number
    [ -u <username> -pw <password> | -pwf <password file> ]
                               User authentication (password or file)
    [ --nossl ]                Disable SSL/TLS
    [ --debug ]                Enable debug output
    [ --debug-on-fail ]        Enable debug output only on failure
    [ --traceparent <value> ]  Distributed tracing context
    [ <other arguments> ... ]  Command-specific options

A full list of commands can be obtained by running
  xe help -s <server> -p <port>

The previous `xe` help is as below:
```
Usage: xe <cmd> [-s server] [-p port] ([-u username] [-pw password] or [-pwf <password file>]) [--traceparent traceparent] <other arguments>

A full list of commands can be obtained by running
	xe help -s <server> -p <port>
```

The previous `xe` help output lacked debug-related options and did not
provide detailed parameter description.
The new `xe` help output is as follows:
```
Usage:
  xe <command>
    [ -s <server> ]            XenServer host
    [ -p <port> ]              XenServer port number
    [ -u <username> -pw <password> | -pwf <password file> ]
                               User authentication (password or file)
    [ --nossl ]                Disable SSL/TLS
    [ --debug ]                Enable debug output
    [ --debug-on-fail ]        Enable debug output only on failure
    [ --traceparent <value> ]  Distributed tracing context
    [ <other arguments> ... ]  Command-specific options

A full list of commands can be obtained by running
  xe help -s <server> -p <port>
```

Signed-off-by: Bengang Yuan <[email protected]>
@BengangY BengangY marked this pull request as ready for review July 21, 2025 10:17
[ --debug-on-fail ] Enable debug output only on failure
[ --traceparent <value> ] Distributed tracing context
[ <other arguments> ... ] Command-specific options

Copy link
Contributor

@changlei-li changlei-li Jul 22, 2025

Choose a reason for hiding this comment

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

I would suggest not to keep two duplications of usage text in the code (here and newcli.ml) to avoid extra maintenance effort. For this case, usage appears in xe help and xe help --all. We can fill the usage part in client side(newcli.ml) and the remaining part (command list) in server side (here) and compose them together as the command output.

@lindig lindig requested a review from GabrielBuica July 28, 2025 15:04
@lindig
Copy link
Contributor

lindig commented Jul 28, 2025

I would suggest to merge this; it is already an improvement and if there is no appetite for more changes it's good enough.

@lindig lindig added this pull request to the merge queue Jul 29, 2025
Merged via the queue into xapi-project:master with commit 2d2f5fb Jul 29, 2025
16 checks passed
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.

4 participants