diff options
| author | Jenkins <jenkins@review.openstack.org> | 2016-07-22 21:07:58 +0000 |
|---|---|---|
| committer | Gerrit Code Review <review@openstack.org> | 2016-07-22 21:07:58 +0000 |
| commit | 859517f657aebd60adee3cb925fdde136ef05aba (patch) | |
| tree | 02c93974a0ce7148d63b848d608f5d2d6460e4f8 /doc/source/command-options.rst | |
| parent | 719c5d79ced34687944eb0bf458f36070817a7b9 (diff) | |
| parent | 75a1fcf70a7780691ad6d432e76d6f86933079ff (diff) | |
| download | python-openstackclient-859517f657aebd60adee3cb925fdde136ef05aba.tar.gz | |
Merge "Clarification of option name rules"
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 ======================= |