Skip to content

Commit 47e1019

Browse files
committed
Merge branch 'js/doc-symref-in-proto-v1'
Doc update. * js/doc-symref-in-proto-v1: protocol-capabilities.txt: document symref
2 parents 0efa3d7 + 90503a2 commit 47e1019

File tree

1 file changed

+18
-0
lines changed

1 file changed

+18
-0
lines changed

Documentation/technical/protocol-capabilities.txt

Lines changed: 18 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,10 @@
11
Git Protocol Capabilities
22
=========================
33

4+
NOTE: this document describes capabilities for versions 0 and 1 of the pack
5+
protocol. For version 2, please refer to the link:protocol-v2.html[protocol-v2]
6+
doc.
7+
48
Servers SHOULD support all capabilities defined in this document.
59

610
On the very first line of the initial server response of either
@@ -172,6 +176,20 @@ agent strings are purely informative for statistics and debugging
172176
purposes, and MUST NOT be used to programmatically assume the presence
173177
or absence of particular features.
174178

179+
symref
180+
------
181+
182+
This parameterized capability is used to inform the receiver which symbolic ref
183+
points to which ref; for example, "symref=HEAD:refs/heads/master" tells the
184+
receiver that HEAD points to master. This capability can be repeated to
185+
represent multiple symrefs.
186+
187+
Servers SHOULD include this capability for the HEAD symref if it is one of the
188+
refs being sent.
189+
190+
Clients MAY use the parameters from this capability to select the proper initial
191+
branch when cloning a repository.
192+
175193
shallow
176194
-------
177195

0 commit comments

Comments
 (0)