diff options
| author | Karel Zak | 2017-06-21 11:25:55 +0200 |
|---|---|---|
| committer | Karel Zak | 2017-06-21 11:25:55 +0200 |
| commit | 9e258f388a92817aeaef9ec42909bf63470d0454 (patch) | |
| tree | 91b509ca2eedae5581bcb42b4af8b2fdba2ab88b /Documentation | |
| parent | hwclock: remove unwanted space before description (diff) | |
| download | kernel-qcow2-util-linux-9e258f388a92817aeaef9ec42909bf63470d0454.tar.gz kernel-qcow2-util-linux-9e258f388a92817aeaef9ec42909bf63470d0454.tar.xz kernel-qcow2-util-linux-9e258f388a92817aeaef9ec42909bf63470d0454.zip | |
docs: add program-desc to howto-usage-function.txt and boilerplate.c
Signed-off-by: Karel Zak <kzak@redhat.com>
Diffstat (limited to 'Documentation')
| -rw-r--r-- | Documentation/boilerplate.c | 4 | ||||
| -rw-r--r-- | Documentation/howto-usage-function.txt | 2 |
2 files changed, 6 insertions, 0 deletions
diff --git a/Documentation/boilerplate.c b/Documentation/boilerplate.c index 057893bfb..5b2e59b8a 100644 --- 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 8da8debe5..3496b4914 100644 --- 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 |