Google Git
Sign in
chromium / external / gitster / git-htmldocs / ca8e07cd1946b3cef21a33dedcd5794a1e119cc0 / . / gitprotocol-capabilities.html
blob: da0b9b6725ac65972307528a9a622605ee48534e [file] [log] [blame]
Junio C Hamanob96f40a2024-08-01 00:57:25[diff] [blame]1<!DOCTYPE html>
2<html xmlns="http://www.w3.org/1999/xhtml" lang="en">
3<head>
4<meta charset="UTF-8"/>
5<meta http-equiv="X-UA-Compatible" content="IE=edge"/>
6<meta name="viewport" content="width=device-width, initial-scale=1.0"/>
Junio C Hamanod6a33e42025-02-18 23:45:11[diff] [blame]7<meta name="generator" content="Asciidoctor 2.0.23"/>
Junio C Hamanob96f40a2024-08-01 00:57:25[diff] [blame]8<title>gitprotocol-capabilities(5)</title>
9<link rel="stylesheet" href="https://fonts.googleapis.com/css?family=Open+Sans:300,300italic,400,400italic,600,600italic%7CNoto+Serif:400,400italic,700,700italic%7CDroid+Sans+Mono:400,700"/>
10<style>
11/*! Asciidoctor default stylesheet | MIT License | https://asciidoctor.org */
12/* Uncomment the following line when using as a custom stylesheet */
13/* @import "https://fonts.googleapis.com/css?family=Open+Sans:300,300italic,400,400italic,600,600italic%7CNoto+Serif:400,400italic,700,700italic%7CDroid+Sans+Mono:400,700"; */
14html{font-family:sans-serif;-webkit-text-size-adjust:100%}
15a{background:none}
16a:focus{outline:thin dotted}
17a:active,a:hover{outline:0}
18h1{font-size:2em;margin:.67em 0}
19b,strong{font-weight:bold}
20abbr{font-size:.9em}
21abbr[title]{cursor:help;border-bottom:1px dotted #dddddf;text-decoration:none}
22dfn{font-style:italic}
23hr{height:0}
24mark{background:#ff0;color:#000}
25code,kbd,pre,samp{font-family:monospace;font-size:1em}
26pre{white-space:pre-wrap}
27q{quotes:"\201C" "\201D" "\2018" "\2019"}
28small{font-size:80%}
29sub,sup{font-size:75%;line-height:0;position:relative;vertical-align:baseline}
30sup{top:-.5em}
31sub{bottom:-.25em}
32img{border:0}
33svg:not(:root){overflow:hidden}
34figure{margin:0}
35audio,video{display:inline-block}
36audio:not([controls]){display:none;height:0}
37fieldset{border:1px solid silver;margin:0 2px;padding:.35em .625em .75em}
38legend{border:0;padding:0}
39button,input,select,textarea{font-family:inherit;font-size:100%;margin:0}
40button,input{line-height:normal}
41button,select{text-transform:none}
42button,html input[type=button],input[type=reset],input[type=submit]{-webkit-appearance:button;cursor:pointer}
43button[disabled],html input[disabled]{cursor:default}
44input[type=checkbox],input[type=radio]{padding:0}
45button::-moz-focus-inner,input::-moz-focus-inner{border:0;padding:0}
46textarea{overflow:auto;vertical-align:top}
47table{border-collapse:collapse;border-spacing:0}
48*,::before,::after{box-sizing:border-box}
49html,body{font-size:100%}
50body{background:#fff;color:rgba(0,0,0,.8);padding:0;margin:0;font-family:"Noto Serif","DejaVu Serif",serif;line-height:1;position:relative;cursor:auto;-moz-tab-size:4;-o-tab-size:4;tab-size:4;word-wrap:anywhere;-moz-osx-font-smoothing:grayscale;-webkit-font-smoothing:antialiased}
51a:hover{cursor:pointer}
52img,object,embed{max-width:100%;height:auto}
53object,embed{height:100%}
54img{-ms-interpolation-mode:bicubic}
55.left{float:left!important}
56.right{float:right!important}
57.text-left{text-align:left!important}
58.text-right{text-align:right!important}
59.text-center{text-align:center!important}
60.text-justify{text-align:justify!important}
61.hide{display:none}
62img,object,svg{display:inline-block;vertical-align:middle}
63textarea{height:auto;min-height:50px}
64select{width:100%}
65.subheader,.admonitionblock td.content>.title,.audioblock>.title,.exampleblock>.title,.imageblock>.title,.listingblock>.title,.literalblock>.title,.stemblock>.title,.openblock>.title,.paragraph>.title,.quoteblock>.title,table.tableblock>.title,.verseblock>.title,.videoblock>.title,.dlist>.title,.olist>.title,.ulist>.title,.qlist>.title,.hdlist>.title{line-height:1.45;color:#7a2518;font-weight:400;margin-top:0;margin-bottom:.25em}
66div,dl,dt,dd,ul,ol,li,h1,h2,h3,#toctitle,.sidebarblock>.content>.title,h4,h5,h6,pre,form,p,blockquote,th,td{margin:0;padding:0}
67a{color:#2156a5;text-decoration:underline;line-height:inherit}
68a:hover,a:focus{color:#1d4b8f}
69a img{border:0}
70p{line-height:1.6;margin-bottom:1.25em;text-rendering:optimizeLegibility}
71p aside{font-size:.875em;line-height:1.35;font-style:italic}
72h1,h2,h3,#toctitle,.sidebarblock>.content>.title,h4,h5,h6{font-family:"Open Sans","DejaVu Sans",sans-serif;font-weight:300;font-style:normal;color:#ba3925;text-rendering:optimizeLegibility;margin-top:1em;margin-bottom:.5em;line-height:1.0125em}
73h1 small,h2 small,h3 small,#toctitle small,.sidebarblock>.content>.title small,h4 small,h5 small,h6 small{font-size:60%;color:#e99b8f;line-height:0}
74h1{font-size:2.125em}
75h2{font-size:1.6875em}
76h3,#toctitle,.sidebarblock>.content>.title{font-size:1.375em}
77h4,h5{font-size:1.125em}
78h6{font-size:1em}
79hr{border:solid #dddddf;border-width:1px 0 0;clear:both;margin:1.25em 0 1.1875em}
80em,i{font-style:italic;line-height:inherit}
81strong,b{font-weight:bold;line-height:inherit}
82small{font-size:60%;line-height:inherit}
83code{font-family:"Droid Sans Mono","DejaVu Sans Mono",monospace;font-weight:400;color:rgba(0,0,0,.9)}
84ul,ol,dl{line-height:1.6;margin-bottom:1.25em;list-style-position:outside;font-family:inherit}
85ul,ol{margin-left:1.5em}
86ul li ul,ul li ol{margin-left:1.25em;margin-bottom:0}
87ul.circle{list-style-type:circle}
88ul.disc{list-style-type:disc}
89ul.square{list-style-type:square}
90ul.circle ul:not([class]),ul.disc ul:not([class]),ul.square ul:not([class]){list-style:inherit}
91ol li ul,ol li ol{margin-left:1.25em;margin-bottom:0}
92dl dt{margin-bottom:.3125em;font-weight:bold}
93dl dd{margin-bottom:1.25em}
94blockquote{margin:0 0 1.25em;padding:.5625em 1.25em 0 1.1875em;border-left:1px solid #ddd}
95blockquote,blockquote p{line-height:1.6;color:rgba(0,0,0,.85)}
96@media screen and (min-width:768px){h1,h2,h3,#toctitle,.sidebarblock>.content>.title,h4,h5,h6{line-height:1.2}
97h1{font-size:2.75em}
98h2{font-size:2.3125em}
99h3,#toctitle,.sidebarblock>.content>.title{font-size:1.6875em}
100h4{font-size:1.4375em}}
101table{background:#fff;margin-bottom:1.25em;border:1px solid #dedede;word-wrap:normal}
102table thead,table tfoot{background:#f7f8f7}
103table thead tr th,table thead tr td,table tfoot tr th,table tfoot tr td{padding:.5em .625em .625em;font-size:inherit;color:rgba(0,0,0,.8);text-align:left}
104table tr th,table tr td{padding:.5625em .625em;font-size:inherit;color:rgba(0,0,0,.8)}
105table tr.even,table tr.alt{background:#f8f8f7}
106table thead tr th,table tfoot tr th,table tbody tr td,table tr td,table tfoot tr td{line-height:1.6}
107h1,h2,h3,#toctitle,.sidebarblock>.content>.title,h4,h5,h6{line-height:1.2;word-spacing:-.05em}
108h1 strong,h2 strong,h3 strong,#toctitle strong,.sidebarblock>.content>.title strong,h4 strong,h5 strong,h6 strong{font-weight:400}
109.center{margin-left:auto;margin-right:auto}
110.stretch{width:100%}
111.clearfix::before,.clearfix::after,.float-group::before,.float-group::after{content:" ";display:table}
112.clearfix::after,.float-group::after{clear:both}
113:not(pre).nobreak{word-wrap:normal}
114:not(pre).nowrap{white-space:nowrap}
115:not(pre).pre-wrap{white-space:pre-wrap}
116:not(pre):not([class^=L])>code{font-size:.9375em;font-style:normal!important;letter-spacing:0;padding:.1em .5ex;word-spacing:-.15em;background:#f7f7f8;border-radius:4px;line-height:1.45;text-rendering:optimizeSpeed}
117pre{color:rgba(0,0,0,.9);font-family:"Droid Sans Mono","DejaVu Sans Mono",monospace;line-height:1.45;text-rendering:optimizeSpeed}
118pre code,pre pre{color:inherit;font-size:inherit;line-height:inherit}
119pre>code{display:block}
120pre.nowrap,pre.nowrap pre{white-space:pre;word-wrap:normal}
121em em{font-style:normal}
122strong strong{font-weight:400}
123.keyseq{color:rgba(51,51,51,.8)}
124kbd{font-family:"Droid Sans Mono","DejaVu Sans Mono",monospace;display:inline-block;color:rgba(0,0,0,.8);font-size:.65em;line-height:1.45;background:#f7f7f7;border:1px solid #ccc;border-radius:3px;box-shadow:0 1px 0 rgba(0,0,0,.2),inset 0 0 0 .1em #fff;margin:0 .15em;padding:.2em .5em;vertical-align:middle;position:relative;top:-.1em;white-space:nowrap}
125.keyseq kbd:first-child{margin-left:0}
126.keyseq kbd:last-child{margin-right:0}
127.menuseq,.menuref{color:#000}
128.menuseq b:not(.caret),.menuref{font-weight:inherit}
129.menuseq{word-spacing:-.02em}
130.menuseq b.caret{font-size:1.25em;line-height:.8}
131.menuseq i.caret{font-weight:bold;text-align:center;width:.45em}
132b.button::before,b.button::after{position:relative;top:-1px;font-weight:400}
133b.button::before{content:"[";padding:0 3px 0 2px}
134b.button::after{content:"]";padding:0 2px 0 3px}
135p a>code:hover{color:rgba(0,0,0,.9)}
136#header,#content,#footnotes,#footer{width:100%;margin:0 auto;max-width:62.5em;*zoom:1;position:relative;padding-left:.9375em;padding-right:.9375em}
137#header::before,#header::after,#content::before,#content::after,#footnotes::before,#footnotes::after,#footer::before,#footer::after{content:" ";display:table}
138#header::after,#content::after,#footnotes::after,#footer::after{clear:both}
139#content{margin-top:1.25em}
140#content::before{content:none}
141#header>h1:first-child{color:rgba(0,0,0,.85);margin-top:2.25rem;margin-bottom:0}
142#header>h1:first-child+#toc{margin-top:8px;border-top:1px solid #dddddf}
Junio C Hamanod6a33e42025-02-18 23:45:11[diff] [blame]143#header>h1:only-child{border-bottom:1px solid #dddddf;padding-bottom:8px}
Junio C Hamanob96f40a2024-08-01 00:57:25[diff] [blame]144#header .details{border-bottom:1px solid #dddddf;line-height:1.45;padding-top:.25em;padding-bottom:.25em;padding-left:.25em;color:rgba(0,0,0,.6);display:flex;flex-flow:row wrap}
145#header .details span:first-child{margin-left:-.125em}
146#header .details span.email a{color:rgba(0,0,0,.85)}
147#header .details br{display:none}
148#header .details br+span::before{content:"\00a0\2013\00a0"}
149#header .details br+span.author::before{content:"\00a0\22c5\00a0";color:rgba(0,0,0,.85)}
150#header .details br+span#revremark::before{content:"\00a0|\00a0"}
151#header #revnumber{text-transform:capitalize}
152#header #revnumber::after{content:"\00a0"}
153#content>h1:first-child:not([class]){color:rgba(0,0,0,.85);border-bottom:1px solid #dddddf;padding-bottom:8px;margin-top:0;padding-top:1rem;margin-bottom:1.25rem}
154#toc{border-bottom:1px solid #e7e7e9;padding-bottom:.5em}
155#toc>ul{margin-left:.125em}
156#toc ul.sectlevel0>li>a{font-style:italic}
157#toc ul.sectlevel0 ul.sectlevel1{margin:.5em 0}
158#toc ul{font-family:"Open Sans","DejaVu Sans",sans-serif;list-style-type:none}
159#toc li{line-height:1.3334;margin-top:.3334em}
160#toc a{text-decoration:none}
161#toc a:active{text-decoration:underline}
162#toctitle{color:#7a2518;font-size:1.2em}
163@media screen and (min-width:768px){#toctitle{font-size:1.375em}
164body.toc2{padding-left:15em;padding-right:0}
Junio C Hamanod6a33e42025-02-18 23:45:11[diff] [blame]165body.toc2 #header>h1:nth-last-child(2){border-bottom:1px solid #dddddf;padding-bottom:8px}
Junio C Hamanob96f40a2024-08-01 00:57:25[diff] [blame]166#toc.toc2{margin-top:0!important;background:#f8f8f7;position:fixed;width:15em;left:0;top:0;border-right:1px solid #e7e7e9;border-top-width:0!important;border-bottom-width:0!important;z-index:1000;padding:1.25em 1em;height:100%;overflow:auto}
167#toc.toc2 #toctitle{margin-top:0;margin-bottom:.8rem;font-size:1.2em}
168#toc.toc2>ul{font-size:.9em;margin-bottom:0}
169#toc.toc2 ul ul{margin-left:0;padding-left:1em}
170#toc.toc2 ul.sectlevel0 ul.sectlevel1{padding-left:0;margin-top:.5em;margin-bottom:.5em}
171body.toc2.toc-right{padding-left:0;padding-right:15em}
172body.toc2.toc-right #toc.toc2{border-right-width:0;border-left:1px solid #e7e7e9;left:auto;right:0}}
173@media screen and (min-width:1280px){body.toc2{padding-left:20em;padding-right:0}
174#toc.toc2{width:20em}
175#toc.toc2 #toctitle{font-size:1.375em}
176#toc.toc2>ul{font-size:.95em}
177#toc.toc2 ul ul{padding-left:1.25em}
178body.toc2.toc-right{padding-left:0;padding-right:20em}}
179#content #toc{border:1px solid #e0e0dc;margin-bottom:1.25em;padding:1.25em;background:#f8f8f7;border-radius:4px}
180#content #toc>:first-child{margin-top:0}
181#content #toc>:last-child{margin-bottom:0}
182#footer{max-width:none;background:rgba(0,0,0,.8);padding:1.25em}
183#footer-text{color:hsla(0,0%,100%,.8);line-height:1.44}
184#content{margin-bottom:.625em}
185.sect1{padding-bottom:.625em}
186@media screen and (min-width:768px){#content{margin-bottom:1.25em}
187.sect1{padding-bottom:1.25em}}
188.sect1:last-child{padding-bottom:0}
189.sect1+.sect1{border-top:1px solid #e7e7e9}
190#content h1>a.anchor,h2>a.anchor,h3>a.anchor,#toctitle>a.anchor,.sidebarblock>.content>.title>a.anchor,h4>a.anchor,h5>a.anchor,h6>a.anchor{position:absolute;z-index:1001;width:1.5ex;margin-left:-1.5ex;display:block;text-decoration:none!important;visibility:hidden;text-align:center;font-weight:400}
191#content h1>a.anchor::before,h2>a.anchor::before,h3>a.anchor::before,#toctitle>a.anchor::before,.sidebarblock>.content>.title>a.anchor::before,h4>a.anchor::before,h5>a.anchor::before,h6>a.anchor::before{content:"\00A7";font-size:.85em;display:block;padding-top:.1em}
192#content h1:hover>a.anchor,#content h1>a.anchor:hover,h2:hover>a.anchor,h2>a.anchor:hover,h3:hover>a.anchor,#toctitle:hover>a.anchor,.sidebarblock>.content>.title:hover>a.anchor,h3>a.anchor:hover,#toctitle>a.anchor:hover,.sidebarblock>.content>.title>a.anchor:hover,h4:hover>a.anchor,h4>a.anchor:hover,h5:hover>a.anchor,h5>a.anchor:hover,h6:hover>a.anchor,h6>a.anchor:hover{visibility:visible}
193#content h1>a.link,h2>a.link,h3>a.link,#toctitle>a.link,.sidebarblock>.content>.title>a.link,h4>a.link,h5>a.link,h6>a.link{color:#ba3925;text-decoration:none}
194#content h1>a.link:hover,h2>a.link:hover,h3>a.link:hover,#toctitle>a.link:hover,.sidebarblock>.content>.title>a.link:hover,h4>a.link:hover,h5>a.link:hover,h6>a.link:hover{color:#a53221}
195details,.audioblock,.imageblock,.literalblock,.listingblock,.stemblock,.videoblock{margin-bottom:1.25em}
196details{margin-left:1.25rem}
197details>summary{cursor:pointer;display:block;position:relative;line-height:1.6;margin-bottom:.625rem;outline:none;-webkit-tap-highlight-color:transparent}
198details>summary::-webkit-details-marker{display:none}
199details>summary::before{content:"";border:solid transparent;border-left:solid;border-width:.3em 0 .3em .5em;position:absolute;top:.5em;left:-1.25rem;transform:translateX(15%)}
200details[open]>summary::before{border:solid transparent;border-top:solid;border-width:.5em .3em 0;transform:translateY(15%)}
201details>summary::after{content:"";width:1.25rem;height:1em;position:absolute;top:.3em;left:-1.25rem}
202.admonitionblock td.content>.title,.audioblock>.title,.exampleblock>.title,.imageblock>.title,.listingblock>.title,.literalblock>.title,.stemblock>.title,.openblock>.title,.paragraph>.title,.quoteblock>.title,table.tableblock>.title,.verseblock>.title,.videoblock>.title,.dlist>.title,.olist>.title,.ulist>.title,.qlist>.title,.hdlist>.title{text-rendering:optimizeLegibility;text-align:left;font-family:"Noto Serif","DejaVu Serif",serif;font-size:1rem;font-style:italic}
203table.tableblock.fit-content>caption.title{white-space:nowrap;width:0}
204.paragraph.lead>p,#preamble>.sectionbody>[class=paragraph]:first-of-type p{font-size:1.21875em;line-height:1.6;color:rgba(0,0,0,.85)}
205.admonitionblock>table{border-collapse:separate;border:0;background:none;width:100%}
206.admonitionblock>table td.icon{text-align:center;width:80px}
207.admonitionblock>table td.icon img{max-width:none}
208.admonitionblock>table td.icon .title{font-weight:bold;font-family:"Open Sans","DejaVu Sans",sans-serif;text-transform:uppercase}
209.admonitionblock>table td.content{padding-left:1.125em;padding-right:1.25em;border-left:1px solid #dddddf;color:rgba(0,0,0,.6);word-wrap:anywhere}
210.admonitionblock>table td.content>:last-child>:last-child{margin-bottom:0}
211.exampleblock>.content{border:1px solid #e6e6e6;margin-bottom:1.25em;padding:1.25em;background:#fff;border-radius:4px}
212.sidebarblock{border:1px solid #dbdbd6;margin-bottom:1.25em;padding:1.25em;background:#f3f3f2;border-radius:4px}
213.sidebarblock>.content>.title{color:#7a2518;margin-top:0;text-align:center}
214.exampleblock>.content>:first-child,.sidebarblock>.content>:first-child{margin-top:0}
215.exampleblock>.content>:last-child,.exampleblock>.content>:last-child>:last-child,.exampleblock>.content .olist>ol>li:last-child>:last-child,.exampleblock>.content .ulist>ul>li:last-child>:last-child,.exampleblock>.content .qlist>ol>li:last-child>:last-child,.sidebarblock>.content>:last-child,.sidebarblock>.content>:last-child>:last-child,.sidebarblock>.content .olist>ol>li:last-child>:last-child,.sidebarblock>.content .ulist>ul>li:last-child>:last-child,.sidebarblock>.content .qlist>ol>li:last-child>:last-child{margin-bottom:0}
216.literalblock pre,.listingblock>.content>pre{border-radius:4px;overflow-x:auto;padding:1em;font-size:.8125em}
217@media screen and (min-width:768px){.literalblock pre,.listingblock>.content>pre{font-size:.90625em}}
218@media screen and (min-width:1280px){.literalblock pre,.listingblock>.content>pre{font-size:1em}}
219.literalblock pre,.listingblock>.content>pre:not(.highlight),.listingblock>.content>pre[class=highlight],.listingblock>.content>pre[class^="highlight "]{background:#f7f7f8}
220.literalblock.output pre{color:#f7f7f8;background:rgba(0,0,0,.9)}
221.listingblock>.content{position:relative}
222.listingblock code[data-lang]::before{display:none;content:attr(data-lang);position:absolute;font-size:.75em;top:.425rem;right:.5rem;line-height:1;text-transform:uppercase;color:inherit;opacity:.5}
223.listingblock:hover code[data-lang]::before{display:block}
224.listingblock.terminal pre .command::before{content:attr(data-prompt);padding-right:.5em;color:inherit;opacity:.5}
225.listingblock.terminal pre .command:not([data-prompt])::before{content:"$"}
226.listingblock pre.highlightjs{padding:0}
227.listingblock pre.highlightjs>code{padding:1em;border-radius:4px}
228.listingblock pre.prettyprint{border-width:0}
229.prettyprint{background:#f7f7f8}
230pre.prettyprint .linenums{line-height:1.45;margin-left:2em}
231pre.prettyprint li{background:none;list-style-type:inherit;padding-left:0}
232pre.prettyprint li code[data-lang]::before{opacity:1}
233pre.prettyprint li:not(:first-child) code[data-lang]::before{display:none}
234table.linenotable{border-collapse:separate;border:0;margin-bottom:0;background:none}
235table.linenotable td[class]{color:inherit;vertical-align:top;padding:0;line-height:inherit;white-space:normal}
236table.linenotable td.code{padding-left:.75em}
237table.linenotable td.linenos,pre.pygments .linenos{border-right:1px solid;opacity:.35;padding-right:.5em;-webkit-user-select:none;-moz-user-select:none;-ms-user-select:none;user-select:none}
238pre.pygments span.linenos{display:inline-block;margin-right:.75em}
239.quoteblock{margin:0 1em 1.25em 1.5em;display:table}
240.quoteblock:not(.excerpt)>.title{margin-left:-1.5em;margin-bottom:.75em}
241.quoteblock blockquote,.quoteblock p{color:rgba(0,0,0,.85);font-size:1.15rem;line-height:1.75;word-spacing:.1em;letter-spacing:0;font-style:italic;text-align:justify}
242.quoteblock blockquote{margin:0;padding:0;border:0}
243.quoteblock blockquote::before{content:"\201c";float:left;font-size:2.75em;font-weight:bold;line-height:.6em;margin-left:-.6em;color:#7a2518;text-shadow:0 1px 2px rgba(0,0,0,.1)}
244.quoteblock blockquote>.paragraph:last-child p{margin-bottom:0}
245.quoteblock .attribution{margin-top:.75em;margin-right:.5ex;text-align:right}
246.verseblock{margin:0 1em 1.25em}
247.verseblock pre{font-family:"Open Sans","DejaVu Sans",sans-serif;font-size:1.15rem;color:rgba(0,0,0,.85);font-weight:300;text-rendering:optimizeLegibility}
248.verseblock pre strong{font-weight:400}
249.verseblock .attribution{margin-top:1.25rem;margin-left:.5ex}
250.quoteblock .attribution,.verseblock .attribution{font-size:.9375em;line-height:1.45;font-style:italic}
251.quoteblock .attribution br,.verseblock .attribution br{display:none}
252.quoteblock .attribution cite,.verseblock .attribution cite{display:block;letter-spacing:-.025em;color:rgba(0,0,0,.6)}
253.quoteblock.abstract blockquote::before,.quoteblock.excerpt blockquote::before,.quoteblock .quoteblock blockquote::before{display:none}
254.quoteblock.abstract blockquote,.quoteblock.abstract p,.quoteblock.excerpt blockquote,.quoteblock.excerpt p,.quoteblock .quoteblock blockquote,.quoteblock .quoteblock p{line-height:1.6;word-spacing:0}
255.quoteblock.abstract{margin:0 1em 1.25em;display:block}
256.quoteblock.abstract>.title{margin:0 0 .375em;font-size:1.15em;text-align:center}
257.quoteblock.excerpt>blockquote,.quoteblock .quoteblock{padding:0 0 .25em 1em;border-left:.25em solid #dddddf}
258.quoteblock.excerpt,.quoteblock .quoteblock{margin-left:0}
259.quoteblock.excerpt blockquote,.quoteblock.excerpt p,.quoteblock .quoteblock blockquote,.quoteblock .quoteblock p{color:inherit;font-size:1.0625rem}
260.quoteblock.excerpt .attribution,.quoteblock .quoteblock .attribution{color:inherit;font-size:.85rem;text-align:left;margin-right:0}
261p.tableblock:last-child{margin-bottom:0}
262td.tableblock>.content{margin-bottom:1.25em;word-wrap:anywhere}
263td.tableblock>.content>:last-child{margin-bottom:-1.25em}
264table.tableblock,th.tableblock,td.tableblock{border:0 solid #dedede}
265table.grid-all>*>tr>*{border-width:1px}
266table.grid-cols>*>tr>*{border-width:0 1px}
267table.grid-rows>*>tr>*{border-width:1px 0}
268table.frame-all{border-width:1px}
269table.frame-ends{border-width:1px 0}
270table.frame-sides{border-width:0 1px}
271table.frame-none>colgroup+*>:first-child>*,table.frame-sides>colgroup+*>:first-child>*{border-top-width:0}
272table.frame-none>:last-child>:last-child>*,table.frame-sides>:last-child>:last-child>*{border-bottom-width:0}
273table.frame-none>*>tr>:first-child,table.frame-ends>*>tr>:first-child{border-left-width:0}
274table.frame-none>*>tr>:last-child,table.frame-ends>*>tr>:last-child{border-right-width:0}
275table.stripes-all>*>tr,table.stripes-odd>*>tr:nth-of-type(odd),table.stripes-even>*>tr:nth-of-type(even),table.stripes-hover>*>tr:hover{background:#f8f8f7}
276th.halign-left,td.halign-left{text-align:left}
277th.halign-right,td.halign-right{text-align:right}
278th.halign-center,td.halign-center{text-align:center}
279th.valign-top,td.valign-top{vertical-align:top}
280th.valign-bottom,td.valign-bottom{vertical-align:bottom}
281th.valign-middle,td.valign-middle{vertical-align:middle}
282table thead th,table tfoot th{font-weight:bold}
283tbody tr th{background:#f7f8f7}
284tbody tr th,tbody tr th p,tfoot tr th,tfoot tr th p{color:rgba(0,0,0,.8);font-weight:bold}
285p.tableblock>code:only-child{background:none;padding:0}
286p.tableblock{font-size:1em}
287ol{margin-left:1.75em}
288ul li ol{margin-left:1.5em}
289dl dd{margin-left:1.125em}
290dl dd:last-child,dl dd:last-child>:last-child{margin-bottom:0}
291li p,ul dd,ol dd,.olist .olist,.ulist .ulist,.ulist .olist,.olist .ulist{margin-bottom:.625em}
292ul.checklist,ul.none,ol.none,ul.no-bullet,ol.no-bullet,ol.unnumbered,ul.unstyled,ol.unstyled{list-style-type:none}
293ul.no-bullet,ol.no-bullet,ol.unnumbered{margin-left:.625em}
294ul.unstyled,ol.unstyled{margin-left:0}
295li>p:empty:only-child::before{content:"";display:inline-block}
296ul.checklist>li>p:first-child{margin-left:-1em}
297ul.checklist>li>p:first-child>.fa-square-o:first-child,ul.checklist>li>p:first-child>.fa-check-square-o:first-child{width:1.25em;font-size:.8em;position:relative;bottom:.125em}
298ul.checklist>li>p:first-child>input[type=checkbox]:first-child{margin-right:.25em}
299ul.inline{display:flex;flex-flow:row wrap;list-style:none;margin:0 0 .625em -1.25em}
300ul.inline>li{margin-left:1.25em}
301.unstyled dl dt{font-weight:400;font-style:normal}
302ol.arabic{list-style-type:decimal}
303ol.decimal{list-style-type:decimal-leading-zero}
304ol.loweralpha{list-style-type:lower-alpha}
305ol.upperalpha{list-style-type:upper-alpha}
306ol.lowerroman{list-style-type:lower-roman}
307ol.upperroman{list-style-type:upper-roman}
308ol.lowergreek{list-style-type:lower-greek}
309.hdlist>table,.colist>table{border:0;background:none}
310.hdlist>table>tbody>tr,.colist>table>tbody>tr{background:none}
311td.hdlist1,td.hdlist2{vertical-align:top;padding:0 .625em}
312td.hdlist1{font-weight:bold;padding-bottom:1.25em}
313td.hdlist2{word-wrap:anywhere}
314.literalblock+.colist,.listingblock+.colist{margin-top:-.5em}
315.colist td:not([class]):first-child{padding:.4em .75em 0;line-height:1;vertical-align:top}
316.colist td:not([class]):first-child img{max-width:none}
317.colist td:not([class]):last-child{padding:.25em 0}
318.thumb,.th{line-height:0;display:inline-block;border:4px solid #fff;box-shadow:0 0 0 1px #ddd}
319.imageblock.left{margin:.25em .625em 1.25em 0}
320.imageblock.right{margin:.25em 0 1.25em .625em}
321.imageblock>.title{margin-bottom:0}
322.imageblock.thumb,.imageblock.th{border-width:6px}
323.imageblock.thumb>.title,.imageblock.th>.title{padding:0 .125em}
324.image.left,.image.right{margin-top:.25em;margin-bottom:.25em;display:inline-block;line-height:0}
325.image.left{margin-right:.625em}
326.image.right{margin-left:.625em}
327a.image{text-decoration:none;display:inline-block}
328a.image object{pointer-events:none}
329sup.footnote,sup.footnoteref{font-size:.875em;position:static;vertical-align:super}
330sup.footnote a,sup.footnoteref a{text-decoration:none}
Junio C Hamanod6a33e42025-02-18 23:45:11[diff] [blame]331sup.footnote a:active,sup.footnoteref a:active,#footnotes .footnote a:first-of-type:active{text-decoration:underline}
Junio C Hamanob96f40a2024-08-01 00:57:25[diff] [blame]332#footnotes{padding-top:.75em;padding-bottom:.75em;margin-bottom:.625em}
333#footnotes hr{width:20%;min-width:6.25em;margin:-.25em 0 .75em;border-width:1px 0 0}
334#footnotes .footnote{padding:0 .375em 0 .225em;line-height:1.3334;font-size:.875em;margin-left:1.2em;margin-bottom:.2em}
335#footnotes .footnote a:first-of-type{font-weight:bold;text-decoration:none;margin-left:-1.05em}
336#footnotes .footnote:last-of-type{margin-bottom:0}
337#content #footnotes{margin-top:-.625em;margin-bottom:0;padding:.75em 0}
338div.unbreakable{page-break-inside:avoid}
339.big{font-size:larger}
340.small{font-size:smaller}
341.underline{text-decoration:underline}
342.overline{text-decoration:overline}
343.line-through{text-decoration:line-through}
344.aqua{color:#00bfbf}
345.aqua-background{background:#00fafa}
346.black{color:#000}
347.black-background{background:#000}
348.blue{color:#0000bf}
349.blue-background{background:#0000fa}
350.fuchsia{color:#bf00bf}
351.fuchsia-background{background:#fa00fa}
352.gray{color:#606060}
353.gray-background{background:#7d7d7d}
354.green{color:#006000}
355.green-background{background:#007d00}
356.lime{color:#00bf00}
357.lime-background{background:#00fa00}
358.maroon{color:#600000}
359.maroon-background{background:#7d0000}
360.navy{color:#000060}
361.navy-background{background:#00007d}
362.olive{color:#606000}
363.olive-background{background:#7d7d00}
364.purple{color:#600060}
365.purple-background{background:#7d007d}
366.red{color:#bf0000}
367.red-background{background:#fa0000}
368.silver{color:#909090}
369.silver-background{background:#bcbcbc}
370.teal{color:#006060}
371.teal-background{background:#007d7d}
372.white{color:#bfbfbf}
373.white-background{background:#fafafa}
374.yellow{color:#bfbf00}
375.yellow-background{background:#fafa00}
376span.icon>.fa{cursor:default}
377a span.icon>.fa{cursor:inherit}
378.admonitionblock td.icon [class^="fa icon-"]{font-size:2.5em;text-shadow:1px 1px 2px rgba(0,0,0,.5);cursor:default}
379.admonitionblock td.icon .icon-note::before{content:"\f05a";color:#19407c}
380.admonitionblock td.icon .icon-tip::before{content:"\f0eb";text-shadow:1px 1px 2px rgba(155,155,0,.8);color:#111}
381.admonitionblock td.icon .icon-warning::before{content:"\f071";color:#bf6900}
382.admonitionblock td.icon .icon-caution::before{content:"\f06d";color:#bf3400}
383.admonitionblock td.icon .icon-important::before{content:"\f06a";color:#bf0000}
384.conum[data-value]{display:inline-block;color:#fff!important;background:rgba(0,0,0,.8);border-radius:50%;text-align:center;font-size:.75em;width:1.67em;height:1.67em;line-height:1.67em;font-family:"Open Sans","DejaVu Sans",sans-serif;font-style:normal;font-weight:bold}
385.conum[data-value] *{color:#fff!important}
386.conum[data-value]+b{display:none}
387.conum[data-value]::after{content:attr(data-value)}
388pre .conum[data-value]{position:relative;top:-.125em}
389b.conum *{color:inherit!important}
390.conum:not([data-value]):empty{display:none}
391dt,th.tableblock,td.content,div.footnote{text-rendering:optimizeLegibility}
392h1,h2,p,td.content,span.alt,summary{letter-spacing:-.01em}
393p strong,td.content strong,div.footnote strong{letter-spacing:-.005em}
394p,blockquote,dt,td.content,td.hdlist1,span.alt,summary{font-size:1.0625rem}
395p{margin-bottom:1.25rem}
396.sidebarblock p,.sidebarblock dt,.sidebarblock td.content,p.tableblock{font-size:1em}
397.exampleblock>.content{background:#fffef7;border-color:#e0e0dc;box-shadow:0 1px 4px #e0e0dc}
398.print-only{display:none!important}
399@page{margin:1.25cm .75cm}
400@media print{*{box-shadow:none!important;text-shadow:none!important}
401html{font-size:80%}
402a{color:inherit!important;text-decoration:underline!important}
403a.bare,a[href^="#"],a[href^="mailto:"]{text-decoration:none!important}
404a[href^="http:"]:not(.bare)::after,a[href^="https:"]:not(.bare)::after{content:"(" attr(href) ")";display:inline-block;font-size:.875em;padding-left:.25em}
405abbr[title]{border-bottom:1px dotted}
406abbr[title]::after{content:" (" attr(title) ")"}
407pre,blockquote,tr,img,object,svg{page-break-inside:avoid}
408thead{display:table-header-group}
409svg{max-width:100%}
410p,blockquote,dt,td.content{font-size:1em;orphans:3;widows:3}
411h2,h3,#toctitle,.sidebarblock>.content>.title{page-break-after:avoid}
412#header,#content,#footnotes,#footer{max-width:none}
413#toc,.sidebarblock,.exampleblock>.content{background:none!important}
414#toc{border-bottom:1px solid #dddddf!important;padding-bottom:0!important}
415body.book #header{text-align:center}
416body.book #header>h1:first-child{border:0!important;margin:2.5em 0 1em}
417body.book #header .details{border:0!important;display:block;padding:0!important}
418body.book #header .details span:first-child{margin-left:0!important}
419body.book #header .details br{display:block}
420body.book #header .details br+span::before{content:none!important}
421body.book #toc{border:0!important;text-align:left!important;padding:0!important;margin:0!important}
422body.book #toc,body.book #preamble,body.book h1.sect0,body.book .sect1>h2{page-break-before:always}
423.listingblock code[data-lang]::before{display:block}
424#footer{padding:0 .9375em}
425.hide-on-print{display:none!important}
426.print-only{display:block!important}
427.hide-for-print{display:none!important}
428.show-for-print{display:inherit!important}}
429@media amzn-kf8,print{#header>h1:first-child{margin-top:1.25rem}
430.sect1{padding:0!important}
431.sect1+.sect1{border:0}
432#footer{background:none}
433#footer-text{color:rgba(0,0,0,.6);font-size:.9em}}
434@media amzn-kf8{#header,#content,#footnotes,#footer{padding:0}}
435</style>
436<style>
437pre>code {
438 display: inline;
439}
440</style>
441</head>
442<body class="manpage">
443<div id="header">
444<h1>gitprotocol-capabilities(5) Manual Page</h1>
445<h2 id="_name">NAME</h2>
446<div class="sectionbody">
447<p>gitprotocol-capabilities - Protocol v0 and v1 capabilities</p>
448</div>
449</div>
450<div id="content">
451<div class="sect1">
452<h2 id="_synopsis">SYNOPSIS</h2>
453<div class="sectionbody">
454<div class="verseblock">
455<pre class="content">&lt;over-the-wire-protocol&gt;</pre>
456</div>
457</div>
458</div>
459<div class="sect1">
460<h2 id="_description">DESCRIPTION</h2>
461<div class="sectionbody">
462<div class="admonitionblock note">
463<table>
464<tr>
465<td class="icon">
466<div class="title">Note</div>
467</td>
468<td class="content">
469this document describes capabilities for versions 0 and 1 of the pack
470protocol. For version 2, please refer to the <a href="gitprotocol-v2.html">gitprotocol-v2(5)</a>
471doc.
472</td>
473</tr>
474</table>
475</div>
476<div class="paragraph">
477<p>Servers SHOULD support all capabilities defined in this document.</p>
478</div>
479<div class="paragraph">
480<p>On the very first line of the initial server response of either
481receive-pack and upload-pack the first reference is followed by
482a NUL byte and then a list of space delimited server capabilities.
483These allow the server to declare what it can and cannot support
484to the client.</p>
485</div>
486<div class="paragraph">
487<p>Client will then send a space separated list of capabilities it wants
488to be in effect. The client MUST NOT ask for capabilities the server
489did not say it supports.</p>
490</div>
491<div class="paragraph">
492<p>Server MUST diagnose and abort if capabilities it does not understand
493were sent. Server MUST NOT ignore capabilities that client requested
494and server advertised. As a consequence of these rules, server MUST
495NOT advertise capabilities it does not understand.</p>
496</div>
497<div class="paragraph">
498<p>The <em>atomic</em>, <em>report-status</em>, <em>report-status-v2</em>, <em>delete-refs</em>, <em>quiet</em>,
499and <em>push-cert</em> capabilities are sent and recognized by the receive-pack
500(push to server) process.</p>
501</div>
502<div class="paragraph">
503<p>The <em>ofs-delta</em> and <em>side-band-64k</em> capabilities are sent and recognized
504by both upload-pack and receive-pack protocols. The <em>agent</em> and <em>session-id</em>
505capabilities may optionally be sent in both protocols.</p>
506</div>
507<div class="paragraph">
508<p>All other capabilities are only recognized by the upload-pack (fetch
509from server) process.</p>
510</div>
511</div>
512</div>
513<div class="sect1">
514<h2 id="_multi_ack">multi_ack</h2>
515<div class="sectionbody">
516<div class="paragraph">
517<p>The <em>multi_ack</em> capability allows the server to return "ACK obj-id
518continue" as soon as it finds a commit that it can use as a common
519base, between the client&#8217;s wants and the client&#8217;s have set.</p>
520</div>
521<div class="paragraph">
522<p>By sending this early, the server can potentially head off the client
523from walking any further down that particular branch of the client&#8217;s
524repository history. The client may still need to walk down other
525branches, sending have lines for those, until the server has a
526complete cut across the DAG, or the client has said "done".</p>
527</div>
528<div class="paragraph">
529<p>Without multi_ack, a client sends have lines in --date-order until
530the server has found a common base. That means the client will send
531have lines that are already known by the server to be common, because
532they overlap in time with another branch on which the server hasn&#8217;t found
533a common base yet.</p>
534</div>
535<div class="paragraph">
536<p>For example suppose the client has commits in caps that the server
537doesn&#8217;t and the server has commits in lower case that the client
538doesn&#8217;t, as in the following diagram:</p>
539</div>
540<div class="literalblock">
541<div class="content">
542<pre> +---- u ---------------------- x
543 / +----- y
544 / /
545 a -- b -- c -- d -- E -- F
546 \
547+--- Q -- R -- S</pre>
548</div>
549</div>
550<div class="paragraph">
551<p>If the client wants x,y and starts out by saying have F,S, the server
552doesn&#8217;t know what F,S is. Eventually the client says "have d" and
553the server sends "ACK d continue" to let the client know to stop
554walking down that line (so don&#8217;t send c-b-a), but it&#8217;s not done yet,
555it needs a base for x. The client keeps going with S-R-Q, until a
556gets reached, at which point the server has a clear base and it all
557ends.</p>
558</div>
559<div class="paragraph">
560<p>Without multi_ack the client would have sent that c-b-a chain anyway,
561interleaved with S-R-Q.</p>
562</div>
563</div>
564</div>
565<div class="sect1">
566<h2 id="_multi_ack_detailed">multi_ack_detailed</h2>
567<div class="sectionbody">
568<div class="paragraph">
569<p>This is an extension of multi_ack that permits the client to better
570understand the server&#8217;s in-memory state. See <a href="gitprotocol-pack.html">gitprotocol-pack(5)</a>,
571section "Packfile Negotiation" for more information.</p>
572</div>
573</div>
574</div>
575<div class="sect1">
576<h2 id="_no_done">no-done</h2>
577<div class="sectionbody">
578<div class="paragraph">
579<p>This capability should only be used with the smart HTTP protocol. If
580multi_ack_detailed and no-done are both present, then the sender is
581free to immediately send a pack following its first "ACK obj-id ready"
582message.</p>
583</div>
584<div class="paragraph">
585<p>Without no-done in the smart HTTP protocol, the server session would
586end and the client has to make another trip to send "done" before
587the server can send the pack. no-done removes the last round and
588thus slightly reduces latency.</p>
589</div>
590</div>
591</div>
592<div class="sect1">
593<h2 id="_thin_pack">thin-pack</h2>
594<div class="sectionbody">
595<div class="paragraph">
596<p>A thin pack is one with deltas which reference base objects not
597contained within the pack (but are known to exist at the receiving
598end). This can reduce the network traffic significantly, but it
599requires the receiving end to know how to "thicken" these packs by
600adding the missing bases to the pack.</p>
601</div>
602<div class="paragraph">
603<p>The upload-pack server advertises <em>thin-pack</em> when it can generate
604and send a thin pack. A client requests the <em>thin-pack</em> capability
605when it understands how to "thicken" it, notifying the server that
606it can receive such a pack. A client MUST NOT request the
607<em>thin-pack</em> capability if it cannot turn a thin pack into a
608self-contained pack.</p>
609</div>
610<div class="paragraph">
611<p>Receive-pack, on the other hand, is assumed by default to be able to
612handle thin packs, but can ask the client not to use the feature by
613advertising the <em>no-thin</em> capability. A client MUST NOT send a thin
614pack if the server advertises the <em>no-thin</em> capability.</p>
615</div>
616<div class="paragraph">
617<p>The reasons for this asymmetry are historical. The receive-pack
618program did not exist until after the invention of thin packs, so
619historically the reference implementation of receive-pack always
620understood thin packs. Adding <em>no-thin</em> later allowed receive-pack
621to disable the feature in a backwards-compatible manner.</p>
622</div>
623</div>
624</div>
625<div class="sect1">
626<h2 id="_side_band_side_band_64k">side-band, side-band-64k</h2>
627<div class="sectionbody">
628<div class="paragraph">
629<p>This capability means that the server can send, and the client can understand, multiplexed
630progress reports and error info interleaved with the packfile itself.</p>
631</div>
632<div class="paragraph">
633<p>These two options are mutually exclusive. A modern client always
634favors <em>side-band-64k</em>.</p>
635</div>
636<div class="paragraph">
637<p>Either mode indicates that the packfile data will be streamed broken
638up into packets of up to either 1000 bytes in the case of <em>side_band</em>,
639or 65520 bytes in the case of <em>side_band_64k</em>. Each packet is made up
640of a leading 4-byte pkt-line length of how much data is in the packet,
641followed by a 1-byte stream code, followed by the actual data.</p>
642</div>
643<div class="paragraph">
644<p>The stream code can be one of:</p>
645</div>
646<div class="literalblock">
647<div class="content">
648<pre>1 - pack data
6492 - progress messages
6503 - fatal error message just before stream aborts</pre>
651</div>
652</div>
653<div class="paragraph">
654<p>The "side-band-64k" capability came about as a way for newer clients
655that can handle much larger packets to request packets that are
656actually crammed nearly full, while maintaining backward compatibility
657for the older clients.</p>
658</div>
659<div class="paragraph">
660<p>Further, with side-band and its up to 1000-byte messages, it&#8217;s actually
661999 bytes of payload and 1 byte for the stream code. With side-band-64k,
662same deal, you have up to 65519 bytes of data and 1 byte for the stream
663code.</p>
664</div>
665<div class="paragraph">
666<p>The client MUST send only one of "side-band" and "side-
667band-64k". The server MUST diagnose it as an error if client requests
668both.</p>
669</div>
670</div>
671</div>
672<div class="sect1">
673<h2 id="_ofs_delta">ofs-delta</h2>
674<div class="sectionbody">
675<div class="paragraph">
676<p>The server can send, and the client can understand, PACKv2 with delta referring to
677its base by position in pack rather than by an obj-id. That is, they can
678send/read OBJ_OFS_DELTA (aka type 6) in a packfile.</p>
679</div>
680</div>
681</div>
682<div class="sect1">
683<h2 id="_agent">agent</h2>
684<div class="sectionbody">
685<div class="paragraph">
686<p>The server may optionally send a capability of the form <code>agent=X</code> to
687notify the client that the server is running version <code>X</code>. The client may
688optionally return its own agent string by responding with an <code>agent=Y</code>
689capability (but it MUST NOT do so if the server did not mention the
690agent capability). The <code>X</code> and <code>Y</code> strings may contain any printable
691ASCII characters except space (i.e., the byte range 32 &lt; x &lt; 127), and
692are typically of the form "package/version" (e.g., "git/1.8.3.1"). The
693agent strings are purely informative for statistics and debugging
694purposes, and MUST NOT be used to programmatically assume the presence
695or absence of particular features.</p>
696</div>
697</div>
698</div>
699<div class="sect1">
700<h2 id="_object_format">object-format</h2>
701<div class="sectionbody">
702<div class="paragraph">
703<p>This capability, which takes a hash algorithm as an argument, indicates
704that the server supports the given hash algorithms. It may be sent
705multiple times; if so, the first one given is the one used in the ref
706advertisement.</p>
707</div>
708<div class="paragraph">
709<p>When provided by the client, this indicates that it intends to use the
710given hash algorithm to communicate. The algorithm provided must be one
711that the server supports.</p>
712</div>
713<div class="paragraph">
714<p>If this capability is not provided, it is assumed that the only
715supported algorithm is SHA-1.</p>
716</div>
717</div>
718</div>
719<div class="sect1">
720<h2 id="_symref">symref</h2>
721<div class="sectionbody">
722<div class="paragraph">
723<p>This parameterized capability is used to inform the receiver which symbolic ref
724points to which ref; for example, "symref=HEAD:refs/heads/master" tells the
725receiver that HEAD points to master. This capability can be repeated to
726represent multiple symrefs.</p>
727</div>
728<div class="paragraph">
729<p>Servers SHOULD include this capability for the HEAD symref if it is one of the
730refs being sent.</p>
731</div>
732<div class="paragraph">
733<p>Clients MAY use the parameters from this capability to select the proper initial
734branch when cloning a repository.</p>
735</div>
736</div>
737</div>
738<div class="sect1">
739<h2 id="_shallow">shallow</h2>
740<div class="sectionbody">
741<div class="paragraph">
742<p>This capability adds "deepen", "shallow" and "unshallow" commands to
743the fetch-pack/upload-pack protocol so clients can request shallow
744clones.</p>
745</div>
746</div>
747</div>
748<div class="sect1">
749<h2 id="_deepen_since">deepen-since</h2>
750<div class="sectionbody">
751<div class="paragraph">
752<p>This capability adds "deepen-since" command to fetch-pack/upload-pack
753protocol so the client can request shallow clones that are cut at a
754specific time, instead of depth. Internally it&#8217;s equivalent of doing
755"rev-list --max-age=&lt;timestamp&gt;" on the server side. "deepen-since"
756cannot be used with "deepen".</p>
757</div>
758</div>
759</div>
760<div class="sect1">
761<h2 id="_deepen_not">deepen-not</h2>
762<div class="sectionbody">
763<div class="paragraph">
764<p>This capability adds "deepen-not" command to fetch-pack/upload-pack
765protocol so the client can request shallow clones that are cut at a
766specific revision, instead of depth. Internally it&#8217;s equivalent of
767doing "rev-list --not &lt;rev&gt;" on the server side. "deepen-not"
768cannot be used with "deepen", but can be used with "deepen-since".</p>
769</div>
770</div>
771</div>
772<div class="sect1">
773<h2 id="_deepen_relative">deepen-relative</h2>
774<div class="sectionbody">
775<div class="paragraph">
776<p>If this capability is requested by the client, the semantics of
777"deepen" command is changed. The "depth" argument is the depth from
778the current shallow boundary, instead of the depth from remote refs.</p>
779</div>
780</div>
781</div>
782<div class="sect1">
783<h2 id="_no_progress">no-progress</h2>
784<div class="sectionbody">
785<div class="paragraph">
786<p>The client was started with "git clone -q" or something similar, and doesn&#8217;t
787want that side band 2. Basically the client just says "I do not
788wish to receive stream 2 on sideband, so do not send it to me, and if
789you did, I will drop it on the floor anyway". However, the sideband
790channel 3 is still used for error responses.</p>
791</div>
792</div>
793</div>
794<div class="sect1">
795<h2 id="_include_tag">include-tag</h2>
796<div class="sectionbody">
797<div class="paragraph">
798<p>The <em>include-tag</em> capability is about sending annotated tags if we are
799sending objects they point to. If we pack an object to the client, and
800a tag object points exactly at that object, we pack the tag object too.
801In general this allows a client to get all new annotated tags when it
802fetches a branch, in a single network connection.</p>
803</div>
804<div class="paragraph">
805<p>Clients MAY always send include-tag, hardcoding it into a request when
806the server advertises this capability. The decision for a client to
807request include-tag only has to do with the client&#8217;s desires for tag
808data, whether or not a server had advertised objects in the
809refs/tags/* namespace.</p>
810</div>
811<div class="paragraph">
812<p>Servers MUST pack the tags if their referent is packed and the client
813has requested include-tags.</p>
814</div>
815<div class="paragraph">
816<p>Clients MUST be prepared for the case where a server has ignored
817include-tag and has not actually sent tags in the pack. In such
818cases the client SHOULD issue a subsequent fetch to acquire the tags
819that include-tag would have otherwise given the client.</p>
820</div>
821<div class="paragraph">
822<p>The server SHOULD send include-tag, if it supports it, regardless
823of whether or not there are tags available.</p>
824</div>
825</div>
826</div>
827<div class="sect1">
828<h2 id="_report_status">report-status</h2>
829<div class="sectionbody">
830<div class="paragraph">
831<p>The receive-pack process can receive a <em>report-status</em> capability,
832which tells it that the client wants a report of what happened after
833a packfile upload and reference update. If the pushing client requests
834this capability, after unpacking and updating references the server
835will respond with whether the packfile unpacked successfully and if
836each reference was updated successfully. If any of those were not
837successful, it will send back an error message. See <a href="gitprotocol-pack.html">gitprotocol-pack(5)</a>
838for example messages.</p>
839</div>
840</div>
841</div>
842<div class="sect1">
843<h2 id="_report_status_v2">report-status-v2</h2>
844<div class="sectionbody">
845<div class="paragraph">
846<p>Capability <em>report-status-v2</em> extends capability <em>report-status</em> by
847adding new "option" directives in order to support reference rewritten by
848the "proc-receive" hook. The "proc-receive" hook may handle a command
849for a pseudo-reference which may create or update a reference with
850different name, new-oid, and old-oid. While the capability
851<em>report-status</em> cannot report for such case. See <a href="gitprotocol-pack.html">gitprotocol-pack(5)</a>
852for details.</p>
853</div>
854</div>
855</div>
856<div class="sect1">
857<h2 id="_delete_refs">delete-refs</h2>
858<div class="sectionbody">
859<div class="paragraph">
860<p>If the server sends back the <em>delete-refs</em> capability, it means that
861it is capable of accepting a zero-id value as the target
862value of a reference update. It is not sent back by the client, it
863simply informs the client that it can be sent zero-id values
864to delete references.</p>
865</div>
866</div>
867</div>
868<div class="sect1">
869<h2 id="_quiet">quiet</h2>
870<div class="sectionbody">
871<div class="paragraph">
872<p>If the receive-pack server advertises the <em>quiet</em> capability, it is
873capable of silencing human-readable progress output which otherwise may
874be shown when processing the received pack. A send-pack client should
875respond with the <em>quiet</em> capability to suppress server-side progress
876reporting if the local progress reporting is also being suppressed
Junio C Hamanodc392382024-10-11 18:57:29[diff] [blame]877(e.g., via <code>push</code> <code>-q</code>, or if stderr does not go to a tty).</p>
Junio C Hamanob96f40a2024-08-01 00:57:25[diff] [blame]878</div>
879</div>
880</div>
881<div class="sect1">
882<h2 id="_atomic">atomic</h2>
883<div class="sectionbody">
884<div class="paragraph">
885<p>If the server sends the <em>atomic</em> capability it is capable of accepting
886atomic pushes. If the pushing client requests this capability, the server
887will update the refs in one atomic transaction. Either all refs are
888updated or none.</p>
889</div>
890</div>
891</div>
892<div class="sect1">
893<h2 id="_push_options">push-options</h2>
894<div class="sectionbody">
895<div class="paragraph">
896<p>If the server sends the <em>push-options</em> capability it is able to accept
897push options after the update commands have been sent, but before the
898packfile is streamed. If the pushing client requests this capability,
899the server will pass the options to the pre- and post- receive hooks
900that process this push request.</p>
901</div>
902</div>
903</div>
904<div class="sect1">
905<h2 id="_allow_tip_sha1_in_want">allow-tip-sha1-in-want</h2>
906<div class="sectionbody">
907<div class="paragraph">
908<p>If the upload-pack server advertises this capability, fetch-pack may
909send "want" lines with object names that exist at the server but are not
910advertised by upload-pack. For historical reasons, the name of this
911capability contains "sha1". Object names are always given using the
912object format negotiated through the <em>object-format</em> capability.</p>
913</div>
914</div>
915</div>
916<div class="sect1">
917<h2 id="_allow_reachable_sha1_in_want">allow-reachable-sha1-in-want</h2>
918<div class="sectionbody">
919<div class="paragraph">
920<p>If the upload-pack server advertises this capability, fetch-pack may
921send "want" lines with object names that exist at the server but are not
922advertised by upload-pack. For historical reasons, the name of this
923capability contains "sha1". Object names are always given using the
924object format negotiated through the <em>object-format</em> capability.</p>
925</div>
926</div>
927</div>
928<div class="sect1">
929<h2 id="_push_certnonce">push-cert=&lt;nonce&gt;</h2>
930<div class="sectionbody">
931<div class="paragraph">
932<p>The receive-pack server that advertises this capability is willing
933to accept a signed push certificate, and asks the &lt;nonce&gt; to be
934included in the push certificate. A send-pack client MUST NOT
935send a push-cert packet unless the receive-pack server advertises
936this capability.</p>
937</div>
938</div>
939</div>
940<div class="sect1">
941<h2 id="_filter">filter</h2>
942<div class="sectionbody">
943<div class="paragraph">
944<p>If the upload-pack server advertises the <em>filter</em> capability,
945fetch-pack may send "filter" commands to request a partial clone
946or partial fetch and request that the server omit various objects
947from the packfile.</p>
948</div>
949</div>
950</div>
951<div class="sect1">
952<h2 id="_session_idsession_id">session-id=&lt;session-id&gt;</h2>
953<div class="sectionbody">
954<div class="paragraph">
955<p>The server may advertise a session ID that can be used to identify this process
956across multiple requests. The client may advertise its own session ID back to
957the server as well.</p>
958</div>
959<div class="paragraph">
960<p>Session IDs should be unique to a given process. They must fit within a
961packet-line, and must not contain non-printable or whitespace characters. The
962current implementation uses trace2 session IDs (see
963<a href="technical/api-trace2.html">api-trace2</a> for details), but this may change
964and users of the session ID should not rely on this fact.</p>
965</div>
966</div>
967</div>
968<div class="sect1">
969<h2 id="_git">GIT</h2>
970<div class="sectionbody">
971<div class="paragraph">
972<p>Part of the <a href="git.html">git(1)</a> suite</p>
973</div>
974</div>
975</div>
976</div>
977<div id="footer">
978<div id="footer-text">
Junio C Hamano1cc68cc2025-08-04 16:37:24[diff] [blame]979Last updated 2025-06-20 18:10:42 -0700
Junio C Hamanob96f40a2024-08-01 00:57:25[diff] [blame]980</div>
981</div>
982</body>
983</html>