ls-remote doc: explain what each example does
While it's good to have several examples to solidify the output pattern and generally demonstrate how to use the command, most other EXAMPLES sections (e.g., git-show-branch.txt, git-remote.txt) additionally describe the problem/situation to which the example is applicable. Follow this example in the ls-remote documentation. Signed-off-by: Sean Allred <allred.sean@gmail.com> Signed-off-by: Junio C Hamano <gitster@pobox.com>
Sean Allred committed
May 19, 2023 at 04:17 UTC
a5b076321a4fe19fd25a3192304cb88abf9aefbf
1 file changed
+7
-2
Documentation/git-ls-remote.txt
+7
-2
@@ -99,13 +99,18 @@ OPTIONS
99
EXAMPLES
100
--------
101
102
+* List all references matching given patterns:
103
++
104
----
105
$ git ls-remote http://www.kernel.org/pub/scm/git/git.git master seen rc
106
5fe978a5381f1fbad26a80e682ddd2a401966740 refs/heads/master
107
c781a84b5204fb294c9ccc79f8b3baceeb32c061 refs/heads/seen
108
+----
109
107
-$ git remote add korg http://www.kernel.org/pub/scm/git/git.git
108
-$ git ls-remote --tags korg v\*
110
+* List only tags matching a given wildcard pattern:
111
++
112
+----
113
+$ git ls-remote --tags http://www.kernel.org/pub/scm/git/git.git v\*
114
485a869c64a68cc5795dd99689797c5900f4716d refs/tags/v2.39.2
115
cbf04937d5b9fcf0a76c28f69e6294e9e3ecd7e6 refs/tags/v2.39.2^{}
116
d4ca2e3147b409459955613c152220f4db848ee1 refs/tags/v2.40.0