#1955 copr-cli: --timeout option is badly documented
Closed: MIGRATED a year ago by nikromen. Opened 2 years ago by vandebugger.

Help output does not mention --timeout option at all:

$ copr-cli --help | grep -i time

Man page is extremely laconic:

BUILD ACTIONS
    copr-cli build [options]
        usage: copr-cli build ... [--timeout TIMEOUT] ....
...
        --timeout
            Override timeout for this build.
...
EXAMPLES
    copr-cli build-package myproject --name pkgname --nowait --timeout 10000 -r fedora-23-x86_64
...

Option description does not mention the option has an argument. There is no a single word about TIMEOUT. What is timeout unit? Does 1000 means 1000 seconds or 1000 minutes? Does it accept number with unit (e. g. "100m" or "2h")? Does it accept floating point numbers (e. g. "1.5h")? Does it accept time specified in hh:‍mm:ss format?


This is common for python argparse, you need to ask for subcommand --help output:

$ copr build --help
usage: copr build [-h] [--timeout TIMEOUT] [--nowait] [-r CHROOTS] [--exclude-chroot EXCLUDE_CHROOTS] [--background] [--isolation {simple,nspawn,default}] [--enable-net {on,off}] [--bootstrap {unchanged,default,on,off,image}] [--after-build-id BUILD_ID | --with-build-id BUILD_ID] copr_repo pkgs [pkgs ...]

positional arguments:
  copr_repo             The copr repo to build the package in. Can be just name of project or even in format username/project or @groupname/project. It can also be in the form project:<tag>, which will put the build into a side repository with the user-chosen tag in its name.
  pkgs                  filename of SRPM or URL of packages to build

options:
  -h, --help            show this help message and exit
  --timeout TIMEOUT     Specify build timeout (seconds), if the build takes longer than that, it is terminated and fails. The default is usually set to 5 hours on Copr Frontend.

...

The manpage is desynced though, and should be udpated.

Metadata Update from @praiskup:
- Issue tagged with: doc, easyfix

2 years ago

Metadata Update from @nikromen:
- Issue close_status updated to: MIGRATED
- Issue status updated to: Closed (was: Open)

a year ago

Login to comment on this ticket.

Metadata