summaryrefslogtreecommitdiff
path: root/Documentation/MyFirstContribution.txt
diff options
context:
space:
mode:
authorLibravatar Christian Couder <christian.couder@gmail.com>2019-06-22 08:10:35 +0200
committerLibravatar Junio C Hamano <gitster@pobox.com>2019-06-24 10:55:38 -0700
commitb37e0ec32b580d126ce9e5e706fd32b2edd8a9e9 (patch)
tree66c0d0cca459b73ad0ce2751ccf67680763fe45e /Documentation/MyFirstContribution.txt
parentdoc: add some nit fixes to MyFirstContribution (diff)
downloadtgif-b37e0ec32b580d126ce9e5e706fd32b2edd8a9e9.tar.xz
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". Helped-by: Emily Shaffer <emilyshaffer@google.com> Helped-by: Eric Sunshine <sunshine@sunshineco.com> Signed-off-by: Christian Couder <chriscool@tuxfamily.org> Signed-off-by: Junio C Hamano <gitster@pobox.com>
Diffstat (limited to 'Documentation/MyFirstContribution.txt')
-rw-r--r--Documentation/MyFirstContribution.txt12
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,
};
----