From 75a1fcf70a7780691ad6d432e76d6f86933079ff Mon Sep 17 00:00:00 2001 From: Dean Troyer Date: Fri, 22 Jul 2016 12:58:24 -0500 Subject: Clarification of option name rules We never specifcally said anywhere that short names are global only and why. Change-Id: Ia2824cb7ebe7c2e1d116c0a9bc7760de24904c61 --- doc/source/command-options.rst | 6 ++++++ 1 file changed, 6 insertions(+) (limited to 'doc/source/command-options.rst') 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 ` +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 ======================= -- cgit v1.2.1