Skip to content

Commit 6373f57

Browse files
chriscoolgitster
authored andcommitted
doc: improve usage string in MyFirstContribution
We implement a command called git-psuh which accept arguments, so let's show that it accepts arguments in the doc and the usage string. While at it, we need to prepare "a NULL-terminated array of usage strings", not just "a NULL-terminated usage string". Signed-off-by: Christian Couder <[email protected]> Signed-off-by: Junio C Hamano <[email protected]>
1 parent 2656fb1 commit 6373f57

File tree

1 file changed

+7
-5
lines changed

1 file changed

+7
-5
lines changed

Documentation/MyFirstContribution.txt

Lines changed: 7 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -428,7 +428,7 @@ git-psuh - Delight users' typo with a shy horse
428428
SYNOPSIS
429429
--------
430430
[verse]
431-
'git-psuh'
431+
'git-psuh <arg>...'
432432

433433
DESCRIPTION
434434
-----------
@@ -491,14 +491,16 @@ Take a look at `Documentation/technical/api-parse-options.txt`. This is a handy
491491
tool for pulling out options you need to be able to handle, and it takes a
492492
usage string.
493493

494-
In order to use it, we'll need to prepare a NULL-terminated usage string and a
495-
`builtin_psuh_options` array. Add a line to `#include "parse-options.h"`.
494+
In order to use it, we'll need to prepare a NULL-terminated array of usage
495+
strings and a `builtin_psuh_options` array.
496496

497-
At global scope, add your usage:
497+
Add a line to `#include "parse-options.h"`.
498+
499+
At global scope, add your array of usage strings:
498500

499501
----
500502
static const char * const psuh_usage[] = {
501-
N_("git psuh"),
503+
N_("git psuh <arg>..."),
502504
NULL,
503505
};
504506
----

0 commit comments

Comments
 (0)