summaryrefslogtreecommitdiff
path: root/Documentation/git-ls-remote.txt
diff options
context:
space:
mode:
Diffstat (limited to 'Documentation/git-ls-remote.txt')
-rw-r--r--Documentation/git-ls-remote.txt28
1 files changed, 17 insertions, 11 deletions
diff --git a/Documentation/git-ls-remote.txt b/Documentation/git-ls-remote.txt
index 93e9a60330..7a9b86a58a 100644
--- a/Documentation/git-ls-remote.txt
+++ b/Documentation/git-ls-remote.txt
@@ -9,8 +9,8 @@ git-ls-remote - List references in a remote repository
SYNOPSIS
--------
[verse]
-'git-ls-remote' [--heads] [--tags] [-u <exec> | --upload-pack <exec>]
- <repository> <refs>...
+'git ls-remote' [--heads] [--tags] [-u <exec> | --upload-pack <exec>]
+ [--exit-code] <repository> [<refs>...]
DESCRIPTION
-----------
@@ -20,17 +20,27 @@ commit IDs.
OPTIONS
-------
--h|--heads, -t|--tags::
+-h::
+--heads::
+-t::
+--tags::
Limit to only refs/heads and refs/tags, respectively.
These options are _not_ mutually exclusive; when given
both, references stored in refs/heads and refs/tags are
displayed.
--u <exec>, --upload-pack=<exec>::
- Specify the full path of gitlink:git-upload-pack[1] on the remote
+-u <exec>::
+--upload-pack=<exec>::
+ Specify the full path of 'git-upload-pack' on the remote
host. This allows listing references from repositories accessed via
SSH and where the SSH daemon does not use the PATH configured by the
- user. Also see the '--exec' option for gitlink:git-peek-remote[1].
+ user.
+
+--exit-code::
+ Exit with status "2" when no matching refs are found in the remote
+ repository. Usually the command exits with status "0" to indicate
+ it successfully talked with the remote repository, whether it
+ found any matching refs.
<repository>::
Location of the repository. The shorthand defined in
@@ -63,10 +73,6 @@ EXAMPLES
c5db5456ae3b0873fc659c19fafdde22313cc441 refs/tags/v0.99.2
7ceca275d047c90c0c7d5afb13ab97efdf51bd6e refs/tags/v0.99.3
-Author
-------
-Written by Junio C Hamano <junkio@cox.net>
-
GIT
---
-Part of the gitlink:git[7] suite
+Part of the linkgit:git[1] suite