Skip to content

Commit

Permalink
ls-remote: document the '--get-url' option
Browse files Browse the repository at this point in the history
While looking for a way to expand the URL of a remote
that uses a 'url.<name>.insteadOf' config option I stumbled
over the undocumented '--get-url' option of 'git ls-remote'.
This adds some minimum documentation for that option.

And while at it, also add that option to the '-h' output.

Signed-off-by: Stefan Naewe <stefan.naewe@gmail.com>
Signed-off-by: Junio C Hamano <gitster@pobox.com>
  • Loading branch information
snaewe authored and gitster committed Sep 7, 2012
1 parent d0f1ea6 commit 2303cad
Show file tree
Hide file tree
Showing 2 changed files with 6 additions and 1 deletion.
5 changes: 5 additions & 0 deletions Documentation/git-ls-remote.txt
Original file line number Diff line number Diff line change
Expand Up @@ -42,6 +42,11 @@ OPTIONS
it successfully talked with the remote repository, whether it
found any matching refs.

--get-url::
Expand the URL of the given remote repository taking into account any
"url.<base>.insteadOf" config setting (See linkgit:git-config[1]) and
exit without talking to the remote.

<repository>::
Location of the repository. The shorthand defined in
$GIT_DIR/branches/ can be used. Use "." (dot) to list references in
Expand Down
2 changes: 1 addition & 1 deletion builtin/ls-remote.c
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@

static const char ls_remote_usage[] =
"git ls-remote [--heads] [--tags] [-u <exec> | --upload-pack <exec>]\n"
" [-q|--quiet] [--exit-code] [<repository> [<refs>...]]";
" [-q|--quiet] [--exit-code] [--get-url] [<repository> [<refs>...]]";

/*
* Is there one among the list of patterns that match the tail part
Expand Down

0 comments on commit 2303cad

Please sign in to comment.