diff options
authorJunio C Hamano <>2019-03-07 00:59:56 (GMT)
committerJunio C Hamano <>2019-03-07 00:59:56 (GMT)
commit47e1019efd3a2977d1d92a3644817b0712d5d259 (patch)
parent0efa3d74e705ed2c66c33854ac4bfd0d6c7f56de (diff)
parent90503a240bc126adc8cddb7b860e19c30b0dfa6f (diff)
Merge branch 'js/doc-symref-in-proto-v1'
Doc update. * js/doc-symref-in-proto-v1: protocol-capabilities.txt: document symref
1 files changed, 18 insertions, 0 deletions
diff --git a/Documentation/technical/protocol-capabilities.txt b/Documentation/technical/protocol-capabilities.txt
index 332d209..2b267c0 100644
--- a/Documentation/technical/protocol-capabilities.txt
+++ b/Documentation/technical/protocol-capabilities.txt
@@ -1,6 +1,10 @@
Git Protocol Capabilities
+NOTE: this document describes capabilities for versions 0 and 1 of the pack
+protocol. For version 2, please refer to the link:protocol-v2.html[protocol-v2]
Servers SHOULD support all capabilities defined in this document.
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
purposes, and MUST NOT be used to programmatically assume the presence
or absence of particular features.
+This parameterized capability is used to inform the receiver which symbolic ref
+points to which ref; for example, "symref=HEAD:refs/heads/master" tells the
+receiver that HEAD points to master. This capability can be repeated to
+represent multiple symrefs.
+Servers SHOULD include this capability for the HEAD symref if it is one of the
+refs being sent.
+Clients MAY use the parameters from this capability to select the proper initial
+branch when cloning a repository.