#2071 Better help for build/latest-build
Merged by tkopecek. Opened by tkopecek.
tkopecek/koji issue1808  into  master

Download 2071.patch

People can be confused by buildtag/desttag/target. Shed some light in
these commands' helps.

Fixes: https://pagure.io/koji/issue/1808

Metadata Update from @tkopecek:
- Pull-request tagged with: testing-ready

Metadata Update from @tkopecek:
- Pull-request untagged with: testing-ready
- Pull-request tagged with: doc, no_qe

There are some stray double quotes left in the string. I'm seeing this:

$ koji build --help
Usage: lkoji build [options] <target> <srpm path or scm url>
First option is build target (don't confuse it with destination
tag (where build ends) or buildroot (from where dependencies
are installed).
List of all available targets can be acquired by "
'koji list-targets'. For further info about how tags, targets "
and buildroot interact, check the "
https://docs.pagure.org/koji/HOWTO/#package-organization
(Specify the --help global option for a list of other help options)
Options:

I'd probably avoid the nested parenthetical expressions and adjust the grammar a little. Maybe...

The first option is the build target, not to be confused with the destination
tag (where the build eventually lands) or build tag (where the buildroot
contents are pulled from).
You can list all available build targets using the 'koji list-targets'
command. More detail can be found in the documentation.
https://docs.pagure.org/koji/HOWTO/#package-organization

It seems a little odd to format this usage string to match the code where it lies, and then transform it at run time. Also, the lines end up looking short because they are wrapped before col 80 in the code and then dedented by 8.

1 new commit added

  • fix grammar

Any other idea, how to make these strings "nicer"? I've added a commit with grammar fixes and formatted string for larger width. Not sure, if using it without dedent is more readable.

1 new commit added

  • fix test

Things look better with the adjusted width. I guess dedent might be the least awkward option at this point.

I put a few grammar adjustments here:
https://github.com/mikem23/koji-playground/commits/pagure/pr/2071

1 new commit added

  • more grammar changes

Commit ae05aa76 fixes this pull-request

Pull-Request has been merged by tkopecek

Metadata