undef/git-commit-vandalism
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Merge branch 'cc/first-contrib-tutorial'

Browse Source 
Update docs used in a tutorial.

* cc/first-contrib-tutorial:
  doc: improve usage string in MyFirstContribution
This commit is contained in:
Junio C Hamano 2019-07-09 15:25:44 -07:00
commit 3e6c6b7787
1 changed files with 7 additions and 5 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

12
Documentation/MyFirstContribution.txt
View File

@ -428,7 +428,7 @@ git-psuh - Delight users' typo with a shy horse
SYNOPSIS SYNOPSIS
-------- --------
[verse] [verse]
'git-psuh' 'git-psuh [<arg>...]'
DESCRIPTION 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 tool for pulling out options you need to be able to handle, and it takes a
usage string. usage string.
In order to use it, we'll need to prepare a NULL-terminated usage string and a In order to use it, we'll need to prepare a NULL-terminated array of usage
`builtin_psuh_options` array. Add a line to `#include "parse-options.h"`. 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[] = { static const char * const psuh_usage[] = {
N_("git psuh"), N_("git psuh [<arg>...]"),
NULL, NULL,
}; };
---- ----