#193 request-repo --module-name flag is not documented
Closed: Fixed 5 years ago Opened 6 years ago by bowlofeggs.

The --help text for request-repo casually mentions a --module-name flag, but does not document it:

fedpkg request-repo --help
usage: fedpkg request-repo [-h] [--description DESCRIPTION]
                           [--monitor {no-monitoring,monitoring,monitoring-with-scratch}]
                           [--upstreamurl UPSTREAMURL] [--summary SUMMARY]
                           [--exception]
                           [bug]

Request a new dist-git repository

Before requesting a new dist-git repository for a new package, you need to
generate a pagure.io API token at https://pagure.io/settings/token/new, and save it
into your local user configuration located at ~/.config/rpkg/fedpkg.conf. For
example:

    [fedpkg.pagure]
    token = <api_key_here>

Below is a basic example of the command to request a dist-git repository for
the package foo:

    fedpkg --module-name foo request-repo 1234

positional arguments:
  bug                   Bugzilla bug ID of the package review request

optional arguments:
  -h, --help            show this help message and exit
  --description DESCRIPTION, -d DESCRIPTION
                        The repo's description in dist-git
  --monitor {no-monitoring,monitoring,monitoring-with-scratch}, -m {no-monitoring,monitoring,monitoring-with-scratch}
                        The Koshei monitoring type for the repo
  --upstreamurl UPSTREAMURL, -u UPSTREAMURL
                        The upstream URL of the project
  --summary SUMMARY, -s SUMMARY
                        Override the package's summary from the Bugzilla bug
  --exception           The package is an exception to the regular package
                        review process (specifically, it does not require a
                        Bugzilla bug)

Note that --module-name does not appear in the optional argument section.

Additionally, it is unclear if the name "module" here means Fedora's recent modularity package type, or if it can be used with an RPM. This is further confusing, because it seems like it might be a required parameter.


It seems that it only appears in the documentation at the top level with fedpkg --help, and must also be given before request-repo.

I still find the name "module" here to be confusing.

I filed a bug about this not being documented as well: https://pagure.io/fedpkg/issue/184

What I didn't even realize at that time is that you have to specify this flag to request a new repository because it's not actually a module? It's so confusing I gave up after filing that ticket, so I think this really needs to change.

Metadata Update from @cqi:
- Issue set to the milestone: NEXT
- Issue tagged with: bug, rpkg

5 years ago

Metadata Update from @cqi:
- Issue set to the milestone: 1.34 (was: NEXT)

5 years ago

Metadata Update from @cqi:
- Issue assigned to cqi

5 years ago

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

5 years ago

Login to comment on this ticket.

Metadata