docs: add program-desc to howto-usage-function.txt and boilerplate.c

Signed-off-by: Karel Zak <kzak@redhat.com>

diff --git a/Documentation/boilerplate.c b/Documentation/boilerplate.c
index 057893bfb3c85428ef66fa3526b8646fa53f6bd3..5b2e59b8a3ecd1e78bf2e60f8335c74700b20c17 100644 (file)
--- a/Documentation/boilerplate.c
+++ b/Documentation/boilerplate.c
@@ -33,6 +33,10 @@ static void __attribute__((__noreturn__)) usage(FILE *out)
 {
        fputs(USAGE_HEADER, out);
        fprintf(out, _(" %s [options] file...\n"), program_invocation_short_name);
+
+        fputs(USAGE_SEPARATOR, out);
+        fputs(_("Short program description.\n"), out);
+
        fputs(USAGE_FUNCTIONS, out);
        fputs(_(" -s, --do-something      some specific task\n"), out);
        fputs(_(" -o, --do-other          some different task\n"), out);

diff --git a/Documentation/howto-usage-function.txt b/Documentation/howto-usage-function.txt
index 8da8debe5f3cb3320008c48e94bcd30804bb03f1..3496b49149044d1603e88d9e9a3367be8fcc608e 100644 (file)
--- a/Documentation/howto-usage-function.txt
+++ b/Documentation/howto-usage-function.txt
@@ -42,6 +42,8 @@ look like.
 Usage:
  program [options] <file> [...]
 
+Short program description, ideally one line only.
+
 Options:
  -n, --no-argument       option does not use argument
      --optional[=<arg>]  option argument is optional