gitprotocol-pack.html

   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"/>
   7 <meta name="generator" content="Asciidoctor 2.0.20"/>
   8 <title>gitprotocol-pack(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"; */
  14 html{font-family:sans-serif;-webkit-text-size-adjust:100%}
  15 a{background:none}
  16 a:focus{outline:thin dotted}
  17 a:active,a:hover{outline:0}
  18 h1{font-size:2em;margin:.67em 0}
  19 b,strong{font-weight:bold}
  20 abbr{font-size:.9em}
  21 abbr[title]{cursor:help;border-bottom:1px dotted #dddddf;text-decoration:none}
  22 dfn{font-style:italic}
  23 hr{height:0}
  24 mark{background:#ff0;color:#000}
  25 code,kbd,pre,samp{font-family:monospace;font-size:1em}
  26 pre{white-space:pre-wrap}
  27 q{quotes:"\201C" "\201D" "\2018" "\2019"}
  28 small{font-size:80%}
  29 sub,sup{font-size:75%;line-height:0;position:relative;vertical-align:baseline}
  30 sup{top:-.5em}
  31 sub{bottom:-.25em}
  32 img{border:0}
  33 svg:not(:root){overflow:hidden}
  34 figure{margin:0}
  35 audio,video{display:inline-block}
  36 audio:not([controls]){display:none;height:0}
  37 fieldset{border:1px solid silver;margin:0 2px;padding:.35em .625em .75em}
  38 legend{border:0;padding:0}
  39 button,input,select,textarea{font-family:inherit;font-size:100%;margin:0}
  40 button,input{line-height:normal}
  41 button,select{text-transform:none}
  42 button,html input[type=button],input[type=reset],input[type=submit]{-webkit-appearance:button;cursor:pointer}
  43 button[disabled],html input[disabled]{cursor:default}
  44 input[type=checkbox],input[type=radio]{padding:0}
  45 button::-moz-focus-inner,input::-moz-focus-inner{border:0;padding:0}
  46 textarea{overflow:auto;vertical-align:top}
  47 table{border-collapse:collapse;border-spacing:0}
  48 *,::before,::after{box-sizing:border-box}
  49 html,body{font-size:100%}
  50 body{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}
  51 a:hover{cursor:pointer}
  52 img,object,embed{max-width:100%;height:auto}
  53 object,embed{height:100%}
  54 img{-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}
  62 img,object,svg{display:inline-block;vertical-align:middle}
  63 textarea{height:auto;min-height:50px}
  64 select{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}
  66 div,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}
  67 a{color:#2156a5;text-decoration:underline;line-height:inherit}
  68 a:hover,a:focus{color:#1d4b8f}
  69 a img{border:0}
  70 p{line-height:1.6;margin-bottom:1.25em;text-rendering:optimizeLegibility}
  71 p aside{font-size:.875em;line-height:1.35;font-style:italic}
  72 h1,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}
  73 h1 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}
  74 h1{font-size:2.125em}
  75 h2{font-size:1.6875em}
  76 h3,#toctitle,.sidebarblock>.content>.title{font-size:1.375em}
  77 h4,h5{font-size:1.125em}
  78 h6{font-size:1em}
  79 hr{border:solid #dddddf;border-width:1px 0 0;clear:both;margin:1.25em 0 1.1875em}
  80 em,i{font-style:italic;line-height:inherit}
  81 strong,b{font-weight:bold;line-height:inherit}
  82 small{font-size:60%;line-height:inherit}
  83 code{font-family:"Droid Sans Mono","DejaVu Sans Mono",monospace;font-weight:400;color:rgba(0,0,0,.9)}
  84 ul,ol,dl{line-height:1.6;margin-bottom:1.25em;list-style-position:outside;font-family:inherit}
  85 ul,ol{margin-left:1.5em}
  86 ul li ul,ul li ol{margin-left:1.25em;margin-bottom:0}
  87 ul.circle{list-style-type:circle}
  88 ul.disc{list-style-type:disc}
  89 ul.square{list-style-type:square}
  90 ul.circle ul:not([class]),ul.disc ul:not([class]),ul.square ul:not([class]){list-style:inherit}
  91 ol li ul,ol li ol{margin-left:1.25em;margin-bottom:0}
  92 dl dt{margin-bottom:.3125em;font-weight:bold}
  93 dl dd{margin-bottom:1.25em}
  94 blockquote{margin:0 0 1.25em;padding:.5625em 1.25em 0 1.1875em;border-left:1px solid #ddd}
  95 blockquote,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}
  97 h1{font-size:2.75em}
  98 h2{font-size:2.3125em}
  99 h3,#toctitle,.sidebarblock>.content>.title{font-size:1.6875em}
 100 h4{font-size:1.4375em}}
 101 table{background:#fff;margin-bottom:1.25em;border:1px solid #dedede;word-wrap:normal}
 102 table thead,table tfoot{background:#f7f8f7}
 103 table 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}
 104 table tr th,table tr td{padding:.5625em .625em;font-size:inherit;color:rgba(0,0,0,.8)}
 105 table tr.even,table tr.alt{background:#f8f8f7}
 106 table thead tr th,table tfoot tr th,table tbody tr td,table tr td,table tfoot tr td{line-height:1.6}
 107 h1,h2,h3,#toctitle,.sidebarblock>.content>.title,h4,h5,h6{line-height:1.2;word-spacing:-.05em}
 108 h1 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}
 117 pre{color:rgba(0,0,0,.9);font-family:"Droid Sans Mono","DejaVu Sans Mono",monospace;line-height:1.45;text-rendering:optimizeSpeed}
 118 pre code,pre pre{color:inherit;font-size:inherit;line-height:inherit}
 119 pre>code{display:block}
 120 pre.nowrap,pre.nowrap pre{white-space:pre;word-wrap:normal}
 121 em em{font-style:normal}
 122 strong strong{font-weight:400}
 123 .keyseq{color:rgba(51,51,51,.8)}
 124 kbd{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}
 132 b.button::before,b.button::after{position:relative;top:-1px;font-weight:400}
 133 b.button::before{content:"[";padding:0 3px 0 2px}
 134 b.button::after{content:"]";padding:0 2px 0 3px}
 135 p 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}
 143 #header>h1:only-child,body.toc2 #header>h1:nth-last-child(2){border-bottom:1px solid #dddddf;padding-bottom:8px}
 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}
 164 body.toc2{padding-left:15em;padding-right:0}
 165 #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}
 166 #toc.toc2 #toctitle{margin-top:0;margin-bottom:.8rem;font-size:1.2em}
 167 #toc.toc2>ul{font-size:.9em;margin-bottom:0}
 168 #toc.toc2 ul ul{margin-left:0;padding-left:1em}
 169 #toc.toc2 ul.sectlevel0 ul.sectlevel1{padding-left:0;margin-top:.5em;margin-bottom:.5em}
 170 body.toc2.toc-right{padding-left:0;padding-right:15em}
 171 body.toc2.toc-right #toc.toc2{border-right-width:0;border-left:1px solid #e7e7e9;left:auto;right:0}}
 172 @media screen and (min-width:1280px){body.toc2{padding-left:20em;padding-right:0}
 173 #toc.toc2{width:20em}
 174 #toc.toc2 #toctitle{font-size:1.375em}
 175 #toc.toc2>ul{font-size:.95em}
 176 #toc.toc2 ul ul{padding-left:1.25em}
 177 body.toc2.toc-right{padding-left:0;padding-right:20em}}
 178 #content #toc{border:1px solid #e0e0dc;margin-bottom:1.25em;padding:1.25em;background:#f8f8f7;border-radius:4px}
 179 #content #toc>:first-child{margin-top:0}
 180 #content #toc>:last-child{margin-bottom:0}
 181 #footer{max-width:none;background:rgba(0,0,0,.8);padding:1.25em}
 182 #footer-text{color:hsla(0,0%,100%,.8);line-height:1.44}
 183 #content{margin-bottom:.625em}
 184 .sect1{padding-bottom:.625em}
 185 @media screen and (min-width:768px){#content{margin-bottom:1.25em}
 186 .sect1{padding-bottom:1.25em}}
 187 .sect1:last-child{padding-bottom:0}
 188 .sect1+.sect1{border-top:1px solid #e7e7e9}
 189 #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}
 190 #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}
 191 #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}
 192 #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}
 193 #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}
 194 details,.audioblock,.imageblock,.literalblock,.listingblock,.stemblock,.videoblock{margin-bottom:1.25em}
 195 details{margin-left:1.25rem}
 196 details>summary{cursor:pointer;display:block;position:relative;line-height:1.6;margin-bottom:.625rem;outline:none;-webkit-tap-highlight-color:transparent}
 197 details>summary::-webkit-details-marker{display:none}
 198 details>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%)}
 199 details[open]>summary::before{border:solid transparent;border-top:solid;border-width:.5em .3em 0;transform:translateY(15%)}
 200 details>summary::after{content:"";width:1.25rem;height:1em;position:absolute;top:.3em;left:-1.25rem}
 201 .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}
 202 table.tableblock.fit-content>caption.title{white-space:nowrap;width:0}
 203 .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)}
 204 .admonitionblock>table{border-collapse:separate;border:0;background:none;width:100%}
 205 .admonitionblock>table td.icon{text-align:center;width:80px}
 206 .admonitionblock>table td.icon img{max-width:none}
 207 .admonitionblock>table td.icon .title{font-weight:bold;font-family:"Open Sans","DejaVu Sans",sans-serif;text-transform:uppercase}
 208 .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}
 209 .admonitionblock>table td.content>:last-child>:last-child{margin-bottom:0}
 210 .exampleblock>.content{border:1px solid #e6e6e6;margin-bottom:1.25em;padding:1.25em;background:#fff;border-radius:4px}
 211 .sidebarblock{border:1px solid #dbdbd6;margin-bottom:1.25em;padding:1.25em;background:#f3f3f2;border-radius:4px}
 212 .sidebarblock>.content>.title{color:#7a2518;margin-top:0;text-align:center}
 213 .exampleblock>.content>:first-child,.sidebarblock>.content>:first-child{margin-top:0}
 214 .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}
 215 .literalblock pre,.listingblock>.content>pre{border-radius:4px;overflow-x:auto;padding:1em;font-size:.8125em}
 216 @media screen and (min-width:768px){.literalblock pre,.listingblock>.content>pre{font-size:.90625em}}
 217 @media screen and (min-width:1280px){.literalblock pre,.listingblock>.content>pre{font-size:1em}}
 218 .literalblock pre,.listingblock>.content>pre:not(.highlight),.listingblock>.content>pre[class=highlight],.listingblock>.content>pre[class^="highlight "]{background:#f7f7f8}
 219 .literalblock.output pre{color:#f7f7f8;background:rgba(0,0,0,.9)}
 220 .listingblock>.content{position:relative}
 221 .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}
 222 .listingblock:hover code[data-lang]::before{display:block}
 223 .listingblock.terminal pre .command::before{content:attr(data-prompt);padding-right:.5em;color:inherit;opacity:.5}
 224 .listingblock.terminal pre .command:not([data-prompt])::before{content:"$"}
 225 .listingblock pre.highlightjs{padding:0}
 226 .listingblock pre.highlightjs>code{padding:1em;border-radius:4px}
 227 .listingblock pre.prettyprint{border-width:0}
 228 .prettyprint{background:#f7f7f8}
 229 pre.prettyprint .linenums{line-height:1.45;margin-left:2em}
 230 pre.prettyprint li{background:none;list-style-type:inherit;padding-left:0}
 231 pre.prettyprint li code[data-lang]::before{opacity:1}
 232 pre.prettyprint li:not(:first-child) code[data-lang]::before{display:none}
 233 table.linenotable{border-collapse:separate;border:0;margin-bottom:0;background:none}
 234 table.linenotable td[class]{color:inherit;vertical-align:top;padding:0;line-height:inherit;white-space:normal}
 235 table.linenotable td.code{padding-left:.75em}
 236 table.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}
 237 pre.pygments span.linenos{display:inline-block;margin-right:.75em}
 238 .quoteblock{margin:0 1em 1.25em 1.5em;display:table}
 239 .quoteblock:not(.excerpt)>.title{margin-left:-1.5em;margin-bottom:.75em}
 240 .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}
 241 .quoteblock blockquote{margin:0;padding:0;border:0}
 242 .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)}
 243 .quoteblock blockquote>.paragraph:last-child p{margin-bottom:0}
 244 .quoteblock .attribution{margin-top:.75em;margin-right:.5ex;text-align:right}
 245 .verseblock{margin:0 1em 1.25em}
 246 .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}
 247 .verseblock pre strong{font-weight:400}
 248 .verseblock .attribution{margin-top:1.25rem;margin-left:.5ex}
 249 .quoteblock .attribution,.verseblock .attribution{font-size:.9375em;line-height:1.45;font-style:italic}
 250 .quoteblock .attribution br,.verseblock .attribution br{display:none}
 251 .quoteblock .attribution cite,.verseblock .attribution cite{display:block;letter-spacing:-.025em;color:rgba(0,0,0,.6)}
 252 .quoteblock.abstract blockquote::before,.quoteblock.excerpt blockquote::before,.quoteblock .quoteblock blockquote::before{display:none}
 253 .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}
 254 .quoteblock.abstract{margin:0 1em 1.25em;display:block}
 255 .quoteblock.abstract>.title{margin:0 0 .375em;font-size:1.15em;text-align:center}
 256 .quoteblock.excerpt>blockquote,.quoteblock .quoteblock{padding:0 0 .25em 1em;border-left:.25em solid #dddddf}
 257 .quoteblock.excerpt,.quoteblock .quoteblock{margin-left:0}
 258 .quoteblock.excerpt blockquote,.quoteblock.excerpt p,.quoteblock .quoteblock blockquote,.quoteblock .quoteblock p{color:inherit;font-size:1.0625rem}
 259 .quoteblock.excerpt .attribution,.quoteblock .quoteblock .attribution{color:inherit;font-size:.85rem;text-align:left;margin-right:0}
 260 p.tableblock:last-child{margin-bottom:0}
 261 td.tableblock>.content{margin-bottom:1.25em;word-wrap:anywhere}
 262 td.tableblock>.content>:last-child{margin-bottom:-1.25em}
 263 table.tableblock,th.tableblock,td.tableblock{border:0 solid #dedede}
 264 table.grid-all>*>tr>*{border-width:1px}
 265 table.grid-cols>*>tr>*{border-width:0 1px}
 266 table.grid-rows>*>tr>*{border-width:1px 0}
 267 table.frame-all{border-width:1px}
 268 table.frame-ends{border-width:1px 0}
 269 table.frame-sides{border-width:0 1px}
 270 table.frame-none>colgroup+*>:first-child>*,table.frame-sides>colgroup+*>:first-child>*{border-top-width:0}
 271 table.frame-none>:last-child>:last-child>*,table.frame-sides>:last-child>:last-child>*{border-bottom-width:0}
 272 table.frame-none>*>tr>:first-child,table.frame-ends>*>tr>:first-child{border-left-width:0}
 273 table.frame-none>*>tr>:last-child,table.frame-ends>*>tr>:last-child{border-right-width:0}
 274 table.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}
 275 th.halign-left,td.halign-left{text-align:left}
 276 th.halign-right,td.halign-right{text-align:right}
 277 th.halign-center,td.halign-center{text-align:center}
 278 th.valign-top,td.valign-top{vertical-align:top}
 279 th.valign-bottom,td.valign-bottom{vertical-align:bottom}
 280 th.valign-middle,td.valign-middle{vertical-align:middle}
 281 table thead th,table tfoot th{font-weight:bold}
 282 tbody tr th{background:#f7f8f7}
 283 tbody tr th,tbody tr th p,tfoot tr th,tfoot tr th p{color:rgba(0,0,0,.8);font-weight:bold}
 284 p.tableblock>code:only-child{background:none;padding:0}
 285 p.tableblock{font-size:1em}
 286 ol{margin-left:1.75em}
 287 ul li ol{margin-left:1.5em}
 288 dl dd{margin-left:1.125em}
 289 dl dd:last-child,dl dd:last-child>:last-child{margin-bottom:0}
 290 li p,ul dd,ol dd,.olist .olist,.ulist .ulist,.ulist .olist,.olist .ulist{margin-bottom:.625em}
 291 ul.checklist,ul.none,ol.none,ul.no-bullet,ol.no-bullet,ol.unnumbered,ul.unstyled,ol.unstyled{list-style-type:none}
 292 ul.no-bullet,ol.no-bullet,ol.unnumbered{margin-left:.625em}
 293 ul.unstyled,ol.unstyled{margin-left:0}
 294 li>p:empty:only-child::before{content:"";display:inline-block}
 295 ul.checklist>li>p:first-child{margin-left:-1em}
 296 ul.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}
 297 ul.checklist>li>p:first-child>input[type=checkbox]:first-child{margin-right:.25em}
 298 ul.inline{display:flex;flex-flow:row wrap;list-style:none;margin:0 0 .625em -1.25em}
 299 ul.inline>li{margin-left:1.25em}
 300 .unstyled dl dt{font-weight:400;font-style:normal}
 301 ol.arabic{list-style-type:decimal}
 302 ol.decimal{list-style-type:decimal-leading-zero}
 303 ol.loweralpha{list-style-type:lower-alpha}
 304 ol.upperalpha{list-style-type:upper-alpha}
 305 ol.lowerroman{list-style-type:lower-roman}
 306 ol.upperroman{list-style-type:upper-roman}
 307 ol.lowergreek{list-style-type:lower-greek}
 308 .hdlist>table,.colist>table{border:0;background:none}
 309 .hdlist>table>tbody>tr,.colist>table>tbody>tr{background:none}
 310 td.hdlist1,td.hdlist2{vertical-align:top;padding:0 .625em}
 311 td.hdlist1{font-weight:bold;padding-bottom:1.25em}
 312 td.hdlist2{word-wrap:anywhere}
 313 .literalblock+.colist,.listingblock+.colist{margin-top:-.5em}
 314 .colist td:not([class]):first-child{padding:.4em .75em 0;line-height:1;vertical-align:top}
 315 .colist td:not([class]):first-child img{max-width:none}
 316 .colist td:not([class]):last-child{padding:.25em 0}
 317 .thumb,.th{line-height:0;display:inline-block;border:4px solid #fff;box-shadow:0 0 0 1px #ddd}
 318 .imageblock.left{margin:.25em .625em 1.25em 0}
 319 .imageblock.right{margin:.25em 0 1.25em .625em}
 320 .imageblock>.title{margin-bottom:0}
 321 .imageblock.thumb,.imageblock.th{border-width:6px}
 322 .imageblock.thumb>.title,.imageblock.th>.title{padding:0 .125em}
 323 .image.left,.image.right{margin-top:.25em;margin-bottom:.25em;display:inline-block;line-height:0}
 324 .image.left{margin-right:.625em}
 325 .image.right{margin-left:.625em}
 326 a.image{text-decoration:none;display:inline-block}
 327 a.image object{pointer-events:none}
 328 sup.footnote,sup.footnoteref{font-size:.875em;position:static;vertical-align:super}
 329 sup.footnote a,sup.footnoteref a{text-decoration:none}
 330 sup.footnote a:active,sup.footnoteref a:active{text-decoration:underline}
 331 #footnotes{padding-top:.75em;padding-bottom:.75em;margin-bottom:.625em}
 332 #footnotes hr{width:20%;min-width:6.25em;margin:-.25em 0 .75em;border-width:1px 0 0}
 333 #footnotes .footnote{padding:0 .375em 0 .225em;line-height:1.3334;font-size:.875em;margin-left:1.2em;margin-bottom:.2em}
 334 #footnotes .footnote a:first-of-type{font-weight:bold;text-decoration:none;margin-left:-1.05em}
 335 #footnotes .footnote:last-of-type{margin-bottom:0}
 336 #content #footnotes{margin-top:-.625em;margin-bottom:0;padding:.75em 0}
 337 div.unbreakable{page-break-inside:avoid}
 338 .big{font-size:larger}
 339 .small{font-size:smaller}
 340 .underline{text-decoration:underline}
 341 .overline{text-decoration:overline}
 342 .line-through{text-decoration:line-through}
 343 .aqua{color:#00bfbf}
 344 .aqua-background{background:#00fafa}
 345 .black{color:#000}
 346 .black-background{background:#000}
 347 .blue{color:#0000bf}
 348 .blue-background{background:#0000fa}
 349 .fuchsia{color:#bf00bf}
 350 .fuchsia-background{background:#fa00fa}
 351 .gray{color:#606060}
 352 .gray-background{background:#7d7d7d}
 353 .green{color:#006000}
 354 .green-background{background:#007d00}
 355 .lime{color:#00bf00}
 356 .lime-background{background:#00fa00}
 357 .maroon{color:#600000}
 358 .maroon-background{background:#7d0000}
 359 .navy{color:#000060}
 360 .navy-background{background:#00007d}
 361 .olive{color:#606000}
 362 .olive-background{background:#7d7d00}
 363 .purple{color:#600060}
 364 .purple-background{background:#7d007d}
 365 .red{color:#bf0000}
 366 .red-background{background:#fa0000}
 367 .silver{color:#909090}
 368 .silver-background{background:#bcbcbc}
 369 .teal{color:#006060}
 370 .teal-background{background:#007d7d}
 371 .white{color:#bfbfbf}
 372 .white-background{background:#fafafa}
 373 .yellow{color:#bfbf00}
 374 .yellow-background{background:#fafa00}
 375 span.icon>.fa{cursor:default}
 376 a span.icon>.fa{cursor:inherit}
 377 .admonitionblock td.icon [class^="fa icon-"]{font-size:2.5em;text-shadow:1px 1px 2px rgba(0,0,0,.5);cursor:default}
 378 .admonitionblock td.icon .icon-note::before{content:"\f05a";color:#19407c}
 379 .admonitionblock td.icon .icon-tip::before{content:"\f0eb";text-shadow:1px 1px 2px rgba(155,155,0,.8);color:#111}
 380 .admonitionblock td.icon .icon-warning::before{content:"\f071";color:#bf6900}
 381 .admonitionblock td.icon .icon-caution::before{content:"\f06d";color:#bf3400}
 382 .admonitionblock td.icon .icon-important::before{content:"\f06a";color:#bf0000}
 383 .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}
 384 .conum[data-value] *{color:#fff!important}
 385 .conum[data-value]+b{display:none}
 386 .conum[data-value]::after{content:attr(data-value)}
 387 pre .conum[data-value]{position:relative;top:-.125em}
 388 b.conum *{color:inherit!important}
 389 .conum:not([data-value]):empty{display:none}
 390 dt,th.tableblock,td.content,div.footnote{text-rendering:optimizeLegibility}
 391 h1,h2,p,td.content,span.alt,summary{letter-spacing:-.01em}
 392 p strong,td.content strong,div.footnote strong{letter-spacing:-.005em}
 393 p,blockquote,dt,td.content,td.hdlist1,span.alt,summary{font-size:1.0625rem}
 394 p{margin-bottom:1.25rem}
 395 .sidebarblock p,.sidebarblock dt,.sidebarblock td.content,p.tableblock{font-size:1em}
 396 .exampleblock>.content{background:#fffef7;border-color:#e0e0dc;box-shadow:0 1px 4px #e0e0dc}
 397 .print-only{display:none!important}
 398 @page{margin:1.25cm .75cm}
 399 @media print{*{box-shadow:none!important;text-shadow:none!important}
 400 html{font-size:80%}
 401 a{color:inherit!important;text-decoration:underline!important}
 402 a.bare,a[href^="#"],a[href^="mailto:"]{text-decoration:none!important}
 403 a[href^="http:"]:not(.bare)::after,a[href^="https:"]:not(.bare)::after{content:"(" attr(href) ")";display:inline-block;font-size:.875em;padding-left:.25em}
 404 abbr[title]{border-bottom:1px dotted}
 405 abbr[title]::after{content:" (" attr(title) ")"}
 406 pre,blockquote,tr,img,object,svg{page-break-inside:avoid}
 407 thead{display:table-header-group}
 408 svg{max-width:100%}
 409 p,blockquote,dt,td.content{font-size:1em;orphans:3;widows:3}
 410 h2,h3,#toctitle,.sidebarblock>.content>.title{page-break-after:avoid}
 411 #header,#content,#footnotes,#footer{max-width:none}
 412 #toc,.sidebarblock,.exampleblock>.content{background:none!important}
 413 #toc{border-bottom:1px solid #dddddf!important;padding-bottom:0!important}
 414 body.book #header{text-align:center}
 415 body.book #header>h1:first-child{border:0!important;margin:2.5em 0 1em}
 416 body.book #header .details{border:0!important;display:block;padding:0!important}
 417 body.book #header .details span:first-child{margin-left:0!important}
 418 body.book #header .details br{display:block}
 419 body.book #header .details br+span::before{content:none!important}
 420 body.book #toc{border:0!important;text-align:left!important;padding:0!important;margin:0!important}
 421 body.book #toc,body.book #preamble,body.book h1.sect0,body.book .sect1>h2{page-break-before:always}
 422 .listingblock code[data-lang]::before{display:block}
 423 #footer{padding:0 .9375em}
 424 .hide-on-print{display:none!important}
 425 .print-only{display:block!important}
 426 .hide-for-print{display:none!important}
 427 .show-for-print{display:inherit!important}}
 428 @media amzn-kf8,print{#header>h1:first-child{margin-top:1.25rem}
 429 .sect1{padding:0!important}
 430 .sect1+.sect1{border:0}
 431 #footer{background:none}
 432 #footer-text{color:rgba(0,0,0,.6);font-size:.9em}}
 433 @media amzn-kf8{#header,#content,#footnotes,#footer{padding:0}}
 434 </style>
 435 <style>
 436 pre>code {
 437    display: inline;
 438 }
 439 </style>
 440 </head>
 441 <body class="manpage">
 442 <div id="header">
 443 <h1>gitprotocol-pack(5) Manual Page</h1>
 444 <h2 id="_name">NAME</h2>
 445 <div class="sectionbody">
 446 <p>gitprotocol-pack - How packs are transferred over-the-wire</p>
 447 </div>
 448 </div>
 449 <div id="content">
 450 <div class="sect1">
 451 <h2 id="_synopsis">SYNOPSIS</h2>
 452 <div class="sectionbody">
 453 <div class="verseblock">
 454 <pre class="content">&lt;over-the-wire-protocol&gt;</pre>
 455 </div>
 456 </div>
 457 </div>
 458 <div class="sect1">
 459 <h2 id="_description">DESCRIPTION</h2>
 460 <div class="sectionbody">
 461 <div class="paragraph">
 462 <p>Git supports transferring data in packfiles over the ssh://, git://, http:// and
 463 file:// transports.  There exist two sets of protocols, one for pushing
 464 data from a client to a server and another for fetching data from a
 465 server to a client.  The three transports (ssh, git, file) use the same
 466 protocol to transfer data. http is documented in <a href="gitprotocol-http.html">gitprotocol-http(5)</a>.</p>
 467 </div>
 468 <div class="paragraph">
 469 <p>The processes invoked in the canonical Git implementation are <em>upload-pack</em>
 470 on the server side and <em>fetch-pack</em> on the client side for fetching data;
 471 then <em>receive-pack</em> on the server and <em>send-pack</em> on the client for pushing
 472 data.  The protocol functions to have a server tell a client what is
 473 currently on the server, then for the two to negotiate the smallest amount
 474 of data to send in order to fully update one or the other.</p>
 475 </div>
 476 </div>
 477 </div>
 478 <div class="sect1">
 479 <h2 id="_pkt_line_format">pkt-line Format</h2>
 480 <div class="sectionbody">
 481 <div class="paragraph">
 482 <p>The descriptions below build on the pkt-line format described in
 483 <a href="gitprotocol-common.html">gitprotocol-common(5)</a>. When the grammar indicates <code>PKT-LINE</code>(<code>...</code>), unless
 484 otherwise noted the usual pkt-line LF rules apply: the sender SHOULD
 485 include a LF, but the receiver MUST NOT complain if it is not present.</p>
 486 </div>
 487 <div class="paragraph">
 488 <p>An error packet is a special pkt-line that contains an error string.</p>
 489 </div>
 490 <div class="listingblock">
 491 <div class="content">
 492 <pre>  error-line     =  PKT-LINE("ERR" SP explanation-text)</pre>
 493 </div>
 494 </div>
 495 <div class="paragraph">
 496 <p>Throughout the protocol, where <code>PKT-LINE</code>(<code>...</code>) is expected, an error packet MAY
 497 be sent. Once this packet is sent by a client or a server, the data transfer
 498 process defined in this protocol is terminated.</p>
 499 </div>
 500 </div>
 501 </div>
 502 <div class="sect1">
 503 <h2 id="_transports">Transports</h2>
 504 <div class="sectionbody">
 505 <div class="paragraph">
 506 <p>There are three transports over which the packfile protocol is
 507 initiated.  The Git transport is a simple, unauthenticated server that
 508 takes the command (almost always <em>upload-pack</em>, though Git
 509 servers can be configured to be globally writable, in which <em>receive-
 510 pack</em> initiation is also allowed) with which the client wishes to
 511 communicate and executes it and connects it to the requesting
 512 process.</p>
 513 </div>
 514 <div class="paragraph">
 515 <p>In the SSH transport, the client just runs the <em>upload-pack</em>
 516 or <em>receive-pack</em> process on the server over the SSH protocol and then
 517 communicates with that invoked process over the SSH connection.</p>
 518 </div>
 519 <div class="paragraph">
 520 <p>The file:// transport runs the <em>upload-pack</em> or <em>receive-pack</em>
 521 process locally and communicates with it over a pipe.</p>
 522 </div>
 523 </div>
 524 </div>
 525 <div class="sect1">
 526 <h2 id="_extra_parameters">Extra Parameters</h2>
 527 <div class="sectionbody">
 528 <div class="paragraph">
 529 <p>The protocol provides a mechanism in which clients can send additional
 530 information in its first message to the server. These are called "Extra
 531 Parameters", and are supported by the Git, SSH, and HTTP protocols.</p>
 532 </div>
 533 <div class="paragraph">
 534 <p>Each Extra Parameter takes the form of <em>&lt;key&gt;</em><code>=</code><em>&lt;value&gt;</em> or <em>&lt;key&gt;</em>.</p>
 535 </div>
 536 <div class="paragraph">
 537 <p>Servers that receive any such Extra Parameters MUST ignore all
 538 unrecognized keys. Currently, the only Extra Parameter recognized is
 539 "version" with a value of <em>1</em> or <em>2</em>.  See <a href="gitprotocol-v2.html">gitprotocol-v2(5)</a> for more
 540 information on protocol version 2.</p>
 541 </div>
 542 </div>
 543 </div>
 544 <div class="sect1">
 545 <h2 id="_git_transport">Git Transport</h2>
 546 <div class="sectionbody">
 547 <div class="paragraph">
 548 <p>The Git transport starts off by sending the command and repository
 549 on the wire using the pkt-line format, followed by a NUL byte and a
 550 hostname parameter, terminated by a NUL byte.</p>
 551 </div>
 552 <div class="literalblock">
 553 <div class="content">
 554 <pre>0033git-upload-pack /project.git\0host=myserver.com\0</pre>
 555 </div>
 556 </div>
 557 <div class="paragraph">
 558 <p>The transport may send Extra Parameters by adding an additional NUL
 559 byte, and then adding one or more NUL-terminated strings:</p>
 560 </div>
 561 <div class="literalblock">
 562 <div class="content">
 563 <pre>003egit-upload-pack /project.git\0host=myserver.com\0\0version=1\0</pre>
 564 </div>
 565 </div>
 566 <div class="openblock">
 567 <div class="content">
 568 <div class="literalblock">
 569 <div class="content">
 570 <pre>git-proto-request = request-command SP pathname NUL
 571       [ host-parameter NUL ] [ NUL extra-parameters ]
 572 request-command   = "git-upload-pack" / "git-receive-pack" /
 573       "git-upload-archive"   ; case sensitive
 574 pathname          = *( %x01-ff ) ; exclude NUL
 575 host-parameter    = "host=" hostname [ ":" port ]
 576 extra-parameters  = 1*extra-parameter
 577 extra-parameter   = 1*( %x01-ff ) NUL</pre>
 578 </div>
 579 </div>
 580 </div>
 581 </div>
 582 <div class="paragraph">
 583 <p>host-parameter is used for the
 584 git-daemon name based virtual hosting.  See --interpolated-path
 585 option to git daemon, with the %H/%CH format characters.</p>
 586 </div>
 587 <div class="paragraph">
 588 <p>Basically what the Git client is doing to connect to an <em>upload-pack</em>
 589 process on the server side over the Git protocol is this:</p>
 590 </div>
 591 <div class="literalblock">
 592 <div class="content">
 593 <pre>$ echo -e -n \
 594   "003agit-upload-pack /schacon/gitbook.git\0host=example.com\0" |
 595   nc -v example.com 9418</pre>
 596 </div>
 597 </div>
 598 </div>
 599 </div>
 600 <div class="sect1">
 601 <h2 id="_ssh_transport">SSH Transport</h2>
 602 <div class="sectionbody">
 603 <div class="paragraph">
 604 <p>Initiating the upload-pack or receive-pack processes over SSH is
 605 executing the binary on the server via SSH remote execution.
 606 It is basically equivalent to running this:</p>
 607 </div>
 608 <div class="literalblock">
 609 <div class="content">
 610 <pre>$ ssh git.example.com "git-upload-pack '/project.git'"</pre>
 611 </div>
 612 </div>
 613 <div class="paragraph">
 614 <p>For a server to support Git pushing and pulling for a given user over
 615 SSH, that user needs to be able to execute one or both of those
 616 commands via the SSH shell that they are provided on login.  On some
 617 systems, that shell access is limited to only being able to run those
 618 two commands, or even just one of them.</p>
 619 </div>
 620 <div class="paragraph">
 621 <p>In an ssh:// format URI, it&#8217;s absolute in the URI, so the <em>/</em> after
 622 the host name (or port number) is sent as an argument, which is then
 623 read by the remote git-upload-pack exactly as is, so it&#8217;s effectively
 624 an absolute path in the remote filesystem.</p>
 625 </div>
 626 <div class="literalblock">
 627 <div class="content">
 628 <pre>   git clone ssh://user@example.com/project.git
 629   |
 630   v
 631 ssh user@example.com "git-upload-pack '/project.git'"</pre>
 632 </div>
 633 </div>
 634 <div class="paragraph">
 635 <p>In a "user@host:path" format URI, it&#8217;s relative to the user&#8217;s home
 636 directory, because the Git client will run:</p>
 637 </div>
 638 <div class="literalblock">
 639 <div class="content">
 640 <pre>   git clone user@example.com:project.git
 641     |
 642     v
 643 ssh user@example.com "git-upload-pack 'project.git'"</pre>
 644 </div>
 645 </div>
 646 <div class="paragraph">
 647 <p>The exception is if a <em>~</em> is used, in which case
 648 we execute it without the leading <em>/</em>.</p>
 649 </div>
 650 <div class="literalblock">
 651 <div class="content">
 652 <pre>   ssh://user@example.com/~alice/project.git,
 653     |
 654     v
 655 ssh user@example.com "git-upload-pack '~alice/project.git'"</pre>
 656 </div>
 657 </div>
 658 <div class="paragraph">
 659 <p>Depending on the value of the <code>protocol.version</code> configuration variable,
 660 Git may attempt to send Extra Parameters as a colon-separated string in
 661 the GIT_PROTOCOL environment variable. This is done only if
 662 the <code>ssh.variant</code> configuration variable indicates that the ssh command
 663 supports passing environment variables as an argument.</p>
 664 </div>
 665 <div class="paragraph">
 666 <p>A few things to remember here:</p>
 667 </div>
 668 <div class="ulist">
 669 <ul>
 670 <li>
 671 <p>The "command name" is spelled with dash (e.g. git-upload-pack), but
 672 this can be overridden by the client;</p>
 673 </li>
 674 <li>
 675 <p>The repository path is always quoted with single quotes.</p>
 676 </li>
 677 </ul>
 678 </div>
 679 </div>
 680 </div>
 681 <div class="sect1">
 682 <h2 id="_fetching_data_from_a_server">Fetching Data From a Server</h2>
 683 <div class="sectionbody">
 684 <div class="paragraph">
 685 <p>When one Git repository wants to get data that a second repository
 686 has, the first can <em>fetch</em> from the second.  This operation determines
 687 what data the server has that the client does not then streams that
 688 data down to the client in packfile format.</p>
 689 </div>
 690 </div>
 691 </div>
 692 <div class="sect1">
 693 <h2 id="_reference_discovery">Reference Discovery</h2>
 694 <div class="sectionbody">
 695 <div class="paragraph">
 696 <p>When the client initially connects the server will immediately respond
 697 with a version number (if "version=1" is sent as an Extra Parameter),
 698 and a listing of each reference it has (all branches and tags) along
 699 with the object name that each reference currently points to.</p>
 700 </div>
 701 <div class="literalblock">
 702 <div class="content">
 703 <pre> $ echo -e -n "0045git-upload-pack /schacon/gitbook.git\0host=example.com\0\0version=1\0" |
 704     nc -v example.com 9418
 705  000eversion 1
 706  00887217a7c7e582c46cec22a130adf4b9d7d950fba0 HEAD\0multi_ack thin-pack
 707 side-band side-band-64k ofs-delta shallow no-progress include-tag
 708  00441d3fcd5ced445d1abc402225c0b8a1299641f497 refs/heads/integration
 709  003f7217a7c7e582c46cec22a130adf4b9d7d950fba0 refs/heads/master
 710  003cb88d2441cac0977faf98efc80305012112238d9d refs/tags/v0.9
 711  003c525128480b96c89e6418b1e40909bf6c5b2d580f refs/tags/v1.0
 712  003fe92df48743b7bc7d26bcaabfddde0a1e20cae47c refs/tags/v1.0^{}
 713  0000</pre>
 714 </div>
 715 </div>
 716 <div class="paragraph">
 717 <p>The returned response is a pkt-line stream describing each ref and
 718 its current value.  The stream MUST be sorted by name according to
 719 the C locale ordering.</p>
 720 </div>
 721 <div class="paragraph">
 722 <p>If HEAD is a valid ref, HEAD MUST appear as the first advertised
 723 ref.  If HEAD is not a valid ref, HEAD MUST NOT appear in the
 724 advertisement list at all, but other refs may still appear.</p>
 725 </div>
 726 <div class="paragraph">
 727 <p>The stream MUST include capability declarations behind a NUL on the
 728 first ref. The peeled value of a ref (that is "ref^{}") MUST be
 729 immediately after the ref itself, if presented. A conforming server
 730 MUST peel the ref if it&#8217;s an annotated tag.</p>
 731 </div>
 732 <div class="listingblock">
 733 <div class="content">
 734 <pre>  advertised-refs  =  *1("version 1")
 735                       (no-refs / list-of-refs)
 736                       *shallow
 737                       flush-pkt
 738
 739   no-refs          =  PKT-LINE(zero-id SP "capabilities^{}"
 740                       NUL capability-list)
 741
 742   list-of-refs     =  first-ref *other-ref
 743   first-ref        =  PKT-LINE(obj-id SP refname
 744                       NUL capability-list)
 745
 746   other-ref        =  PKT-LINE(other-tip / other-peeled)
 747   other-tip        =  obj-id SP refname
 748   other-peeled     =  obj-id SP refname "^{}"
 749
 750   shallow          =  PKT-LINE("shallow" SP obj-id)
 751
 752   capability-list  =  capability *(SP capability)
 753   capability       =  1*(LC_ALPHA / DIGIT / "-" / "_")
 754   LC_ALPHA         =  %x61-7A</pre>
 755 </div>
 756 </div>
 757 <div class="paragraph">
 758 <p>Server and client MUST use lowercase for obj-id, both MUST treat obj-id
 759 as case-insensitive.</p>
 760 </div>
 761 <div class="paragraph">
 762 <p>See protocol-capabilities.txt for a list of allowed server capabilities
 763 and descriptions.</p>
 764 </div>
 765 </div>
 766 </div>
 767 <div class="sect1">
 768 <h2 id="_packfile_negotiation">Packfile Negotiation</h2>
 769 <div class="sectionbody">
 770 <div class="paragraph">
 771 <p>After reference and capabilities discovery, the client can decide to
 772 terminate the connection by sending a flush-pkt, telling the server it can
 773 now gracefully terminate, and disconnect, when it does not need any pack
 774 data. This can happen with the ls-remote command, and also can happen when
 775 the client already is up to date.</p>
 776 </div>
 777 <div class="paragraph">
 778 <p>Otherwise, it enters the negotiation phase, where the client and
 779 server determine what the minimal packfile necessary for transport is,
 780 by telling the server what objects it wants, its shallow objects
 781 (if any), and the maximum commit depth it wants (if any).  The client
 782 will also send a list of the capabilities it wants to be in effect,
 783 out of what the server said it could do with the first <em>want</em> line.</p>
 784 </div>
 785 <div class="listingblock">
 786 <div class="content">
 787 <pre>  upload-request    =  want-list
 788                        *shallow-line
 789                        *1depth-request
 790                        [filter-request]
 791                        flush-pkt
 792
 793   want-list         =  first-want
 794                        *additional-want
 795
 796   shallow-line      =  PKT-LINE("shallow" SP obj-id)
 797
 798   depth-request     =  PKT-LINE("deepen" SP depth) /
 799                        PKT-LINE("deepen-since" SP timestamp) /
 800                        PKT-LINE("deepen-not" SP ref)
 801
 802   first-want        =  PKT-LINE("want" SP obj-id SP capability-list)
 803   additional-want   =  PKT-LINE("want" SP obj-id)
 804
 805   depth             =  1*DIGIT
 806
 807   filter-request    =  PKT-LINE("filter" SP filter-spec)</pre>
 808 </div>
 809 </div>
 810 <div class="paragraph">
 811 <p>Clients MUST send all the obj-ids it wants from the reference
 812 discovery phase as <em>want</em> lines. Clients MUST send at least one
 813 <em>want</em> command in the request body. Clients MUST NOT mention an
 814 obj-id in a <em>want</em> command which did not appear in the response
 815 obtained through ref discovery.</p>
 816 </div>
 817 <div class="paragraph">
 818 <p>The client MUST write all obj-ids which it only has shallow copies
 819 of (meaning that it does not have the parents of a commit) as
 820 <em>shallow</em> lines so that the server is aware of the limitations of
 821 the client&#8217;s history.</p>
 822 </div>
 823 <div class="paragraph">
 824 <p>The client now sends the maximum commit history depth it wants for
 825 this transaction, which is the number of commits it wants from the
 826 tip of the history, if any, as a <em>deepen</em> line.  A depth of 0 is the
 827 same as not making a depth request. The client does not want to receive
 828 any commits beyond this depth, nor does it want objects needed only to
 829 complete those commits. Commits whose parents are not received as a
 830 result are defined as shallow and marked as such in the server. This
 831 information is sent back to the client in the next step.</p>
 832 </div>
 833 <div class="paragraph">
 834 <p>The client can optionally request that pack-objects omit various
 835 objects from the packfile using one of several filtering techniques.
 836 These are intended for use with partial clone and partial fetch
 837 operations. An object that does not meet a filter-spec value is
 838 omitted unless explicitly requested in a <em>want</em> line. See <code>rev-list</code>
 839 for possible filter-spec values.</p>
 840 </div>
 841 <div class="paragraph">
 842 <p>Once all the <em>want&#8217;s and 'shallow&#8217;s (and optional 'deepen</em>) are
 843 transferred, clients MUST send a flush-pkt, to tell the server side
 844 that it is done sending the list.</p>
 845 </div>
 846 <div class="paragraph">
 847 <p>Otherwise, if the client sent a positive depth request, the server
 848 will determine which commits will and will not be shallow and
 849 send this information to the client. If the client did not request
 850 a positive depth, this step is skipped.</p>
 851 </div>
 852 <div class="listingblock">
 853 <div class="content">
 854 <pre>  shallow-update   =  *shallow-line
 855                       *unshallow-line
 856                       flush-pkt
 857
 858   shallow-line     =  PKT-LINE("shallow" SP obj-id)
 859
 860   unshallow-line   =  PKT-LINE("unshallow" SP obj-id)</pre>
 861 </div>
 862 </div>
 863 <div class="paragraph">
 864 <p>If the client has requested a positive depth, the server will compute
 865 the set of commits which are no deeper than the desired depth. The set
 866 of commits starts at the client&#8217;s wants.</p>
 867 </div>
 868 <div class="paragraph">
 869 <p>The server writes <em>shallow</em> lines for each
 870 commit whose parents will not be sent as a result. The server writes
 871 an <em>unshallow</em> line for each commit which the client has indicated is
 872 shallow, but is no longer shallow at the currently requested depth
 873 (that is, its parents will now be sent). The server MUST NOT mark
 874 as unshallow anything which the client has not indicated was shallow.</p>
 875 </div>
 876 <div class="paragraph">
 877 <p>Now the client will send a list of the obj-ids it has using <em>have</em>
 878 lines, so the server can make a packfile that only contains the objects
 879 that the client needs. In multi_ack mode, the canonical implementation
 880 will send up to 32 of these at a time, then will send a flush-pkt. The
 881 canonical implementation will skip ahead and send the next 32 immediately,
 882 so that there is always a block of 32 "in-flight on the wire" at a time.</p>
 883 </div>
 884 <div class="listingblock">
 885 <div class="content">
 886 <pre>  upload-haves      =  have-list
 887                        compute-end
 888
 889   have-list         =  *have-line
 890   have-line         =  PKT-LINE("have" SP obj-id)
 891   compute-end       =  flush-pkt / PKT-LINE("done")</pre>
 892 </div>
 893 </div>
 894 <div class="paragraph">
 895 <p>If the server reads <em>have</em> lines, it then will respond by ACKing any
 896 of the obj-ids the client said it had that the server also has. The
 897 server will ACK obj-ids differently depending on which ack mode is
 898 chosen by the client.</p>
 899 </div>
 900 <div class="paragraph">
 901 <p>In multi_ack mode:</p>
 902 </div>
 903 <div class="ulist">
 904 <ul>
 905 <li>
 906 <p>the server will respond with <em>ACK obj-id continue</em> for any common
 907 commits.</p>
 908 </li>
 909 <li>
 910 <p>once the server has found an acceptable common base commit and is
 911 ready to make a packfile, it will blindly ACK all <em>have</em> obj-ids
 912 back to the client.</p>
 913 </li>
 914 <li>
 915 <p>the server will then send a <em>NAK</em> and then wait for another response
 916 from the client - either a <em>done</em> or another list of <em>have</em> lines.</p>
 917 </li>
 918 </ul>
 919 </div>
 920 <div class="paragraph">
 921 <p>In multi_ack_detailed mode:</p>
 922 </div>
 923 <div class="ulist">
 924 <ul>
 925 <li>
 926 <p>the server will differentiate the ACKs where it is signaling
 927 that it is ready to send data with <em>ACK obj-id ready</em> lines, and
 928 signals the identified common commits with <em>ACK obj-id common</em> lines.</p>
 929 </li>
 930 </ul>
 931 </div>
 932 <div class="paragraph">
 933 <p>Without either multi_ack or multi_ack_detailed:</p>
 934 </div>
 935 <div class="ulist">
 936 <ul>
 937 <li>
 938 <p>upload-pack sends "ACK obj-id" on the first common object it finds.
 939 After that it says nothing until the client gives it a "done".</p>
 940 </li>
 941 <li>
 942 <p>upload-pack sends "NAK" on a flush-pkt if no common object
 943 has been found yet.  If one has been found, and thus an ACK
 944 was already sent, it&#8217;s silent on the flush-pkt.</p>
 945 </li>
 946 </ul>
 947 </div>
 948 <div class="paragraph">
 949 <p>After the client has gotten enough ACK responses that it can determine
 950 that the server has enough information to send an efficient packfile
 951 (in the canonical implementation, this is determined when it has received
 952 enough ACKs that it can color everything left in the --date-order queue
 953 as common with the server, or the --date-order queue is empty), or the
 954 client determines that it wants to give up (in the canonical implementation,
 955 this is determined when the client sends 256 <em>have</em> lines without getting
 956 any of them ACKed by the server - meaning there is nothing in common and
 957 the server should just send all of its objects), then the client will send
 958 a <em>done</em> command.  The <em>done</em> command signals to the server that the client
 959 is ready to receive its packfile data.</p>
 960 </div>
 961 <div class="paragraph">
 962 <p>However, the 256 limit <strong>only</strong> turns on in the canonical client
 963 implementation if we have received at least one "ACK %s continue"
 964 during a prior round.  This helps to ensure that at least one common
 965 ancestor is found before we give up entirely.</p>
 966 </div>
 967 <div class="paragraph">
 968 <p>Once the <em>done</em> line is read from the client, the server will either
 969 send a final <em>ACK obj-id</em> or it will send a <em>NAK</em>. <em>obj-id</em> is the object
 970 name of the last commit determined to be common. The server only sends
 971 ACK after <em>done</em> if there is at least one common base and multi_ack or
 972 multi_ack_detailed is enabled. The server always sends NAK after <em>done</em>
 973 if there is no common base found.</p>
 974 </div>
 975 <div class="paragraph">
 976 <p>Instead of <em>ACK</em> or <em>NAK</em>, the server may send an error message (for
 977 example, if it does not recognize an object in a <em>want</em> line received
 978 from the client).</p>
 979 </div>
 980 <div class="paragraph">
 981 <p>Then the server will start sending its packfile data.</p>
 982 </div>
 983 <div class="listingblock">
 984 <div class="content">
 985 <pre>  server-response = *ack_multi ack / nak
 986   ack_multi       = PKT-LINE("ACK" SP obj-id ack_status)
 987   ack_status      = "continue" / "common" / "ready"
 988   ack             = PKT-LINE("ACK" SP obj-id)
 989   nak             = PKT-LINE("NAK")</pre>
 990 </div>
 991 </div>
 992 <div class="paragraph">
 993 <p>A simple clone may look like this (with no <em>have</em> lines):</p>
 994 </div>
 995 <div class="listingblock">
 996 <div class="content">
 997 <pre>   C: 0054want 74730d410fcb6603ace96f1dc55ea6196122532d multi_ack \
 998      side-band-64k ofs-delta\n
 999    C: 0032want 7d1665144a3a975c05f1f43902ddaf084e784dbe\n
1000    C: 0032want 5a3f6be755bbb7deae50065988cbfa1ffa9ab68a\n
1001    C: 0032want 7e47fe2bd8d01d481f44d7af0531bd93d3b21c01\n
1002    C: 0032want 74730d410fcb6603ace96f1dc55ea6196122532d\n
1003    C: 0000
1004    C: 0009done\n
1005
1006    S: 0008NAK\n
1007    S: [PACKFILE]</pre>
1008 </div>
1009 </div>
1010 <div class="paragraph">
1011 <p>An incremental update (fetch) response might look like this:</p>
1012 </div>
1013 <div class="listingblock">
1014 <div class="content">
1015 <pre>   C: 0054want 74730d410fcb6603ace96f1dc55ea6196122532d multi_ack \
1016      side-band-64k ofs-delta\n
1017    C: 0032want 7d1665144a3a975c05f1f43902ddaf084e784dbe\n
1018    C: 0032want 5a3f6be755bbb7deae50065988cbfa1ffa9ab68a\n
1019    C: 0000
1020    C: 0032have 7e47fe2bd8d01d481f44d7af0531bd93d3b21c01\n
1021    C: [30 more have lines]
1022    C: 0032have 74730d410fcb6603ace96f1dc55ea6196122532d\n
1023    C: 0000
1024
1025    S: 003aACK 7e47fe2bd8d01d481f44d7af0531bd93d3b21c01 continue\n
1026    S: 003aACK 74730d410fcb6603ace96f1dc55ea6196122532d continue\n
1027    S: 0008NAK\n
1028
1029    C: 0009done\n
1030
1031    S: 0031ACK 74730d410fcb6603ace96f1dc55ea6196122532d\n
1032    S: [PACKFILE]</pre>
1033 </div>
1034 </div>
1035 </div>
1036 </div>
1037 <div class="sect1">
1038 <h2 id="_packfile_data">Packfile Data</h2>
1039 <div class="sectionbody">
1040 <div class="paragraph">
1041 <p>Now that the client and server have finished negotiation about what
1042 the minimal amount of data that needs to be sent to the client is, the server
1043 will construct and send the required data in packfile format.</p>
1044 </div>
1045 <div class="paragraph">
1046 <p>See <a href="gitformat-pack.html">gitformat-pack(5)</a> for what the packfile itself actually looks like.</p>
1047 </div>
1048 <div class="paragraph">
1049 <p>If <em>side-band</em> or <em>side-band-64k</em> capabilities have been specified by
1050 the client, the server will send the packfile data multiplexed.</p>
1051 </div>
1052 <div class="paragraph">
1053 <p>Each packet starting with the packet-line length of the amount of data
1054 that follows, followed by a single byte specifying the sideband the
1055 following data is coming in on.</p>
1056 </div>
1057 <div class="paragraph">
1058 <p>In <em>side-band</em> mode, it will send up to 999 data bytes plus 1 control
1059 code, for a total of up to 1000 bytes in a pkt-line.  In <em>side-band-64k</em>
1060 mode it will send up to 65519 data bytes plus 1 control code, for a
1061 total of up to 65520 bytes in a pkt-line.</p>
1062 </div>
1063 <div class="paragraph">
1064 <p>The sideband byte will be a <em>1</em>, <em>2</em> or a <em>3</em>. Sideband <em>1</em> will contain
1065 packfile data, sideband <em>2</em> will be used for progress information that the
1066 client will generally print to stderr and sideband <em>3</em> is used for error
1067 information.</p>
1068 </div>
1069 <div class="paragraph">
1070 <p>If no <em>side-band</em> capability was specified, the server will stream the
1071 entire packfile without multiplexing.</p>
1072 </div>
1073 </div>
1074 </div>
1075 <div class="sect1">
1076 <h2 id="_pushing_data_to_a_server">Pushing Data To a Server</h2>
1077 <div class="sectionbody">
1078 <div class="paragraph">
1079 <p>Pushing data to a server will invoke the <em>receive-pack</em> process on the
1080 server, which will allow the client to tell it which references it should
1081 update and then send all the data the server will need for those new
1082 references to be complete.  Once all the data is received and validated,
1083 the server will then update its references to what the client specified.</p>
1084 </div>
1085 </div>
1086 </div>
1087 <div class="sect1">
1088 <h2 id="_authentication">Authentication</h2>
1089 <div class="sectionbody">
1090 <div class="paragraph">
1091 <p>The protocol itself contains no authentication mechanisms.  That is to be
1092 handled by the transport, such as SSH, before the <em>receive-pack</em> process is
1093 invoked.  If <em>receive-pack</em> is configured over the Git transport, those
1094 repositories will be writable by anyone who can access that port (9418) as
1095 that transport is unauthenticated.</p>
1096 </div>
1097 </div>
1098 </div>
1099 <div class="sect1">
1100 <h2 id="_reference_discovery_2">Reference Discovery</h2>
1101 <div class="sectionbody">
1102 <div class="paragraph">
1103 <p>The reference discovery phase is done nearly the same way as it is in the
1104 fetching protocol. Each reference obj-id and name on the server is sent
1105 in packet-line format to the client, followed by a flush-pkt.  The only
1106 real difference is that the capability listing is different - the only
1107 possible values are <em>report-status</em>, <em>report-status-v2</em>, <em>delete-refs</em>,
1108 <em>ofs-delta</em>, <em>atomic</em> and <em>push-options</em>.</p>
1109 </div>
1110 </div>
1111 </div>
1112 <div class="sect1">
1113 <h2 id="_reference_update_request_and_packfile_transfer">Reference Update Request and Packfile Transfer</h2>
1114 <div class="sectionbody">
1115 <div class="paragraph">
1116 <p>Once the client knows what references the server is at, it can send a
1117 list of reference update requests.  For each reference on the server
1118 that it wants to update, it sends a line listing the obj-id currently on
1119 the server, the obj-id the client would like to update it to and the name
1120 of the reference.</p>
1121 </div>
1122 <div class="paragraph">
1123 <p>This list is followed by a flush-pkt.</p>
1124 </div>
1125 <div class="listingblock">
1126 <div class="content">
1127 <pre>  update-requests   =  *shallow ( command-list | push-cert )
1128
1129   shallow           =  PKT-LINE("shallow" SP obj-id)
1130
1131   command-list      =  PKT-LINE(command NUL capability-list)
1132                        *PKT-LINE(command)
1133                        flush-pkt
1134
1135   command           =  create / delete / update
1136   create            =  zero-id SP new-id  SP name
1137   delete            =  old-id  SP zero-id SP name
1138   update            =  old-id  SP new-id  SP name
1139
1140   old-id            =  obj-id
1141   new-id            =  obj-id
1142
1143   push-cert         = PKT-LINE("push-cert" NUL capability-list LF)
1144                       PKT-LINE("certificate version 0.1" LF)
1145                       PKT-LINE("pusher" SP ident LF)
1146                       PKT-LINE("pushee" SP url LF)
1147                       PKT-LINE("nonce" SP nonce LF)
1148                       *PKT-LINE("push-option" SP push-option LF)
1149                       PKT-LINE(LF)
1150                       *PKT-LINE(command LF)
1151                       *PKT-LINE(gpg-signature-lines LF)
1152                       PKT-LINE("push-cert-end" LF)
1153
1154   push-option       =  1*( VCHAR | SP )</pre>
1155 </div>
1156 </div>
1157 <div class="paragraph">
1158 <p>If the server has advertised the <em>push-options</em> capability and the client has
1159 specified <em>push-options</em> as part of the capability list above, the client then
1160 sends its push options followed by a flush-pkt.</p>
1161 </div>
1162 <div class="listingblock">
1163 <div class="content">
1164 <pre>  push-options      =  *PKT-LINE(push-option) flush-pkt</pre>
1165 </div>
1166 </div>
1167 <div class="paragraph">
1168 <p>For backwards compatibility with older Git servers, if the client sends a push
1169 cert and push options, it MUST send its push options both embedded within the
1170 push cert and after the push cert. (Note that the push options within the cert
1171 are prefixed, but the push options after the cert are not.) Both these lists
1172 MUST be the same, modulo the prefix.</p>
1173 </div>
1174 <div class="paragraph">
1175 <p>After that the packfile that
1176 should contain all the objects that the server will need to complete the new
1177 references will be sent.</p>
1178 </div>
1179 <div class="listingblock">
1180 <div class="content">
1181 <pre>  packfile          =  "PACK" 28*(OCTET)</pre>
1182 </div>
1183 </div>
1184 <div class="paragraph">
1185 <p>If the receiving end does not support delete-refs, the sending end MUST
1186 NOT ask for delete command.</p>
1187 </div>
1188 <div class="paragraph">
1189 <p>If the receiving end does not support push-cert, the sending end
1190 MUST NOT send a push-cert command.  When a push-cert command is
1191 sent, command-list MUST NOT be sent; the commands recorded in the
1192 push certificate is used instead.</p>
1193 </div>
1194 <div class="paragraph">
1195 <p>The packfile MUST NOT be sent if the only command used is <em>delete</em>.</p>
1196 </div>
1197 <div class="paragraph">
1198 <p>A packfile MUST be sent if either create or update command is used,
1199 even if the server already has all the necessary objects.  In this
1200 case the client MUST send an empty packfile.   The only time this
1201 is likely to happen is if the client is creating
1202 a new branch or a tag that points to an existing obj-id.</p>
1203 </div>
1204 <div class="paragraph">
1205 <p>The server will receive the packfile, unpack it, then validate each
1206 reference that is being updated that it hasn&#8217;t changed while the request
1207 was being processed (the obj-id is still the same as the old-id), and
1208 it will run any update hooks to make sure that the update is acceptable.
1209 If all of that is fine, the server will then update the references.</p>
1210 </div>
1211 </div>
1212 </div>
1213 <div class="sect1">
1214 <h2 id="_push_certificate">Push Certificate</h2>
1215 <div class="sectionbody">
1216 <div class="paragraph">
1217 <p>A push certificate begins with a set of header lines.  After the
1218 header and an empty line, the protocol commands follow, one per
1219 line. Note that the trailing LF in push-cert PKT-LINEs is <em>not</em>
1220 optional; it must be present.</p>
1221 </div>
1222 <div class="paragraph">
1223 <p>Currently, the following header fields are defined:</p>
1224 </div>
1225 <div class="dlist">
1226 <dl>
1227 <dt class="hdlist1"><code>pusher</code> ident</dt>
1228 <dd>
1229 <p>Identify the GPG key in "Human Readable Name &lt;email@address&gt;"
1230 format.</p>
1231 </dd>
1232 <dt class="hdlist1"><code>pushee</code> url</dt>
1233 <dd>
1234 <p>The repository URL (anonymized, if the URL contains
1235 authentication material) the user who ran <code>git</code> <code>push</code>
1236 intended to push into.</p>
1237 </dd>
1238 <dt class="hdlist1"><code>nonce</code> nonce</dt>
1239 <dd>
1240 <p>The <em>nonce</em> string the receiving repository asked the
1241 pushing user to include in the certificate, to prevent
1242 replay attacks.</p>
1243 </dd>
1244 </dl>
1245 </div>
1246 <div class="paragraph">
1247 <p>The GPG signature lines are a detached signature for the contents
1248 recorded in the push certificate before the signature block begins.
1249 The detached signature is used to certify that the commands were
1250 given by the pusher, who must be the signer.</p>
1251 </div>
1252 </div>
1253 </div>
1254 <div class="sect1">
1255 <h2 id="_report_status">Report Status</h2>
1256 <div class="sectionbody">
1257 <div class="paragraph">
1258 <p>After receiving the pack data from the sender, the receiver sends a
1259 report if <em>report-status</em> or <em>report-status-v2</em> capability is in effect.
1260 It is a short listing of what happened in that update.  It will first
1261 list the status of the packfile unpacking as either <em>unpack ok</em> or
1262 <em>unpack [error]</em>.  Then it will list the status for each of the references
1263 that it tried to update.  Each line is either <em>ok [refname]</em> if the
1264 update was successful, or <em>ng [refname] [error]</em> if the update was not.</p>
1265 </div>
1266 <div class="listingblock">
1267 <div class="content">
1268 <pre>  report-status     = unpack-status
1269                       1*(command-status)
1270                       flush-pkt
1271
1272   unpack-status     = PKT-LINE("unpack" SP unpack-result)
1273   unpack-result     = "ok" / error-msg
1274
1275   command-status    = command-ok / command-fail
1276   command-ok        = PKT-LINE("ok" SP refname)
1277   command-fail      = PKT-LINE("ng" SP refname SP error-msg)
1278
1279   error-msg         = 1*(OCTET) ; where not "ok"</pre>
1280 </div>
1281 </div>
1282 <div class="paragraph">
1283 <p>The <em>report-status-v2</em> capability extends the protocol by adding new option
1284 lines in order to support reporting of reference rewritten by the
1285 <em>proc-receive</em> hook.  The <em>proc-receive</em> hook may handle a command for a
1286 pseudo-reference which may create or update one or more references, and each
1287 reference may have different name, different new-oid, and different old-oid.</p>
1288 </div>
1289 <div class="listingblock">
1290 <div class="content">
1291 <pre>  report-status-v2  = unpack-status
1292                       1*(command-status-v2)
1293                       flush-pkt
1294
1295   unpack-status     = PKT-LINE("unpack" SP unpack-result)
1296   unpack-result     = "ok" / error-msg
1297
1298   command-status-v2 = command-ok-v2 / command-fail
1299   command-ok-v2     = command-ok
1300                       *option-line
1301
1302   command-ok        = PKT-LINE("ok" SP refname)
1303   command-fail      = PKT-LINE("ng" SP refname SP error-msg)
1304
1305   error-msg         = 1*(OCTET) ; where not "ok"
1306
1307   option-line       = *1(option-refname)
1308                       *1(option-old-oid)
1309                       *1(option-new-oid)
1310                       *1(option-forced-update)
1311
1312   option-refname    = PKT-LINE("option" SP "refname" SP refname)
1313   option-old-oid    = PKT-LINE("option" SP "old-oid" SP obj-id)
1314   option-new-oid    = PKT-LINE("option" SP "new-oid" SP obj-id)
1315   option-force      = PKT-LINE("option" SP "forced-update")</pre>
1316 </div>
1317 </div>
1318 <div class="paragraph">
1319 <p>Updates can be unsuccessful for a number of reasons.  The reference can have
1320 changed since the reference discovery phase was originally sent, meaning
1321 someone pushed in the meantime.  The reference being pushed could be a
1322 non-fast-forward reference and the update hooks or configuration could be
1323 set to not allow that, etc.  Also, some references can be updated while others
1324 can be rejected.</p>
1325 </div>
1326 <div class="paragraph">
1327 <p>An example client/server communication might look like this:</p>
1328 </div>
1329 <div class="listingblock">
1330 <div class="content">
1331 <pre>   S: 006274730d410fcb6603ace96f1dc55ea6196122532d refs/heads/local\0report-status delete-refs ofs-delta\n
1332    S: 003e7d1665144a3a975c05f1f43902ddaf084e784dbe refs/heads/debug\n
1333    S: 003f74730d410fcb6603ace96f1dc55ea6196122532d refs/heads/master\n
1334    S: 003d74730d410fcb6603ace96f1dc55ea6196122532d refs/heads/team\n
1335    S: 0000
1336
1337    C: 00677d1665144a3a975c05f1f43902ddaf084e784dbe 74730d410fcb6603ace96f1dc55ea6196122532d refs/heads/debug\n
1338    C: 006874730d410fcb6603ace96f1dc55ea6196122532d 5a3f6be755bbb7deae50065988cbfa1ffa9ab68a refs/heads/master\n
1339    C: 0000
1340    C: [PACKDATA]
1341
1342    S: 000eunpack ok\n
1343    S: 0018ok refs/heads/debug\n
1344    S: 002ang refs/heads/master non-fast-forward\n</pre>
1345 </div>
1346 </div>
1347 </div>
1348 </div>
1349 <div class="sect1">
1350 <h2 id="_git">GIT</h2>
1351 <div class="sectionbody">
1352 <div class="paragraph">
1353 <p>Part of the <a href="git.html">git(1)</a> suite</p>
1354 </div>
1355 </div>
1356 </div>
1357 </div>
1358 <div id="footer">
1359 <div id="footer-text">
1360 Last updated 2023-10-23 14:43:46 -0700
1361 </div>
1362 </div>
1363 </body>
1364 </html>