PR#423: Minor doc tweaks for fedora-create-review - FedoraReview

Ankur Sinha (Ankur Sinha Gmail) • 2 years ago

c8362df

Ankur Sinha (Ankur Sinha Gmail) • 2 years ago

f909632

fedora-create-review.1

file modified

+25 -1

		`@@ -46,7 +46,31 @@`
		`.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`

src/FedoraReview/create_review.py

file modified

+6 -1

		`@@ -455,7 +455,12 @@`
		`"""`
		`Set the command line arguments.`
		`"""`
		`- parser = argparse.ArgumentParser(prog="fedora-create-review")`
		`+ parser = argparse.ArgumentParser(`
		`+ prog="fedora-create-review",`
		`+ description="Create a new Fedora package review ticket",`
		+ epilog="Please see `man fedora-create-review` for more information, such as how to use the configuration file.\n\n Please file bugs, feature requests, and pull requests at https://pagure.io/FedoraReview/."
		`+`
		`+ )`
		`# General connection options`
		`parser.add_argument("specfile", help="Path to the spec file")`
		`parser.add_argument("srpmfile", help="Path to the src.rpm file")`