ls-remote doc: document the output format
While well-established, the output format of ls-remote was not actually documented. This patch adds an OUTPUT section to the documentation following the format of git-show-ref.txt (which has similar semantics). Add a basic example immediately after this to solidify the 'normal' output format. 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
51f9d2e56306deeb547c7d62e46598df2d285fe3
1 file changed
+26
Documentation/git-ls-remote.txt
+26
@@ -96,9 +96,35 @@ OPTIONS
96
separator (so `bar` matches `refs/heads/bar` but not
97
`refs/heads/foobar`).
98
99
+OUTPUT
100
+------
101
+
102
+The output is in the format:
103
+
104
+------------
105
+<oid> TAB <ref> LF
106
+------------
107
+
108
+When showing an annotated tag, unless `--refs` is given, two such
109
+lines are shown: one with the refname for the tag itself as `<ref>`,
110
+and another with `<ref>` followed by `^{}`. The `<oid>` on the latter
111
+line shows the name of the object the tag points at.
112
+
113
EXAMPLES
114
--------
115
116
+* List all references (including symbolics and pseudorefs), peeling
117
+ tags:
118
++
119
+----
120
+$ git ls-remote
121
+27d43aaaf50ef0ae014b88bba294f93658016a2e HEAD
122
+950264636c68591989456e3ba0a5442f93152c1a refs/heads/main
123
+d9ab777d41f92a8c1684c91cfb02053d7dd1046b refs/heads/next
124
+d4ca2e3147b409459955613c152220f4db848ee1 refs/tags/v2.40.0
125
+73876f4861cd3d187a4682290ab75c9dccadbc56 refs/tags/v2.40.0^{}
126
+----
127
+
128
* List all references matching given patterns:
129
+
130
----