diff options
| author |  Junio C Hamano <gitster@pobox.com> | 2019-07-09 15:25:44 -0700 |
|---|---|---|
| committer | Junio C Hamano <gitster@pobox.com> | 2019-07-09 15:25:44 -0700 |
| commit | 3e6c6b7787b66116f1533043c2e2cf840c6d0f3e (patch) | |
| tree | 3e21c3931b078af1701d830afcb47f94203c0193 /Documentation | |
| parent | Merge branch 'ab/fail-prereqs-in-test' (diff) | |
| parent | doc: improve usage string in MyFirstContribution (diff) | |
| download | tgif-3e6c6b7787b66116f1533043c2e2cf840c6d0f3e.tar.xz | |
Merge branch 'cc/first-contrib-tutorial'
Update docs used in a tutorial.
* cc/first-contrib-tutorial:
doc: improve usage string in MyFirstContribution
Diffstat (limited to 'Documentation')
| -rw-r--r-- | Documentation/MyFirstContribution.txt | 12 |
1 files changed, 7 insertions, 5 deletions
diff --git a/Documentation/MyFirstContribution.txt b/Documentation/MyFirstContribution.txt index 895b7cfd4f..f8670379c0 100644 --- a/Documentation/MyFirstContribution.txt +++ b/Documentation/MyFirstContribution.txt @@ -428,7 +428,7 @@ git-psuh - Delight users' typo with a shy horse SYNOPSIS -------- [verse] -'git-psuh' +'git-psuh [<arg>...]' DESCRIPTION ----------- @@ -491,14 +491,16 @@ Take a look at `Documentation/technical/api-parse-options.txt`. This is a handy tool for pulling out options you need to be able to handle, and it takes a usage string. -In order to use it, we'll need to prepare a NULL-terminated usage string and a -`builtin_psuh_options` array. Add a line to `#include "parse-options.h"`. +In order to use it, we'll need to prepare a NULL-terminated array of usage +strings and a `builtin_psuh_options` array. -At global scope, add your usage: +Add a line to `#include "parse-options.h"`. + +At global scope, add your array of usage strings: ---- static const char * const psuh_usage[] = { - N_("git psuh"), + N_("git psuh [<arg>...]"), NULL, }; ---- |