[Pulp-list] CLI Consistency

[Jay Dobies]

-----BEGIN PGP SIGNED MESSAGE-----
Hash: SHA1

I remember this. I actually think about it every time I type --repoid.

I'm still for it if others are. It'll be annoying to update the docs,
but not impossible.

On 02/10/2011 11:41 AM, Jason L Connor wrote:
> On Thu, 2011-02-10 at 10:06 -0500, Jay Dobies wrote:
>> Take the following two examples:
>>
>> $ pulp-admin user create --username hal
>> $ pulp-admin role add --role new-role --user user
>>
>> This may just be my OCD, but I think we should stay consistent in the
>> names of the flags (--username v. --user). I didn't file a bug because
>> I
>> think this is more of
>> just my opinion than something that is actually wrong, but wanted to
>> throw it out there to let people think about it. 
> 
> 
> A while back I actually put together a proposal to overcome this, which
> was pushed off for various reasons, but it may be time to refresh our
> collective memories. Here is my original proposal in its entirety:
> 
> (Please realize this proposal was sent to this list and there were
> follow up emails that I'm not recapping here)
> 
> ----
> 
> Hi All,
> 
> I've been digging around in the cli a bit lately, and I wanted to
> propose some common options and option names for our cli. Please note
> that this is semantic nit-picking. :)
> 
> We use a --id option for most of our actions that pertain to which ever
> collection of resources the command is meant to manipulate.
> E.G in "pulp-admin repo sync --id my-repo", the 'my-repo' is a
> repository id. And it'll mean something else for the consumer command,
> the package command, etc.
> 
> Instead of using options called 'id' or even 'consumerid', 'repoid',
> etc. We should use options that associate themselves with the resources
> and provide short names for all of them. We should use this convention
> on all commands. This is what I propose:
> -c, --consumer : consumer id
> -C, --consumer-group : consumer group id
> -e, --errata : errata id
> -p, --package : package name
> -P, --package-group : package group id
> -r, --repo : repository id
> -u, --username : username
> 
> I think --id is ambiguous and using concatenated --conumserid or
> --repoid is probably unnecessary. These proposed changes will make the
> cli more consistent and intuitive for our end users.
> 


- -- 
Jay Dobies
RHCE# 805008743336126
Freenode: jdob
http://pulpproject.org
-----BEGIN PGP SIGNATURE-----
Version: GnuPG v2.0.14 (GNU/Linux)
Comment: Using GnuPG with Fedora - http://enigmail.mozdev.org/

iQEcBAEBAgAGBQJNVBWDAAoJEOMmcTqOSQHC3e4H/2jglRjjB+GXIZC/7YKKTEfC
3QcGmkyYr0jW5fkm2l8S0xsufFxWmviyd8pBhP9CtS7mYGvjIMSz6TlX9rtJp32w
mk4cLLB2MV+yusUYoshXkTljQO2IubWPeExZYHtlI8gyWEEkyfZF6ot93MI0ewTj
k7RiNXs97+w0VSHgy60sHsde2PnL0XXp27IOrQzNZXC3f21dONXcDpVE7Ug5G4ry
anLCvV+1gHJ3AHKc9D4rr0Atv+7ZGPvvOiZ4Ed4amrQYPjRF0xQoopvZO8OyyQzC
j9C4VXnstuc+fX8/Bqqy9Rd4koH6JB/9t/mtSzJb4xtBtVyLY1RRdmYGWAzQHFg=
=8dRa
-----END PGP SIGNATURE-----