Skip to content

Commit

Permalink
Improve help texts of openqa-cli
Browse files Browse the repository at this point in the history
* Fix documentation of syntax for displaying help text of nested commands
* Add a short description of what the schedule and monitor commands do on
  their help texts
  • Loading branch information
Martchus committed Jan 20, 2025
1 parent 8637e82 commit b4d0159
Show file tree
Hide file tree
Showing 3 changed files with 6 additions and 1 deletion.
2 changes: 1 addition & 1 deletion lib/OpenQA/CLI.pm
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ use Mojo::Base 'Mojolicious::Commands';

has hint => <<EOF;
See 'openqa-cli help COMMAND' for more information on a specific command.
See 'openqa-cli COMMAND --help' for more information on a specific command.
EOF
has message => sub { shift->extract_usage . "\nCommands:\n" };
has namespaces => sub { ['OpenQA::CLI'] };
Expand Down
3 changes: 3 additions & 0 deletions lib/OpenQA/CLI/monitor.pm
Original file line number Diff line number Diff line change
Expand Up @@ -56,6 +56,9 @@ sub command ($self, @args) {
Usage: openqa-cli monitor [OPTIONS] [JOB_IDS]
Wait until all specified jobs have reached a final state and return a non-zero
exit code if at least one job is not ok (is not passed or softfailed).
Options:
--apibase <path> API base, defaults to /api/v1
--apikey <key> API key
Expand Down
2 changes: 2 additions & 0 deletions lib/OpenQA/CLI/schedule.pm
Original file line number Diff line number Diff line change
Expand Up @@ -52,6 +52,8 @@ sub command ($self, @args) {
Usage: openqa-cli schedule [OPTIONS] DISTRI=… VERSION=… FLAVOR=… ARCH=… [ISO=… …]
Schedule a set of jobs creating a scheduled product on the web UI ("posts an ISO").
Options:
--apibase <path> API base, defaults to /api/v1
--apikey <key> API key
Expand Down

0 comments on commit b4d0159

Please sign in to comment.