diff options
| author | Dean Troyer <dtroyer@gmail.com> | 2016-07-22 12:58:24 -0500 |
|---|---|---|
| committer | Dean Troyer <dtroyer@gmail.com> | 2016-07-22 12:58:28 -0500 |
| commit | 75a1fcf70a7780691ad6d432e76d6f86933079ff (patch) | |
| tree | 1ccaac469ef22c9c6f3f38aeb04db45a08ecc1f6 /doc/source/command-options.rst | |
| parent | b59ade75e5343ac43475afbd123c3ce6b0058357 (diff) | |
| download | python-openstackclient-75a1fcf70a7780691ad6d432e76d6f86933079ff.tar.gz | |
Clarification of option name rules
We never specifcally said anywhere that short names are global only and why.
Change-Id: Ia2824cb7ebe7c2e1d116c0a9bc7760de24904c61
Diffstat (limited to 'doc/source/command-options.rst')
| -rw-r--r-- | doc/source/command-options.rst | 6 |
1 files changed, 6 insertions, 0 deletions
diff --git a/doc/source/command-options.rst b/doc/source/command-options.rst index 5cb84684..6260ec32 100644 --- a/doc/source/command-options.rst +++ b/doc/source/command-options.rst @@ -14,6 +14,12 @@ for defining and using options in all situations. The alternative of only using it when necessary leads to errors when copy-n-paste is used for a new command without understanding why or why not that instance is correct. +The :doc:`Human Interface Guide <humaninterfaceguide>` +describes the guildelines for option names and usage. In short: + * All option names shall be GNU-style long names (two leading dashes). + * Some global options may have short nmaes, generally limited to those defined + in support libraries such as ``cliff``. + General Command Options ======================= |