koji

#650 Lack of useful information in add-taget command
Closed: Invalid by tkopecek. Opened by franzh.

Closed: Invalid
Reopen Issue

The target plays an important role in koji, however the help messages of add-target command is very short and does not contain useful information:

Usage: koji add-target name build-tag <dest-tag>
(Specify the --help global option for a list of other help options)
Options:
  -h, --help  show this help message and exit

Thoughts:
1. We don't have a lot of room to add text to the auto-generated help
2. This help is a quick reference, not a man page
3. Perhaps we should add some man pages finally
4. The main documentation is also lacking
5. None of our other commands provide detailed help either

We could, I suppose, provide a link here: https://docs.pagure.org/koji/#tags-and-targets
However, it feels a little inconsistent to do this for just one of our many commands.

Perhaps, in the short term, the thing to do would be to add a link to our main documentation in the help for every command.

Longer term, we'd need to clean up, refactor, and expand our documentation, which would include the addition of man pages.

@mikem

Adding man pages is a good idea.
Since this is a low priority issue, we can start the works in background.

Any ideas how we want to do man pages (some automatic generation from extended docstrings, or completely separate?)

Metadata Update from @tkopecek:
- Custom field Size adjusted to None
- Issue close_status updated to: Invalid
- Issue status updated to: Closed (was: Open)

Replaced with #2232

This issue has been migrated to Fedora Forge:
https://forge.fedoraproject.org/koji/koji/issues/650

Please continue any further discussion there.
Metadata
None
None
None
None
None
Static archive. pagure.io was sunset in 2026; this is a read-only snapshot.
Red Hat Logo

Fedora is sponsored by Red Hat. Learn more about the relationship between Red Hat and Fedora »

© Red Hat, Inc. and others.