PR#389: ODCS client: improve --help text for --sigkey - odcs

odcs

#389 ODCS client: improve --help text for --sigkey

Merged 3 years ago by lsedlar. Opened 3 years ago by ktdreyer.

ktdreyer/odcs odcs-help-sigkey into master

ODCS client: improve --help text for --sigkey

Ken Dreyer • 3 years ago

9cb0b16

client/contrib/odcs

file modified

+7 -1

		`@@ -90,7 +90,13 @@`
		`"--sigkey": dict(`
		`default=[],`
		`action="append",`
		`- help='Signing key ID using which the packages must be signed - "none" for no signing key.', # noqa: E501`
		`+ help='ODCS will require that all packages are signed by this ' \`
		`+ 'signing key ID. Example: "FD431D51". You may use this option ' \`
		`+ 'multiple times to specify multiple key IDs. ODCS will choose ' \`
		`+ 'signed packages according to the order of the key IDs that ' \`
		`+ 'you specify here. Use "--sigkey none" to allow unsigned ' \`
		`+ 'packages. If you do not specify any --sigkey option, ODCS ' \`
		`+ 'will use the default signing key list (defined on the server).'`
		`),`
		`"--koji-event": dict(default=None, help="Koji event for populating package set"),`
		`"--arch": dict(`

ktdreyer commented 3 years ago

Add more inline documentation for the --sigkey option.

ktdreyer commented 3 years ago

I wrote "If you do not specify any --sigkey option, ODCS will use all unsigned packages", but now I think that might be incorrect.

lsedlar commented 3 years ago

Yes, the description for no sigkeys is not correct. If nothing is specified, ODCS will use default keys configured on the server. Unfortunately there's no way for the client to get these defaults.

rebased onto 9cb0b16

3 years ago

ktdreyer commented 3 years ago

Thanks. I've updated the text to say "If you do not specify any --sigkey option, ODCS will use the default signing key list (defined on the server)."