mirror of
https://github.com/git/git
synced 2024-10-03 23:29:36 +00:00
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>
This commit is contained in:
parent
a5b076321a
commit
51f9d2e563
|
@ -96,9 +96,35 @@ OPTIONS
|
|||
separator (so `bar` matches `refs/heads/bar` but not
|
||||
`refs/heads/foobar`).
|
||||
|
||||
OUTPUT
|
||||
------
|
||||
|
||||
The output is in the format:
|
||||
|
||||
------------
|
||||
<oid> TAB <ref> LF
|
||||
------------
|
||||
|
||||
When showing an annotated tag, unless `--refs` is given, two such
|
||||
lines are shown: one with the refname for the tag itself as `<ref>`,
|
||||
and another with `<ref>` followed by `^{}`. The `<oid>` on the latter
|
||||
line shows the name of the object the tag points at.
|
||||
|
||||
EXAMPLES
|
||||
--------
|
||||
|
||||
* List all references (including symbolics and pseudorefs), peeling
|
||||
tags:
|
||||
+
|
||||
----
|
||||
$ git ls-remote
|
||||
27d43aaaf50ef0ae014b88bba294f93658016a2e HEAD
|
||||
950264636c68591989456e3ba0a5442f93152c1a refs/heads/main
|
||||
d9ab777d41f92a8c1684c91cfb02053d7dd1046b refs/heads/next
|
||||
d4ca2e3147b409459955613c152220f4db848ee1 refs/tags/v2.40.0
|
||||
73876f4861cd3d187a4682290ab75c9dccadbc56 refs/tags/v2.40.0^{}
|
||||
----
|
||||
|
||||
* List all references matching given patterns:
|
||||
+
|
||||
----
|
||||
|
|
Loading…
Reference in a new issue