openstack team mailing list archive

[Dean Troyer <dtroyer@xxxxxxxxx>]

On Thu, Jul 19, 2012 at 4:36 AM, Hua ZZ Zhang <zhuadl@xxxxxxxxxx> wrote:

> I found an interesting thing about the naming style of current command
> arguments. it is a little difference across different components.
> you can see nova/quantum/swift/keystone are using both dash '-' and
> underline '_'. Only keystone is mixed with two style:  --xx_yyy_zzz
> --xx-yyy-zzz
> And glance use the --xx-yyy-zzz style which only contains dash '-'. IMO,
> it's better to be consisitent in naming style for all core components,
> including the usage text. secondly, avoid using same argument name with
> different meanings or different argument name for the same meaning.
> Thirdly, keep it simple as possible, don't use unnecessary symbols.
>

We strive for consistency and unfortunately we are still not there yet.
 The goal is to use '-' in option names everywhere but we also have
backward compatibility to consider.  Glance and keystone are the two that
I've managed to complete so far, the others are on my list and I haven't
gotten there yet.

The goal is to add the options containing '-' and document those while
maintaining the options containing '_' for compatibility and documenting
them as deprecated, if at all, and to be removed sometime in the future (>6
months at least).

FWIW, glance will never have the '_' option names because it is a new
client and already breaks backward compatibility with the original glance
client.

dt

-- 

Dean Troyer
dtroyer@xxxxxxxxx