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