Sometimes it's useful to know the main branch of a git repository
without actually downloading the repository. This can be done by
looking at the symrefs stored in the remote repository. Currently git
doesn't provide a simple way to show the symrefs stored on the remote
repository, even though the information is available. Add a --symrefs
command line argument to the ls-remote command, which shows the symrefs
on the remote repository.
The new argument works similar to the --heads and --tags arguments.
When only --symrefs is given, only the symrefs are shown. It can
however be combined with the --refs, --heads or --tags arguments, to
show all refs, heads, or tags as well.
Suggested-by: pedro rijo <pedrorijo91@xxxxxxxxx>
Signed-off-by: Thomas Gummerer <t.gummerer@xxxxxxxxx>
---
Documentation/git-ls-remote.txt | 8 +++++++-
builtin/ls-remote.c | 9 ++++++++-
t/t5512-ls-remote.sh | 20 ++++++++++++++++++++
3 files changed, 35 insertions(+), 2 deletions(-)
diff --git a/Documentation/git-ls-remote.txt b/Documentation/git-ls-remote.txt
index 31c1427..5b606dd 100644
--- a/Documentation/git-ls-remote.txt
+++ b/Documentation/git-ls-remote.txt
@@ -10,7 +10,8 @@ SYNOPSIS
--------
[verse]
'git ls-remote' [--heads] [--tags] [--upload-pack=<exec>]
- [-q | --quiet] [--exit-code] [--get-url] [<repository> [<refs>...]]
+ [-q | --quiet] [--exit-code] [--get-url]
+ [--symrefs] [<repository> [<refs>...]]
DESCRIPTION
-----------
@@ -50,6 +51,11 @@ OPTIONS
"url.<base>.insteadOf" config setting (See linkgit:git-config[1]) and
exit without talking to the remote.
+--symrefs::
+ Show the symrefs on the server. Shows only the symrefs by
+ default, and can be combined with --tags and --heads to show
+ refs/heads and refs/tags as well.
+
<repository>::
The "remote" repository to query. This parameter can be
either a URL or the name of a remote (see the GIT URLS and
diff --git a/builtin/ls-remote.c b/builtin/ls-remote.c
index 6ee7b0e..f33ada9 100644
--- a/builtin/ls-remote.c
+++ b/builtin/ls-remote.c
@@ -5,7 +5,8 @@
static const char * const ls_remote_usage[] = {
N_("git ls-remote [--heads] [--tags] [--upload-pack=<exec>]\n"
- " [-q | --quiet] [--exit-code] [--get-url] [<repository> [<refs>...]]"),
+ " [-q | --quiet] [--exit-code] [--get-url]\n"
+ " [--symrefs] [<repository> [<refs>...]]"),
NULL
};
@@ -38,6 +39,7 @@ int cmd_ls_remote(int argc, const char **argv, const char *prefix)
int quiet = 0;
int status = 0;
int tags = 0, heads = 0, refs = 0;
+ int symrefs = 0;
const char *uploadpack = NULL;
const char **pattern = NULL;
@@ -58,6 +60,7 @@ int cmd_ls_remote(int argc, const char **argv, const char *prefix)
N_("take url.<base>.insteadOf into account"), 1),
OPT_SET_INT(0, "exit-code", &status,
N_("exit with exit code 2 if no matching refs are found"), 2),
+ OPT_BOOL(0, "symrefs", &symrefs, N_("show symrefs")),
OPT_END()
};
@@ -98,6 +101,10 @@ int cmd_ls_remote(int argc, const char **argv, const char *prefix)
if (!dest && !quiet)
fprintf(stderr, "From %s\n", *remote->url);
for ( ; ref; ref = ref->next) {
+ if (symrefs && ref->symref)
+ printf("symref: %s %s\n", ref->symref, ref->name);
+ if (symrefs && !flags)
+ continue;
if (!check_ref_type(ref, flags))
continue;
if (!tail_match(pattern, ref->name))
diff --git a/t/t5512-ls-remote.sh b/t/t5512-ls-remote.sh
index aadaac5..68a1429 100755
--- a/t/t5512-ls-remote.sh
+++ b/t/t5512-ls-remote.sh
@@ -163,4 +163,24 @@ test_expect_success 'overrides work between mixed transfer/upload-pack hideRefs'
grep refs/tags/magic actual
'
+test_expect_success 'ls-remote --symrefs' '
+ cat >expect <<-EOF &&
+ symref: refs/heads/master HEAD
+ EOF
+ git ls-remote --symrefs >actual &&
+ test_cmp expect actual
+'
+
+test_expect_success 'ls-remote with symrefs and refs combined' '
+ cat >expect <<-EOF &&
+ symref: refs/heads/master HEAD
+ 1bd44cb9d13204b0fe1958db0082f5028a16eb3a refs/heads/master
+ 1bd44cb9d13204b0fe1958db0082f5028a16eb3a refs/remotes/origin/HEAD
+ 1bd44cb9d13204b0fe1958db0082f5028a16eb3a refs/remotes/origin/master
+ 1bd44cb9d13204b0fe1958db0082f5028a16eb3a refs/tags/mark
+ EOF
+ git ls-remote --symrefs --refs >actual &&
+ test_cmp expect actual
+'
+
test_done
--
2.7.0.14.g2b6d3d6
--
To unsubscribe from this list: send the line "unsubscribe git" in
the body of a message to majordomo@xxxxxxxxxxxxxxx
More majordomo info at http://vger.kernel.org/majordomo-info.html