Skip to content

Commit

Permalink
Update doc about get command
Browse files Browse the repository at this point in the history
Add description about `get` with `-p` option.
This option introduced by x-motemen#7 .
  • Loading branch information
tricknotes committed Jun 6, 2014
1 parent 3877ce9 commit b39bf28
Show file tree
Hide file tree
Showing 2 changed files with 3 additions and 1 deletion.
1 change: 1 addition & 0 deletions commands.go
Original file line number Diff line number Diff line change
Expand Up @@ -29,6 +29,7 @@ var commandGet = cli.Command{
Clone a GitHub repository under ghq root direcotry. If the repository is
already cloned to local, nothing will happen unless '-u' ('--update')
flag is supplied, in which case 'git remote update' is executed.
When you use '-p' option, the repository is cloned via SSH.
`,
Action: doGet,
Flags: []cli.Flag{
Expand Down
3 changes: 2 additions & 1 deletion ghq.txt
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@ You can also list local repositories (+ghq list+), jump into local repositories
== SYNOPSIS

[verse]
'ghq' get [-u] <repository URL> | <user>/<project>
'ghq' get [-u] <repository URL> | [-u] [-p] <user>/<project>
'ghq' list [-p] [-e] [<query>]
'ghq' look <project> | <user>/<project> | <host>/<user>/<project>
'ghq' import starred [-u] <user>
Expand All @@ -29,6 +29,7 @@ get::
<<directory-structures,DIRECTORY STRUCTURES>> below. If the repository is
already cloned to local, nothing will happen unless '-u' ('--update')
flag is supplied, in which case 'git remote update' is executed. +
When you use '-p' option, the repository is cloned via SSH. +
If there are multiple +ghq.root+ 's, existing local clones are searched
first. Then a new repository clone is created under the primary root if
none is found. +
Expand Down

0 comments on commit b39bf28

Please sign in to comment.