diff options
author | Junio C Hamano <gitster@pobox.com> | 2019-03-07 09:59:56 +0900 |
---|---|---|
committer | Junio C Hamano <gitster@pobox.com> | 2019-03-07 09:59:56 +0900 |
commit | 47e1019efd3a2977d1d92a3644817b0712d5d259 (patch) | |
tree | d9223e8d0ad43dc4d882d41ba2ba054e3da143cf | |
parent | Merge branch 'nd/split-index-null-base-fix' (diff) | |
parent | protocol-capabilities.txt: document symref (diff) | |
download | tgif-47e1019efd3a2977d1d92a3644817b0712d5d259.tar.xz |
Merge branch 'js/doc-symref-in-proto-v1'
Doc update.
* js/doc-symref-in-proto-v1:
protocol-capabilities.txt: document symref
-rw-r--r-- | Documentation/technical/protocol-capabilities.txt | 18 |
1 files changed, 18 insertions, 0 deletions
diff --git a/Documentation/technical/protocol-capabilities.txt b/Documentation/technical/protocol-capabilities.txt index 332d209b58..2b267c0da6 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] +doc. + 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. +symref +------ + +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. + shallow ------- |