From f9096322ffcb1486439954ef5dca3eaf00aefc32 Mon Sep 17 00:00:00 2001 From: Ankur Sinha (Ankur Sinha Gmail) Date: Mar 15 2022 18:33:25 +0000 Subject: docs: add config info for fedora-create-review --- diff --git a/fedora-create-review.1 b/fedora-create-review.1 index e8713b9..096fbf9 100644 --- a/fedora-create-review.1 +++ b/fedora-create-review.1 @@ -46,7 +46,31 @@ scratch-build. .SH FILES .I $HOME/.config/fedora-create-review .RS -User configuration files for fedora-create-review +User configuration file for fedora-create-review + +The configuration file is an ini file of this form: +.EX + [fedora-create-review] + bugzilla_api_key = .. + bugzilla_username = .. + upload_target = .. +.EE + +"bugzilla_api_key" and "bugzilla_username" are the API key to a bugzilla instance, and a username respectively. +They are both optional. If the "bugzilla_username" is not set, fedora-create-review will ask for it interactively. + +"upload_target" takes a URL where the spec and SRPM file will be uploaded to using the "scp" command. +So you must have write access to this location. + +A common URL here for Fedora package maintainers would be of the form "fedorapeople.org:public_html/". + +Two place holders may be used in the URL which are substituted by fedora-create-review: + - "@username@" is a place holder for the value provided by the --username flag + - "@pkgname@" is place holder which is substituted by the name of the package. + + For example, this will create a new directory for each package on your Fedora people space: + upload_target = fedorapeople.org:public_html/@pkgname@/ + .RE .SH AUTHORS