From 6f162034d0fc9a49ab1dcf2b773fa9677215cba3 Mon Sep 17 00:00:00 2001 From: Sami Kerola Date: Sat, 17 Sep 2011 12:52:32 +0200 Subject: build-sys: fixes to USAGE_* macros The USAGE_BEGIN_TAIL is removed as unnecessary. In between command specific options and --help & --version USAGE_SEPARATOR is inserted. For now the separator is empty line. The USAGE_MAN_TAIL is changed to take an argument. Signed-off-by: Sami Kerola --- Documentation/howto-usage-function.txt | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) (limited to 'Documentation/howto-usage-function.txt') diff --git a/Documentation/howto-usage-function.txt b/Documentation/howto-usage-function.txt index f717293d9..18ee3de86 100644 --- a/Documentation/howto-usage-function.txt +++ b/Documentation/howto-usage-function.txt @@ -56,6 +56,7 @@ Options: description on two, or multiple lines, where the consecutive lines are intended by two spaces -f, --foobar next option description resets indent + -h, --help display this help and exit -V, --version output version information and exit @@ -83,9 +84,8 @@ translation work. The argument, e.g. `arg', can be better. For example if an option is expecting number as argument a `num' is suitable argument description. -Order of the options has no special meaning. It is good idea to write -options that are somehow related next to each other. Usually --help and ---version, in this order, are last options in print out. +Order of the options has no special meaning, with a exception of --help and +--version which are expected to be last ones of the list. Last line of the usage print out is either empty, or a message informing about manual page. For example: `For more details see example(1).' In -- cgit v1.2.3-55-g7522