ls-remote: document --refs option

The --refs option was originally introduced in 2718ff0 ("Improve
git-peek-remote").  The ls-remote command was first documented in
972b6fe ("ls-remote: drop storing operation and add documentation."),
but the --refs option was never documented.  Fix this.

Signed-off-by: Thomas Gummerer <t.gummerer@gmail.com>
Signed-off-by: Junio C Hamano <gitster@pobox.com>

diff --git a/Documentation/git-ls-remote.txt b/Documentation/git-ls-remote.txt
index 27380de2a5c4200d6e49e699e225bbd61b3f5415..7467162adce6e73c0770d096fbbc6ad0091a9167 100644 (file)
--- a/Documentation/git-ls-remote.txt
+++ b/Documentation/git-ls-remote.txt
@@ -9,7 +9,7 @@ git-ls-remote - List references in a remote repository
 SYNOPSIS
 --------
 [verse]
 SYNOPSIS
 --------
 [verse]

-'git ls-remote' [--heads] [--tags]  [--upload-pack=<exec>]
+'git ls-remote' [--heads] [--tags] [--refs] [--upload-pack=<exec>]

              [-q | --quiet] [--exit-code] <repository> [<refs>...]
 
 DESCRIPTION
              [-q | --quiet] [--exit-code] <repository> [<refs>...]
 
 DESCRIPTION


@@ -29,6 +29,9 @@ OPTIONS
        both, references stored in refs/heads and refs/tags are
        displayed.
 
        both, references stored in refs/heads and refs/tags are
        displayed.
 

+--refs::
+       Do not show peeled tags or pseudorefs like HEAD in the output.
+

 -q::
 --quiet::
        Do not print remote URL to stderr.
 -q::
 --quiet::
        Do not print remote URL to stderr.

diff --git a/builtin/ls-remote.c b/builtin/ls-remote.c
index fa65a8448aadcb2d26613867cab7822e02e4853c..db21e52f359b6266f148932b1bacebc184486f9a 100644 (file)
--- a/builtin/ls-remote.c
+++ b/builtin/ls-remote.c
@@ -4,7 +4,7 @@
 #include "remote.h"
 
 static const char ls_remote_usage[] =
 #include "remote.h"
 
 static const char ls_remote_usage[] =

-"git ls-remote [--heads] [--tags]  [--upload-pack=<exec>]\n"
+"git ls-remote [--heads] [--tags] [--refs] [--upload-pack=<exec>]\n"

 "                     [-q | --quiet] [--exit-code] [--get-url] [<repository> [<refs>...]]";
 
 /*
 "                     [-q | --quiet] [--exit-code] [--get-url] [<repository> [<refs>...]]";
 
 /*