| <!DOCTYPE html> | |
| <html xmlns="http://www.w3.org/1999/xhtml" lang="en"> | |
| <head> | |
| <meta charset="UTF-8"/> | |
| <meta http-equiv="X-UA-Compatible" content="IE=edge"/> | |
| <meta name="viewport" content="width=device-width, initial-scale=1.0"/> | |
| <meta name="generator" content="Asciidoctor 2.0.26"/> | |
| <title>gitprotocol-pack(5)</title> | |
| <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"/> | |
| <style> | |
| /*! Asciidoctor default stylesheet | MIT License | https://asciidoctor.org */ | |
| /* Uncomment the following line when using as a custom stylesheet */ | |
| /* @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"; */ | |
| html{font-family:sans-serif;-webkit-text-size-adjust:100%} | |
| a{background:none} | |
| a:focus{outline:thin dotted} | |
| a:active,a:hover{outline:0} | |
| h1{font-size:2em;margin:.67em 0} | |
| b,strong{font-weight:bold} | |
| abbr{font-size:.9em} | |
| abbr[title]{cursor:help;border-bottom:1px dotted #dddddf;text-decoration:none} | |
| dfn{font-style:italic} | |
| hr{height:0} | |
| mark{background:#ff0;color:#000} | |
| code,kbd,pre,samp{font-family:monospace;font-size:1em} | |
| pre{white-space:pre-wrap} | |
| q{quotes:"\201C" "\201D" "\2018" "\2019"} | |
| small{font-size:80%} | |
| sub,sup{font-size:75%;line-height:0;position:relative;vertical-align:baseline} | |
| sup{top:-.5em} | |
| sub{bottom:-.25em} | |
| img{border:0} | |
| svg:not(:root){overflow:hidden} | |
| figure{margin:0} | |
| audio,video{display:inline-block} | |
| audio:not([controls]){display:none;height:0} | |
| fieldset{border:1px solid silver;margin:0 2px;padding:.35em .625em .75em} | |
| legend{border:0;padding:0} | |
| button,input,select,textarea{font-family:inherit;font-size:100%;margin:0} | |
| button,input{line-height:normal} | |
| button,select{text-transform:none} | |
| button,html input[type=button],input[type=reset],input[type=submit]{-webkit-appearance:button;cursor:pointer} | |
| button[disabled],html input[disabled]{cursor:default} | |
| input[type=checkbox],input[type=radio]{padding:0} | |
| button::-moz-focus-inner,input::-moz-focus-inner{border:0;padding:0} | |
| textarea{overflow:auto;vertical-align:top} | |
| table{border-collapse:collapse;border-spacing:0} | |
| *,::before,::after{box-sizing:border-box} | |
| html,body{font-size:100%} | |
| 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} | |
| a:hover{cursor:pointer} | |
| img,object,embed{max-width:100%;height:auto} | |
| object,embed{height:100%} | |
| img{-ms-interpolation-mode:bicubic} | |
| .left{float:left!important} | |
| .right{float:right!important} | |
| .text-left{text-align:left!important} | |
| .text-right{text-align:right!important} | |
| .text-center{text-align:center!important} | |
| .text-justify{text-align:justify!important} | |
| .hide{display:none} | |
| img,object,svg{display:inline-block;vertical-align:middle} | |
| textarea{height:auto;min-height:50px} | |
| select{width:100%} | |
| .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} | |
| 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} | |
| a{color:#2156a5;text-decoration:underline;line-height:inherit} | |
| a:hover,a:focus{color:#1d4b8f} | |
| a img{border:0} | |
| p{line-height:1.6;margin-bottom:1.25em;text-rendering:optimizeLegibility} | |
| p aside{font-size:.875em;line-height:1.35;font-style:italic} | |
| 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} | |
| 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} | |
| h1{font-size:2.125em} | |
| h2{font-size:1.6875em} | |
| h3,#toctitle,.sidebarblock>.content>.title{font-size:1.375em} | |
| h4,h5{font-size:1.125em} | |
| h6{font-size:1em} | |
| hr{border:solid #dddddf;border-width:1px 0 0;clear:both;margin:1.25em 0 1.1875em} | |
| em,i{font-style:italic;line-height:inherit} | |
| strong,b{font-weight:bold;line-height:inherit} | |
| small{font-size:60%;line-height:inherit} | |
| code{font-family:"Droid Sans Mono","DejaVu Sans Mono",monospace;font-weight:400;color:rgba(0,0,0,.9)} | |
| ul,ol,dl{line-height:1.6;margin-bottom:1.25em;list-style-position:outside;font-family:inherit} | |
| ul,ol{margin-left:1.5em} | |
| ul li ul,ul li ol{margin-left:1.25em;margin-bottom:0} | |
| ul.circle{list-style-type:circle} | |
| ul.disc{list-style-type:disc} | |
| ul.square{list-style-type:square} | |
| ul.circle ul:not([class]),ul.disc ul:not([class]),ul.square ul:not([class]){list-style:inherit} | |
| ol li ul,ol li ol{margin-left:1.25em;margin-bottom:0} | |
| dl dt{margin-bottom:.3125em;font-weight:bold} | |
| dl dd{margin-bottom:1.25em} | |
| blockquote{margin:0 0 1.25em;padding:.5625em 1.25em 0 1.1875em;border-left:1px solid #ddd} | |
| blockquote,blockquote p{line-height:1.6;color:rgba(0,0,0,.85)} | |
| @media screen and (min-width:768px){h1,h2,h3,#toctitle,.sidebarblock>.content>.title,h4,h5,h6{line-height:1.2} | |
| h1{font-size:2.75em} | |
| h2{font-size:2.3125em} | |
| h3,#toctitle,.sidebarblock>.content>.title{font-size:1.6875em} | |
| h4{font-size:1.4375em}} | |
| table{background:#fff;margin-bottom:1.25em;border:1px solid #dedede;word-wrap:normal} | |
| table thead,table tfoot{background:#f7f8f7} | |
| 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} | |
| table tr th,table tr td{padding:.5625em .625em;font-size:inherit;color:rgba(0,0,0,.8)} | |
| table tr.even,table tr.alt{background:#f8f8f7} | |
| table thead tr th,table tfoot tr th,table tbody tr td,table tr td,table tfoot tr td{line-height:1.6} | |
| h1,h2,h3,#toctitle,.sidebarblock>.content>.title,h4,h5,h6{line-height:1.2;word-spacing:-.05em} | |
| h1 strong,h2 strong,h3 strong,#toctitle strong,.sidebarblock>.content>.title strong,h4 strong,h5 strong,h6 strong{font-weight:400} | |
| .center{margin-left:auto;margin-right:auto} | |
| .stretch{width:100%} | |
| .clearfix::before,.clearfix::after,.float-group::before,.float-group::after{content:" ";display:table} | |
| .clearfix::after,.float-group::after{clear:both} | |
| :not(pre).nobreak{word-wrap:normal} | |
| :not(pre).nowrap{white-space:nowrap} | |
| :not(pre).pre-wrap{white-space:pre-wrap} | |
| :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} | |
| pre{color:rgba(0,0,0,.9);font-family:"Droid Sans Mono","DejaVu Sans Mono",monospace;line-height:1.45;text-rendering:optimizeSpeed} | |
| pre code,pre pre{color:inherit;font-size:inherit;line-height:inherit} | |
| pre.nowrap,pre.nowrap pre{white-space:pre;word-wrap:normal} | |
| em em{font-style:normal} | |
| strong strong{font-weight:400} | |
| .keyseq{color:rgba(51,51,51,.8)} | |
| 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} | |
| .keyseq kbd:first-child{margin-left:0} | |
| .keyseq kbd:last-child{margin-right:0} | |
| .menuseq,.menuref{color:#000} | |
| .menuseq b:not(.caret),.menuref{font-weight:inherit} | |
| .menuseq{word-spacing:-.02em} | |
| .menuseq b.caret{font-size:1.25em;line-height:.8} | |
| .menuseq i.caret{font-weight:bold;text-align:center;width:.45em} | |
| b.button::before,b.button::after{position:relative;top:-1px;font-weight:400} | |
| b.button::before{content:"[";padding:0 3px 0 2px} | |
| b.button::after{content:"]";padding:0 2px 0 3px} | |
| p a>code:hover{color:rgba(0,0,0,.9)} | |
| #header,#content,#footnotes,#footer{width:100%;margin:0 auto;max-width:62.5em;*zoom:1;position:relative;padding-left:.9375em;padding-right:.9375em} | |
| #header::before,#header::after,#content::before,#content::after,#footnotes::before,#footnotes::after,#footer::before,#footer::after{content:" ";display:table} | |
| #header::after,#content::after,#footnotes::after,#footer::after{clear:both} | |
| #content{margin-top:1.25em} | |
| #content::before{content:none} | |
| #header>h1:first-child{color:rgba(0,0,0,.85);margin-top:2.25rem;margin-bottom:0} | |
| #header>h1:first-child+#toc{margin-top:8px;border-top:1px solid #dddddf} | |
| #header>h1:only-child{border-bottom:1px solid #dddddf;padding-bottom:8px} | |
| #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} | |
| #header .details span:first-child{margin-left:-.125em} | |
| #header .details span.email a{color:rgba(0,0,0,.85)} | |
| #header .details br{display:none} | |
| #header .details br+span::before{content:"\00a0\2013\00a0"} | |
| #header .details br+span.author::before{content:"\00a0\22c5\00a0";color:rgba(0,0,0,.85)} | |
| #header .details br+span#revremark::before{content:"\00a0|\00a0"} | |
| #header #revnumber{text-transform:capitalize} | |
| #header #revnumber::after{content:"\00a0"} | |
| #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} | |
| #toc{border-bottom:1px solid #e7e7e9;padding-bottom:.5em} | |
| #toc>ul{margin-left:.125em} | |
| #toc ul.sectlevel0>li>a{font-style:italic} | |
| #toc ul.sectlevel0 ul.sectlevel1{margin:.5em 0} | |
| #toc ul{font-family:"Open Sans","DejaVu Sans",sans-serif;list-style-type:none} | |
| #toc li{line-height:1.3334;margin-top:.3334em} | |
| #toc a{text-decoration:none} | |
| #toc a:active{text-decoration:underline} | |
| #toctitle{color:#7a2518;font-size:1.2em} | |
| @media screen and (min-width:768px){#toctitle{font-size:1.375em} | |
| body.toc2{padding-left:15em;padding-right:0} | |
| body.toc2 #header>h1:nth-last-child(2){border-bottom:1px solid #dddddf;padding-bottom:8px} | |
| #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} | |
| #toc.toc2 #toctitle{margin-top:0;margin-bottom:.8rem;font-size:1.2em} | |
| #toc.toc2>ul{font-size:.9em;margin-bottom:0} | |
| #toc.toc2 ul ul{margin-left:0;padding-left:1em} | |
| #toc.toc2 ul.sectlevel0 ul.sectlevel1{padding-left:0;margin-top:.5em;margin-bottom:.5em} | |
| body.toc2.toc-right{padding-left:0;padding-right:15em} | |
| body.toc2.toc-right #toc.toc2{border-right-width:0;border-left:1px solid #e7e7e9;left:auto;right:0}} | |
| @media screen and (min-width:1280px){body.toc2{padding-left:20em;padding-right:0} | |
| #toc.toc2{width:20em} | |
| #toc.toc2 #toctitle{font-size:1.375em} | |
| #toc.toc2>ul{font-size:.95em} | |
| #toc.toc2 ul ul{padding-left:1.25em} | |
| body.toc2.toc-right{padding-left:0;padding-right:20em}} | |
| #content #toc{border:1px solid #e0e0dc;margin-bottom:1.25em;padding:1.25em;background:#f8f8f7;border-radius:4px} | |
| #content #toc>:first-child{margin-top:0} | |
| #content #toc>:last-child{margin-bottom:0} | |
| #footer{max-width:none;background:rgba(0,0,0,.8);padding:1.25em} | |
| #footer-text{color:hsla(0,0%,100%,.8);line-height:1.44} | |
| #content{margin-bottom:.625em} | |
| .sect1{padding-bottom:.625em} | |
| @media screen and (min-width:768px){#content{margin-bottom:1.25em} | |
| .sect1{padding-bottom:1.25em}} | |
| .sect1:last-child{padding-bottom:0} | |
| .sect1+.sect1{border-top:1px solid #e7e7e9} | |
| #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} | |
| #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} | |
| #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} | |
| #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} | |
| #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} | |
| details,.audioblock,.imageblock,.literalblock,.listingblock,.stemblock,.videoblock{margin-bottom:1.25em} | |
| details{margin-left:1.25rem} | |
| details>summary{cursor:pointer;display:block;position:relative;line-height:1.6;margin-bottom:.625rem;outline:none;-webkit-tap-highlight-color:transparent} | |
| details>summary::-webkit-details-marker{display:none} | |
| 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%)} | |
| details[open]>summary::before{border:solid transparent;border-top:solid;border-width:.5em .3em 0;transform:translateY(15%)} | |
| details>summary::after{content:"";width:1.25rem;height:1em;position:absolute;top:.3em;left:-1.25rem} | |
| .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} | |
| table.tableblock.fit-content>caption.title{white-space:nowrap;width:0} | |
| .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)} | |
| .admonitionblock>table{border-collapse:separate;border:0;background:none;width:100%} | |
| .admonitionblock>table td.icon{text-align:center;width:80px} | |
| .admonitionblock>table td.icon img{max-width:none} | |
| .admonitionblock>table td.icon .title{font-weight:bold;font-family:"Open Sans","DejaVu Sans",sans-serif;text-transform:uppercase} | |
| .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} | |
| .admonitionblock>table td.content>:last-child>:last-child{margin-bottom:0} | |
| .exampleblock>.content{border:1px solid #e6e6e6;margin-bottom:1.25em;padding:1.25em;background:#fff;border-radius:4px} | |
| .sidebarblock{border:1px solid #dbdbd6;margin-bottom:1.25em;padding:1.25em;background:#f3f3f2;border-radius:4px} | |
| .sidebarblock>.content>.title{color:#7a2518;margin-top:0;text-align:center} | |
| .exampleblock>.content>:first-child,.sidebarblock>.content>:first-child{margin-top:0} | |
| .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} | |
| .literalblock pre,.listingblock>.content>pre{border-radius:4px;overflow-x:auto;padding:1em;font-size:.8125em} | |
| @media screen and (min-width:768px){.literalblock pre,.listingblock>.content>pre{font-size:.90625em}} | |
| @media screen and (min-width:1280px){.literalblock pre,.listingblock>.content>pre{font-size:1em}} | |
| .literalblock pre,.listingblock>.content>pre:not(.highlight),.listingblock>.content>pre[class=highlight],.listingblock>.content>pre[class^="highlight "]{background:#f7f7f8} | |
| .literalblock.output pre{color:#f7f7f8;background:rgba(0,0,0,.9)} | |
| .listingblock>.content{position:relative} | |
| .listingblock pre>code{display:block} | |
| .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} | |
| .listingblock:hover code[data-lang]::before{display:block} | |
| .listingblock.terminal pre .command::before{content:attr(data-prompt);padding-right:.5em;color:inherit;opacity:.5} | |
| .listingblock.terminal pre .command:not([data-prompt])::before{content:"$"} | |
| .listingblock pre.highlightjs{padding:0} | |
| .listingblock pre.highlightjs>code{padding:1em;border-radius:4px} | |
| .listingblock pre.prettyprint{border-width:0} | |
| .prettyprint{background:#f7f7f8} | |
| pre.prettyprint .linenums{line-height:1.45;margin-left:2em} | |
| pre.prettyprint li{background:none;list-style-type:inherit;padding-left:0} | |
| pre.prettyprint li code[data-lang]::before{opacity:1} | |
| pre.prettyprint li:not(:first-child) code[data-lang]::before{display:none} | |
| table.linenotable{border-collapse:separate;border:0;margin-bottom:0;background:none} | |
| table.linenotable td[class]{color:inherit;vertical-align:top;padding:0;line-height:inherit;white-space:normal} | |
| table.linenotable td.code{padding-left:.75em} | |
| 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} | |
| pre.pygments span.linenos{display:inline-block;margin-right:.75em} | |
| .quoteblock{margin:0 1em 1.25em 1.5em;display:table} | |
| .quoteblock:not(.excerpt)>.title{margin-left:-1.5em;margin-bottom:.75em} | |
| .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} | |
| .quoteblock blockquote{margin:0;padding:0;border:0} | |
| .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)} | |
| .quoteblock blockquote>.paragraph:last-child p{margin-bottom:0} | |
| .quoteblock .attribution{margin-top:.75em;margin-right:.5ex;text-align:right} | |
| .verseblock{margin:0 1em 1.25em} | |
| .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} | |
| .verseblock pre strong{font-weight:400} | |
| .verseblock .attribution{margin-top:1.25rem;margin-left:.5ex} | |
| .quoteblock .attribution,.verseblock .attribution{font-size:.9375em;line-height:1.45;font-style:italic} | |
| .quoteblock .attribution br,.verseblock .attribution br{display:none} | |
| .quoteblock .attribution cite,.verseblock .attribution cite{display:block;letter-spacing:-.025em;color:rgba(0,0,0,.6)} | |
| .quoteblock.abstract blockquote::before,.quoteblock.excerpt blockquote::before,.quoteblock .quoteblock blockquote::before{display:none} | |
| .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} | |
| .quoteblock.abstract{margin:0 1em 1.25em;display:block} | |
| .quoteblock.abstract>.title{margin:0 0 .375em;font-size:1.15em;text-align:center} | |
| .quoteblock.excerpt>blockquote,.quoteblock .quoteblock{padding:0 0 .25em 1em;border-left:.25em solid #dddddf} | |
| .quoteblock.excerpt,.quoteblock .quoteblock{margin-left:0} | |
| .quoteblock.excerpt blockquote,.quoteblock.excerpt p,.quoteblock .quoteblock blockquote,.quoteblock .quoteblock p{color:inherit;font-size:1.0625rem} | |
| .quoteblock.excerpt .attribution,.quoteblock .quoteblock .attribution{color:inherit;font-size:.85rem;text-align:left;margin-right:0} | |
| p.tableblock:last-child{margin-bottom:0} | |
| td.tableblock>.content{margin-bottom:1.25em;word-wrap:anywhere} | |
| td.tableblock>.content>:last-child{margin-bottom:-1.25em} | |
| table.tableblock,th.tableblock,td.tableblock{border:0 solid #dedede} | |
| table.grid-all>*>tr>*{border-width:1px} | |
| table.grid-cols>*>tr>*{border-width:0 1px} | |
| table.grid-rows>*>tr>*{border-width:1px 0} | |
| table.frame-all{border-width:1px} | |
| table.frame-ends{border-width:1px 0} | |
| table.frame-sides{border-width:0 1px} | |
| table.frame-none>colgroup+*>:first-child>*,table.frame-sides>colgroup+*>:first-child>*{border-top-width:0} | |
| table.frame-none>:last-child>:last-child>*,table.frame-sides>:last-child>:last-child>*{border-bottom-width:0} | |
| table.frame-none>*>tr>:first-child,table.frame-ends>*>tr>:first-child{border-left-width:0} | |
| table.frame-none>*>tr>:last-child,table.frame-ends>*>tr>:last-child{border-right-width:0} | |
| 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} | |
| th.halign-left,td.halign-left{text-align:left} | |
| th.halign-right,td.halign-right{text-align:right} | |
| th.halign-center,td.halign-center{text-align:center} | |
| th.valign-top,td.valign-top{vertical-align:top} | |
| th.valign-bottom,td.valign-bottom{vertical-align:bottom} | |
| th.valign-middle,td.valign-middle{vertical-align:middle} | |
| table thead th,table tfoot th{font-weight:bold} | |
| tbody tr th{background:#f7f8f7} | |
| tbody tr th,tbody tr th p,tfoot tr th,tfoot tr th p{color:rgba(0,0,0,.8);font-weight:bold} | |
| p.tableblock>code:only-child{background:none;padding:0} | |
| p.tableblock{font-size:1em} | |
| ol{margin-left:1.75em} | |
| ul li ol{margin-left:1.5em} | |
| dl dd{margin-left:1.125em} | |
| dl dd:last-child,dl dd:last-child>:last-child{margin-bottom:0} | |
| li p,ul dd,ol dd,.olist .olist,.ulist .ulist,.ulist .olist,.olist .ulist{margin-bottom:.625em} | |
| ul.checklist,ul.none,ol.none,ul.no-bullet,ol.no-bullet,ol.unnumbered,ul.unstyled,ol.unstyled{list-style-type:none} | |
| ul.no-bullet,ol.no-bullet,ol.unnumbered{margin-left:.625em} | |
| ul.unstyled,ol.unstyled{margin-left:0} | |
| li>p:empty:only-child::before{content:"";display:inline-block} | |
| ul.checklist>li>p:first-child{margin-left:-1em} | |
| 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} | |
| ul.checklist>li>p:first-child>input[type=checkbox]:first-child{margin-right:.25em} | |
| ul.inline{display:flex;flex-flow:row wrap;list-style:none;margin:0 0 .625em -1.25em} | |
| ul.inline>li{margin-left:1.25em} | |
| .unstyled dl dt{font-weight:400;font-style:normal} | |
| ol.arabic{list-style-type:decimal} | |
| ol.decimal{list-style-type:decimal-leading-zero} | |
| ol.loweralpha{list-style-type:lower-alpha} | |
| ol.upperalpha{list-style-type:upper-alpha} | |
| ol.lowerroman{list-style-type:lower-roman} | |
| ol.upperroman{list-style-type:upper-roman} | |
| ol.lowergreek{list-style-type:lower-greek} | |
| .hdlist>table,.colist>table{border:0;background:none} | |
| .hdlist>table>tbody>tr,.colist>table>tbody>tr{background:none} | |
| td.hdlist1,td.hdlist2{vertical-align:top;padding:0 .625em} | |
| td.hdlist1{font-weight:bold;padding-bottom:1.25em} | |
| td.hdlist2{word-wrap:anywhere} | |
| .literalblock+.colist,.listingblock+.colist{margin-top:-.5em} | |
| .colist td:not([class]):first-child{padding:.4em .75em 0;line-height:1;vertical-align:top} | |
| .colist td:not([class]):first-child img{max-width:none} | |
| .colist td:not([class]):last-child{padding:.25em 0} | |
| .thumb,.th{line-height:0;display:inline-block;border:4px solid #fff;box-shadow:0 0 0 1px #ddd} | |
| .imageblock.left{margin:.25em .625em 1.25em 0} | |
| .imageblock.right{margin:.25em 0 1.25em .625em} | |
| .imageblock>.title{margin-bottom:0} | |
| .imageblock.thumb,.imageblock.th{border-width:6px} | |
| .imageblock.thumb>.title,.imageblock.th>.title{padding:0 .125em} | |
| .image.left,.image.right{margin-top:.25em;margin-bottom:.25em;display:inline-block;line-height:0} | |
| .image.left{margin-right:.625em} | |
| .image.right{margin-left:.625em} | |
| a.image{text-decoration:none;display:inline-block} | |
| a.image object{pointer-events:none} | |
| sup.footnote,sup.footnoteref{font-size:.875em;position:static;vertical-align:super} | |
| sup.footnote a,sup.footnoteref a{text-decoration:none} | |
| sup.footnote a:active,sup.footnoteref a:active,#footnotes .footnote a:first-of-type:active{text-decoration:underline} | |
| #footnotes{padding-top:.75em;padding-bottom:.75em;margin-bottom:.625em} | |
| #footnotes hr{width:20%;min-width:6.25em;margin:-.25em 0 .75em;border-width:1px 0 0} | |
| #footnotes .footnote{padding:0 .375em 0 .225em;line-height:1.3334;font-size:.875em;margin-left:1.2em;margin-bottom:.2em} | |
| #footnotes .footnote a:first-of-type{font-weight:bold;text-decoration:none;margin-left:-1.05em} | |
| #footnotes .footnote:last-of-type{margin-bottom:0} | |
| #content #footnotes{margin-top:-.625em;margin-bottom:0;padding:.75em 0} | |
| div.unbreakable{page-break-inside:avoid} | |
| .big{font-size:larger} | |
| .small{font-size:smaller} | |
| .underline{text-decoration:underline} | |
| .overline{text-decoration:overline} | |
| .line-through{text-decoration:line-through} | |
| .aqua{color:#00bfbf} | |
| .aqua-background{background:#00fafa} | |
| .black{color:#000} | |
| .black-background{background:#000} | |
| .blue{color:#0000bf} | |
| .blue-background{background:#0000fa} | |
| .fuchsia{color:#bf00bf} | |
| .fuchsia-background{background:#fa00fa} | |
| .gray{color:#606060} | |
| .gray-background{background:#7d7d7d} | |
| .green{color:#006000} | |
| .green-background{background:#007d00} | |
| .lime{color:#00bf00} | |
| .lime-background{background:#00fa00} | |
| .maroon{color:#600000} | |
| .maroon-background{background:#7d0000} | |
| .navy{color:#000060} | |
| .navy-background{background:#00007d} | |
| .olive{color:#606000} | |
| .olive-background{background:#7d7d00} | |
| .purple{color:#600060} | |
| .purple-background{background:#7d007d} | |
| .red{color:#bf0000} | |
| .red-background{background:#fa0000} | |
| .silver{color:#909090} | |
| .silver-background{background:#bcbcbc} | |
| .teal{color:#006060} | |
| .teal-background{background:#007d7d} | |
| .white{color:#bfbfbf} | |
| .white-background{background:#fafafa} | |
| .yellow{color:#bfbf00} | |
| .yellow-background{background:#fafa00} | |
| span.icon>.fa{cursor:default} | |
| a span.icon>.fa{cursor:inherit} | |
| .admonitionblock td.icon [class^="fa icon-"]{font-size:2.5em;text-shadow:1px 1px 2px rgba(0,0,0,.5);cursor:default} | |
| .admonitionblock td.icon .icon-note::before{content:"\f05a";color:#19407c} | |
| .admonitionblock td.icon .icon-tip::before{content:"\f0eb";text-shadow:1px 1px 2px rgba(155,155,0,.8);color:#111} | |
| .admonitionblock td.icon .icon-warning::before{content:"\f071";color:#bf6900} | |
| .admonitionblock td.icon .icon-caution::before{content:"\f06d";color:#bf3400} | |
| .admonitionblock td.icon .icon-important::before{content:"\f06a";color:#bf0000} | |
| .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} | |
| .conum[data-value] *{color:#fff!important} | |
| .conum[data-value]+b{display:none} | |
| .conum[data-value]::after{content:attr(data-value)} | |
| pre .conum[data-value]{position:relative;top:-.125em} | |
| b.conum *{color:inherit!important} | |
| .conum:not([data-value]):empty{display:none} | |
| dt,th.tableblock,td.content,div.footnote{text-rendering:optimizeLegibility} | |
| h1,h2,p,td.content,span.alt,summary{letter-spacing:-.01em} | |
| p strong,td.content strong,div.footnote strong{letter-spacing:-.005em} | |
| p,blockquote,dt,td.content,td.hdlist1,span.alt,summary{font-size:1.0625rem} | |
| p{margin-bottom:1.25rem} | |
| .sidebarblock p,.sidebarblock dt,.sidebarblock td.content,p.tableblock{font-size:1em} | |
| .exampleblock>.content{background:#fffef7;border-color:#e0e0dc;box-shadow:0 1px 4px #e0e0dc} | |
| .print-only{display:none!important} | |
| @page{margin:1.25cm .75cm} | |
| @media print{*{box-shadow:none!important;text-shadow:none!important} | |
| html{font-size:80%} | |
| a{color:inherit!important;text-decoration:underline!important} | |
| a.bare,a[href^="#"],a[href^="mailto:"]{text-decoration:none!important} | |
| a[href^="http:"]:not(.bare)::after,a[href^="https:"]:not(.bare)::after{content:"(" attr(href) ")";display:inline-block;font-size:.875em;padding-left:.25em} | |
| abbr[title]{border-bottom:1px dotted} | |
| abbr[title]::after{content:" (" attr(title) ")"} | |
| pre,blockquote,tr,img,object,svg{page-break-inside:avoid} | |
| thead{display:table-header-group} | |
| svg{max-width:100%} | |
| p,blockquote,dt,td.content{font-size:1em;orphans:3;widows:3} | |
| h2,h3,#toctitle,.sidebarblock>.content>.title{page-break-after:avoid} | |
| #header,#content,#footnotes,#footer{max-width:none} | |
| #toc,.sidebarblock,.exampleblock>.content{background:none!important} | |
| #toc{border-bottom:1px solid #dddddf!important;padding-bottom:0!important} | |
| body.book #header{text-align:center} | |
| body.book #header>h1:first-child{border:0!important;margin:2.5em 0 1em} | |
| body.book #header .details{border:0!important;display:block;padding:0!important} | |
| body.book #header .details span:first-child{margin-left:0!important} | |
| body.book #header .details br{display:block} | |
| body.book #header .details br+span::before{content:none!important} | |
| body.book #toc{border:0!important;text-align:left!important;padding:0!important;margin:0!important} | |
| body.book #toc,body.book #preamble,body.book h1.sect0,body.book .sect1>h2{page-break-before:always} | |
| .listingblock code[data-lang]::before{display:block} | |
| #footer{padding:0 .9375em} | |
| .hide-on-print{display:none!important} | |
| .print-only{display:block!important} | |
| .hide-for-print{display:none!important} | |
| .show-for-print{display:inherit!important}} | |
| @media amzn-kf8,print{#header>h1:first-child{margin-top:1.25rem} | |
| .sect1{padding:0!important} | |
| .sect1+.sect1{border:0} | |
| #footer{background:none} | |
| #footer-text{color:rgba(0,0,0,.6);font-size:.9em}} | |
| @media amzn-kf8{#header,#content,#footnotes,#footer{padding:0}} | |
| </style> | |
| <style> | |
| pre>code { | |
| display: inline; | |
| } | |
| </style> | |
| </head> | |
| <body class="manpage"> | |
| <div id="header"> | |
| <h1>gitprotocol-pack(5) Manual Page</h1> | |
| <h2 id="_name">NAME</h2> | |
| <div class="sectionbody"> | |
| <p>gitprotocol-pack - How packs are transferred over-the-wire</p> | |
| </div> | |
| </div> | |
| <div id="content"> | |
| <div class="sect1"> | |
| <h2 id="_synopsis">SYNOPSIS</h2> | |
| <div class="sectionbody"> | |
| <div class="verseblock"> | |
| <pre class="content"><over-the-wire-protocol></pre> | |
| </div> | |
| </div> | |
| </div> | |
| <div class="sect1"> | |
| <h2 id="_description">DESCRIPTION</h2> | |
| <div class="sectionbody"> | |
| <div class="paragraph"> | |
| <p>Git supports transferring data in packfiles over the ssh://, git://, http:// and | |
| file:// transports. There exist two sets of protocols, one for pushing | |
| data from a client to a server and another for fetching data from a | |
| server to a client. The three transports (ssh, git, file) use the same | |
| protocol to transfer data. http is documented in <a href="gitprotocol-http.html">gitprotocol-http(5)</a>.</p> | |
| </div> | |
| <div class="paragraph"> | |
| <p>The processes invoked in the canonical Git implementation are <em>upload-pack</em> | |
| on the server side and <em>fetch-pack</em> on the client side for fetching data; | |
| then <em>receive-pack</em> on the server and <em>send-pack</em> on the client for pushing | |
| data. The protocol functions to have a server tell a client what is | |
| currently on the server, then for the two to negotiate the smallest amount | |
| of data to send in order to fully update one or the other.</p> | |
| </div> | |
| </div> | |
| </div> | |
| <div class="sect1"> | |
| <h2 id="_pkt_line_format">pkt-line Format</h2> | |
| <div class="sectionbody"> | |
| <div class="paragraph"> | |
| <p>The descriptions below build on the pkt-line format described in | |
| <a href="gitprotocol-common.html">gitprotocol-common(5)</a>. When the grammar indicates <code>PKT-LINE</code>(<code>...</code>), unless | |
| otherwise noted the usual pkt-line LF rules apply: the sender SHOULD | |
| include a LF, but the receiver MUST NOT complain if it is not present.</p> | |
| </div> | |
| <div class="paragraph"> | |
| <p>An error packet is a special pkt-line that contains an error string.</p> | |
| </div> | |
| <div class="listingblock"> | |
| <div class="content"> | |
| <pre> error-line = PKT-LINE("ERR" SP explanation-text)</pre> | |
| </div> | |
| </div> | |
| <div class="paragraph"> | |
| <p>Throughout the protocol, where <code>PKT-LINE</code>(<code>...</code>) is expected, an error packet MAY | |
| be sent. Once this packet is sent by a client or a server, the data transfer | |
| process defined in this protocol is terminated.</p> | |
| </div> | |
| </div> | |
| </div> | |
| <div class="sect1"> | |
| <h2 id="_transports">Transports</h2> | |
| <div class="sectionbody"> | |
| <div class="paragraph"> | |
| <p>There are three transports over which the packfile protocol is | |
| initiated.</p> | |
| </div> | |
| <div class="paragraph"> | |
| <p>The Git transport is a simple, unauthenticated server that | |
| takes the command (almost always <em>upload-pack</em>, though Git | |
| servers can be configured to be globally writable, in which <em>receive- | |
| pack</em> initiation is also allowed) with which the client wishes to | |
| communicate and executes it and connects it to the requesting | |
| process.</p> | |
| </div> | |
| <div class="paragraph"> | |
| <p>In the SSH transport, the client just runs the <em>upload-pack</em> | |
| or <em>receive-pack</em> process on the server over the SSH protocol and then | |
| communicates with that invoked process over the SSH connection.</p> | |
| </div> | |
| <div class="paragraph"> | |
| <p>The file:// transport runs the <em>upload-pack</em> or <em>receive-pack</em> | |
| process locally and communicates with it over a pipe.</p> | |
| </div> | |
| </div> | |
| </div> | |
| <div class="sect1"> | |
| <h2 id="_extra_parameters">Extra Parameters</h2> | |
| <div class="sectionbody"> | |
| <div class="paragraph"> | |
| <p>The protocol provides a mechanism in which clients can send additional | |
| information in their first message to the server. These are called "Extra | |
| Parameters", and are supported by the Git, SSH, and HTTP protocols.</p> | |
| </div> | |
| <div class="paragraph"> | |
| <p>Each Extra Parameter takes the form of <em><key></em><code>=</code><em><value></em> or <em><key></em>.</p> | |
| </div> | |
| <div class="paragraph"> | |
| <p>Servers that receive any such Extra Parameters MUST ignore all | |
| unrecognized keys. Currently, the only Extra Parameter recognized is | |
| "version" with a value of <em>1</em> or <em>2</em>. See <a href="gitprotocol-v2.html">gitprotocol-v2(5)</a> for more | |
| information on protocol version 2.</p> | |
| </div> | |
| </div> | |
| </div> | |
| <div class="sect1"> | |
| <h2 id="_git_transport">Git Transport</h2> | |
| <div class="sectionbody"> | |
| <div class="paragraph"> | |
| <p>The Git transport starts off by sending the command and repository | |
| on the wire using the pkt-line format, followed by a NUL byte and a | |
| hostname parameter, terminated by a NUL byte.</p> | |
| </div> | |
| <div class="literalblock"> | |
| <div class="content"> | |
| <pre>0033git-upload-pack /project.git\0host=myserver.com\0</pre> | |
| </div> | |
| </div> | |
| <div class="paragraph"> | |
| <p>The transport may send Extra Parameters by adding an additional NUL | |
| byte, and then adding one or more NUL-terminated strings:</p> | |
| </div> | |
| <div class="literalblock"> | |
| <div class="content"> | |
| <pre>003egit-upload-pack /project.git\0host=myserver.com\0\0version=1\0</pre> | |
| </div> | |
| </div> | |
| <div class="openblock"> | |
| <div class="content"> | |
| <div class="literalblock"> | |
| <div class="content"> | |
| <pre>git-proto-request = request-command SP pathname NUL | |
| [ host-parameter NUL ] [ NUL extra-parameters ] | |
| request-command = "git-upload-pack" / "git-receive-pack" / | |
| "git-upload-archive" ; case sensitive | |
| pathname = *( %x01-ff ) ; exclude NUL | |
| host-parameter = "host=" hostname [ ":" port ] | |
| extra-parameters = 1*extra-parameter | |
| extra-parameter = 1*( %x01-ff ) NUL</pre> | |
| </div> | |
| </div> | |
| </div> | |
| </div> | |
| <div class="paragraph"> | |
| <p>host-parameter is used for the | |
| git-daemon name based virtual hosting. See --interpolated-path | |
| option to git daemon, with the %H/%CH format characters.</p> | |
| </div> | |
| <div class="paragraph"> | |
| <p>Basically what the Git client is doing to connect to an <em>upload-pack</em> | |
| process on the server side over the Git protocol is this:</p> | |
| </div> | |
| <div class="literalblock"> | |
| <div class="content"> | |
| <pre>$ echo -e -n \ | |
| "003agit-upload-pack /schacon/gitbook.git\0host=example.com\0" | | |
| nc -v example.com 9418</pre> | |
| </div> | |
| </div> | |
| </div> | |
| </div> | |
| <div class="sect1"> | |
| <h2 id="_ssh_transport">SSH Transport</h2> | |
| <div class="sectionbody"> | |
| <div class="paragraph"> | |
| <p>Initiating the <em>upload-pack</em> or <em>receive-pack</em> processes over SSH is | |
| executing the binary on the server via SSH remote execution. | |
| It is basically equivalent to running this:</p> | |
| </div> | |
| <div class="literalblock"> | |
| <div class="content"> | |
| <pre>$ ssh git.example.com "git-upload-pack '/project.git'"</pre> | |
| </div> | |
| </div> | |
| <div class="paragraph"> | |
| <p>For a server to support Git pushing and pulling for a given user over | |
| SSH, that user needs to be able to execute one or both of those | |
| commands via the SSH shell that they are provided on login. On some | |
| systems, that shell access is limited to only being able to run those | |
| two commands, or even just one of them.</p> | |
| </div> | |
| <div class="paragraph"> | |
| <p>In an ssh:// format URI, it’s absolute in the URI, so the <em>/</em> after | |
| the host name (or port number) is sent as an argument, which is then | |
| read by the remote <em>git-upload-pack</em> exactly as is, so it’s effectively | |
| an absolute path in the remote filesystem.</p> | |
| </div> | |
| <div class="literalblock"> | |
| <div class="content"> | |
| <pre> git clone ssh://user@example.com/project.git | |
| | | |
| v | |
| ssh user@example.com "git-upload-pack '/project.git'"</pre> | |
| </div> | |
| </div> | |
| <div class="paragraph"> | |
| <p>In a "user@host:path" format URI, it’s relative to the user’s home | |
| directory, because the Git client will run:</p> | |
| </div> | |
| <div class="literalblock"> | |
| <div class="content"> | |
| <pre> git clone user@example.com:project.git | |
| | | |
| v | |
| ssh user@example.com "git-upload-pack 'project.git'"</pre> | |
| </div> | |
| </div> | |
| <div class="paragraph"> | |
| <p>The exception is if a <em>~</em> is used, in which case | |
| we execute it without the leading <em>/</em>.</p> | |
| </div> | |
| <div class="literalblock"> | |
| <div class="content"> | |
| <pre> ssh://user@example.com/~alice/project.git, | |
| | | |
| v | |
| ssh user@example.com "git-upload-pack '~alice/project.git'"</pre> | |
| </div> | |
| </div> | |
| <div class="paragraph"> | |
| <p>Depending on the value of the <code>protocol.version</code> configuration variable, | |
| Git may attempt to send Extra Parameters as a colon-separated string in | |
| the GIT_PROTOCOL environment variable. This is done only if | |
| the <code>ssh.variant</code> configuration variable indicates that the ssh command | |
| supports passing environment variables as an argument.</p> | |
| </div> | |
| <div class="paragraph"> | |
| <p>A few things to remember here:</p> | |
| </div> | |
| <div class="ulist"> | |
| <ul> | |
| <li> | |
| <p>The "command name" is spelled with dash (e.g. <em>git-upload-pack</em>), but | |
| this can be overridden by the client;</p> | |
| </li> | |
| <li> | |
| <p>The repository path is always quoted with single quotes.</p> | |
| </li> | |
| </ul> | |
| </div> | |
| </div> | |
| </div> | |
| <div class="sect1"> | |
| <h2 id="_fetching_data_from_a_server">Fetching Data From a Server</h2> | |
| <div class="sectionbody"> | |
| <div class="paragraph"> | |
| <p>When one Git repository wants to get data that a second repository | |
| has, the first can <em>fetch</em> from the second. This operation determines | |
| what data the server has that the client does not then streams that | |
| data down to the client in packfile format.</p> | |
| </div> | |
| </div> | |
| </div> | |
| <div class="sect1"> | |
| <h2 id="_reference_discovery">Reference Discovery</h2> | |
| <div class="sectionbody"> | |
| <div class="paragraph"> | |
| <p>When the client initially connects the server will immediately respond | |
| with a version number (if "version=1" is sent as an Extra Parameter), | |
| and a listing of each reference it has (all branches and tags) along | |
| with the object name that each reference currently points to.</p> | |
| </div> | |
| <div class="literalblock"> | |
| <div class="content"> | |
| <pre> $ echo -e -n "0045git-upload-pack /schacon/gitbook.git\0host=example.com\0\0version=1\0" | | |
| nc -v example.com 9418 | |
| 000eversion 1 | |
| 00887217a7c7e582c46cec22a130adf4b9d7d950fba0 HEAD\0multi_ack thin-pack | |
| side-band side-band-64k ofs-delta shallow no-progress include-tag | |
| 00441d3fcd5ced445d1abc402225c0b8a1299641f497 refs/heads/integration | |
| 003f7217a7c7e582c46cec22a130adf4b9d7d950fba0 refs/heads/master | |
| 003cb88d2441cac0977faf98efc80305012112238d9d refs/tags/v0.9 | |
| 003c525128480b96c89e6418b1e40909bf6c5b2d580f refs/tags/v1.0 | |
| 003fe92df48743b7bc7d26bcaabfddde0a1e20cae47c refs/tags/v1.0^{} | |
| 0000</pre> | |
| </div> | |
| </div> | |
| <div class="paragraph"> | |
| <p>The returned response is a pkt-line stream describing each ref and | |
| its current value. The stream MUST be sorted by name according to | |
| the C locale ordering.</p> | |
| </div> | |
| <div class="paragraph"> | |
| <p>If HEAD is a valid ref, HEAD MUST appear as the first advertised | |
| ref. If HEAD is not a valid ref, HEAD MUST NOT appear in the | |
| advertisement list at all, but other refs may still appear.</p> | |
| </div> | |
| <div class="paragraph"> | |
| <p>The stream MUST include capability declarations behind a NUL on the | |
| first ref. The peeled value of a ref (that is "ref^{}") MUST be | |
| immediately after the ref itself, if presented. A conforming server | |
| MUST peel the ref if it’s an annotated tag.</p> | |
| </div> | |
| <div class="listingblock"> | |
| <div class="content"> | |
| <pre> advertised-refs = *1("version 1") | |
| (no-refs / list-of-refs) | |
| *shallow | |
| flush-pkt | |
| no-refs = PKT-LINE(zero-id SP "capabilities^{}" | |
| NUL capability-list) | |
| list-of-refs = first-ref *other-ref | |
| first-ref = PKT-LINE(obj-id SP refname | |
| NUL capability-list) | |
| other-ref = PKT-LINE(other-tip / other-peeled) | |
| other-tip = obj-id SP refname | |
| other-peeled = obj-id SP refname "^{}" | |
| shallow = PKT-LINE("shallow" SP obj-id) | |
| capability-list = capability *(SP capability) | |
| capability = 1*(LC_ALPHA / DIGIT / "-" / "_") | |
| LC_ALPHA = %x61-7A</pre> | |
| </div> | |
| </div> | |
| <div class="paragraph"> | |
| <p>Server and client MUST use lowercase for obj-id, both MUST treat obj-id | |
| as case-insensitive.</p> | |
| </div> | |
| <div class="paragraph"> | |
| <p>See protocol-capabilities.txt for a list of allowed server capabilities | |
| and descriptions.</p> | |
| </div> | |
| </div> | |
| </div> | |
| <div class="sect1"> | |
| <h2 id="_packfile_negotiation">Packfile Negotiation</h2> | |
| <div class="sectionbody"> | |
| <div class="paragraph"> | |
| <p>After reference and capabilities discovery, the client can decide to | |
| terminate the connection by sending a flush-pkt, telling the server it can | |
| now gracefully terminate, and disconnect, when it does not need any pack | |
| data. This can happen with the ls-remote command, and also can happen when | |
| the client already is up to date.</p> | |
| </div> | |
| <div class="paragraph"> | |
| <p>Otherwise, it enters the negotiation phase, where the client and | |
| server determine what the minimal packfile necessary for transport is, | |
| by telling the server what objects it wants, its shallow objects | |
| (if any), and the maximum commit depth it wants (if any). The client | |
| will also send a list of the capabilities it wants to be in effect, | |
| out of what the server said it could do with the first <em>want</em> line.</p> | |
| </div> | |
| <div class="listingblock"> | |
| <div class="content"> | |
| <pre> upload-request = want-list | |
| *shallow-line | |
| *1depth-request | |
| [filter-request] | |
| flush-pkt | |
| want-list = first-want | |
| *additional-want | |
| shallow-line = PKT-LINE("shallow" SP obj-id) | |
| depth-request = PKT-LINE("deepen" SP depth) / | |
| PKT-LINE("deepen-since" SP timestamp) / | |
| PKT-LINE("deepen-not" SP ref) | |
| first-want = PKT-LINE("want" SP obj-id SP capability-list) | |
| additional-want = PKT-LINE("want" SP obj-id) | |
| depth = 1*DIGIT | |
| filter-request = PKT-LINE("filter" SP filter-spec)</pre> | |
| </div> | |
| </div> | |
| <div class="paragraph"> | |
| <p>Clients MUST send all the obj-ids they want from the reference | |
| discovery phase as <em>want</em> lines. Clients MUST send at least one | |
| <em>want</em> command in the request body. Clients MUST NOT mention an | |
| obj-id in a <em>want</em> command which did not appear in the response | |
| obtained through ref discovery.</p> | |
| </div> | |
| <div class="paragraph"> | |
| <p>The client MUST write all obj-ids which it only has shallow copies | |
| of (meaning that it does not have the parents of a commit) as | |
| <em>shallow</em> lines so that the server is aware of the limitations of | |
| the client’s history.</p> | |
| </div> | |
| <div class="paragraph"> | |
| <p>The client now sends the maximum commit history depth it wants for | |
| this transaction, which is the number of commits it wants from the | |
| tip of the history, if any, as a <em>deepen</em> line. A depth of 0 is the | |
| same as not making a depth request. The client does not want to receive | |
| any commits beyond this depth, nor does it want objects needed only to | |
| complete those commits. Commits whose parents are not received as a | |
| result are defined as shallow and marked as such in the server. This | |
| information is sent back to the client in the next step.</p> | |
| </div> | |
| <div class="paragraph"> | |
| <p>The client can optionally request that pack-objects omit various | |
| objects from the packfile using one of several filtering techniques. | |
| These are intended for use with partial clone and partial fetch | |
| operations. An object that does not meet a filter-spec value is | |
| omitted unless explicitly requested in a <em>want</em> line. See <code>rev-list</code> | |
| for possible filter-spec values.</p> | |
| </div> | |
| <div class="paragraph"> | |
| <p>Once all the <em>want’s and 'shallow’s (and optional 'deepen</em>) are | |
| transferred, clients MUST send a flush-pkt, to tell the server side | |
| that it is done sending the list.</p> | |
| </div> | |
| <div class="paragraph"> | |
| <p>Otherwise, if the client sent a positive depth request, the server | |
| will determine which commits will and will not be shallow and | |
| send this information to the client. If the client did not request | |
| a positive depth, this step is skipped.</p> | |
| </div> | |
| <div class="listingblock"> | |
| <div class="content"> | |
| <pre> shallow-update = *shallow-line | |
| *unshallow-line | |
| flush-pkt | |
| shallow-line = PKT-LINE("shallow" SP obj-id) | |
| unshallow-line = PKT-LINE("unshallow" SP obj-id)</pre> | |
| </div> | |
| </div> | |
| <div class="paragraph"> | |
| <p>If the client has requested a positive depth, the server will compute | |
| the set of commits which are no deeper than the desired depth. The set | |
| of commits starts at the client’s wants.</p> | |
| </div> | |
| <div class="paragraph"> | |
| <p>The server writes <em>shallow</em> lines for each | |
| commit whose parents will not be sent as a result. The server writes | |
| an <em>unshallow</em> line for each commit which the client has indicated is | |
| shallow, but is no longer shallow at the currently requested depth | |
| (that is, its parents will now be sent). The server MUST NOT mark | |
| as unshallow anything which the client has not indicated was shallow.</p> | |
| </div> | |
| <div class="paragraph"> | |
| <p>Now the client will send a list of the obj-ids it has using <em>have</em> | |
| lines, so the server can make a packfile that only contains the objects | |
| that the client needs. In multi_ack mode, the canonical implementation | |
| will send up to 32 of these at a time, then will send a flush-pkt. The | |
| canonical implementation will skip ahead and send the next 32 immediately, | |
| so that there is always a block of 32 "in-flight on the wire" at a time.</p> | |
| </div> | |
| <div class="listingblock"> | |
| <div class="content"> | |
| <pre> upload-haves = have-list | |
| compute-end | |
| have-list = *have-line | |
| have-line = PKT-LINE("have" SP obj-id) | |
| compute-end = flush-pkt / PKT-LINE("done")</pre> | |
| </div> | |
| </div> | |
| <div class="paragraph"> | |
| <p>If the server reads <em>have</em> lines, it then will respond by ACKing any | |
| of the obj-ids the client said it had that the server also has. The | |
| server will ACK obj-ids differently depending on which ack mode is | |
| chosen by the client.</p> | |
| </div> | |
| <div class="paragraph"> | |
| <p>In multi_ack mode:</p> | |
| </div> | |
| <div class="ulist"> | |
| <ul> | |
| <li> | |
| <p>the server will respond with <em>ACK obj-id continue</em> for any common | |
| commits.</p> | |
| </li> | |
| <li> | |
| <p>once the server has found an acceptable common base commit and is | |
| ready to make a packfile, it will blindly ACK all <em>have</em> obj-ids | |
| back to the client.</p> | |
| </li> | |
| <li> | |
| <p>the server will then send a <em>NAK</em> and then wait for another response | |
| from the client - either a <em>done</em> or another list of <em>have</em> lines.</p> | |
| </li> | |
| </ul> | |
| </div> | |
| <div class="paragraph"> | |
| <p>In multi_ack_detailed mode:</p> | |
| </div> | |
| <div class="ulist"> | |
| <ul> | |
| <li> | |
| <p>the server will differentiate the ACKs where it is signaling | |
| that it is ready to send data with <em>ACK obj-id ready</em> lines, and | |
| signals the identified common commits with <em>ACK obj-id common</em> lines.</p> | |
| </li> | |
| </ul> | |
| </div> | |
| <div class="paragraph"> | |
| <p>Without either multi_ack or multi_ack_detailed:</p> | |
| </div> | |
| <div class="ulist"> | |
| <ul> | |
| <li> | |
| <p><em>upload-pack</em> sends "ACK obj-id" on the first common object it finds. | |
| After that it says nothing until the client gives it a "done".</p> | |
| </li> | |
| <li> | |
| <p><em>upload-pack</em> sends "NAK" on a flush-pkt if no common object | |
| has been found yet. If one has been found, and thus an ACK | |
| was already sent, it’s silent on the flush-pkt.</p> | |
| </li> | |
| </ul> | |
| </div> | |
| <div class="paragraph"> | |
| <p>After the client has gotten enough ACK responses that it can determine | |
| that the server has enough information to send an efficient packfile | |
| (in the canonical implementation, this is determined when it has received | |
| enough ACKs that it can color everything left in the --date-order queue | |
| as common with the server, or the --date-order queue is empty), or the | |
| client determines that it wants to give up (in the canonical implementation, | |
| this is determined when the client sends 256 <em>have</em> lines without getting | |
| any of them ACKed by the server - meaning there is nothing in common and | |
| the server should just send all of its objects), then the client will send | |
| a <em>done</em> command. The <em>done</em> command signals to the server that the client | |
| is ready to receive its packfile data.</p> | |
| </div> | |
| <div class="paragraph"> | |
| <p>However, the 256 limit <strong>only</strong> turns on in the canonical client | |
| implementation if we have received at least one "ACK %s continue" | |
| during a prior round. This helps to ensure that at least one common | |
| ancestor is found before we give up entirely.</p> | |
| </div> | |
| <div class="paragraph"> | |
| <p>Once the <em>done</em> line is read from the client, the server will either | |
| send a final <em>ACK obj-id</em> or it will send a <em>NAK</em>. <em>obj-id</em> is the object | |
| name of the last commit determined to be common. The server only sends | |
| ACK after <em>done</em> if there is at least one common base and multi_ack or | |
| multi_ack_detailed is enabled. The server always sends NAK after <em>done</em> | |
| if there is no common base found.</p> | |
| </div> | |
| <div class="paragraph"> | |
| <p>Instead of <em>ACK</em> or <em>NAK</em>, the server may send an error message (for | |
| example, if it does not recognize an object in a <em>want</em> line received | |
| from the client).</p> | |
| </div> | |
| <div class="paragraph"> | |
| <p>Then the server will start sending its packfile data.</p> | |
| </div> | |
| <div class="listingblock"> | |
| <div class="content"> | |
| <pre> server-response = *ack_multi ack / nak | |
| ack_multi = PKT-LINE("ACK" SP obj-id ack_status) | |
| ack_status = "continue" / "common" / "ready" | |
| ack = PKT-LINE("ACK" SP obj-id) | |
| nak = PKT-LINE("NAK")</pre> | |
| </div> | |
| </div> | |
| <div class="paragraph"> | |
| <p>A simple clone may look like this (with no <em>have</em> lines):</p> | |
| </div> | |
| <div class="listingblock"> | |
| <div class="content"> | |
| <pre> C: 0054want 74730d410fcb6603ace96f1dc55ea6196122532d multi_ack \ | |
| side-band-64k ofs-delta\n | |
| C: 0032want 7d1665144a3a975c05f1f43902ddaf084e784dbe\n | |
| C: 0032want 5a3f6be755bbb7deae50065988cbfa1ffa9ab68a\n | |
| C: 0032want 7e47fe2bd8d01d481f44d7af0531bd93d3b21c01\n | |
| C: 0032want 74730d410fcb6603ace96f1dc55ea6196122532d\n | |
| C: 0000 | |
| C: 0009done\n | |
| S: 0008NAK\n | |
| S: [PACKFILE]</pre> | |
| </div> | |
| </div> | |
| <div class="paragraph"> | |
| <p>An incremental update (fetch) response might look like this:</p> | |
| </div> | |
| <div class="listingblock"> | |
| <div class="content"> | |
| <pre> C: 0054want 74730d410fcb6603ace96f1dc55ea6196122532d multi_ack \ | |
| side-band-64k ofs-delta\n | |
| C: 0032want 7d1665144a3a975c05f1f43902ddaf084e784dbe\n | |
| C: 0032want 5a3f6be755bbb7deae50065988cbfa1ffa9ab68a\n | |
| C: 0000 | |
| C: 0032have 7e47fe2bd8d01d481f44d7af0531bd93d3b21c01\n | |
| C: [30 more have lines] | |
| C: 0032have 74730d410fcb6603ace96f1dc55ea6196122532d\n | |
| C: 0000 | |
| S: 003aACK 7e47fe2bd8d01d481f44d7af0531bd93d3b21c01 continue\n | |
| S: 003aACK 74730d410fcb6603ace96f1dc55ea6196122532d continue\n | |
| S: 0008NAK\n | |
| C: 0009done\n | |
| S: 0031ACK 74730d410fcb6603ace96f1dc55ea6196122532d\n | |
| S: [PACKFILE]</pre> | |
| </div> | |
| </div> | |
| </div> | |
| </div> | |
| <div class="sect1"> | |
| <h2 id="_packfile_data">Packfile Data</h2> | |
| <div class="sectionbody"> | |
| <div class="paragraph"> | |
| <p>Now that the client and server have finished negotiation about what | |
| the minimal amount of data that needs to be sent to the client is, the server | |
| will construct and send the required data in packfile format.</p> | |
| </div> | |
| <div class="paragraph"> | |
| <p>See <a href="gitformat-pack.html">gitformat-pack(5)</a> for what the packfile itself actually looks like.</p> | |
| </div> | |
| <div class="paragraph"> | |
| <p>If <em>side-band</em> or <em>side-band-64k</em> capabilities have been specified by | |
| the client, the server will send the packfile data multiplexed.</p> | |
| </div> | |
| <div class="paragraph"> | |
| <p>Each packet starting with the packet-line length of the amount of data | |
| that follows, followed by a single byte specifying the sideband the | |
| following data is coming in on.</p> | |
| </div> | |
| <div class="paragraph"> | |
| <p>In <em>side-band</em> mode, it will send up to 999 data bytes plus 1 control | |
| code, for a total of up to 1000 bytes in a pkt-line. In <em>side-band-64k</em> | |
| mode it will send up to 65519 data bytes plus 1 control code, for a | |
| total of up to 65520 bytes in a pkt-line.</p> | |
| </div> | |
| <div class="paragraph"> | |
| <p>The sideband byte will be a <em>1</em>, <em>2</em> or a <em>3</em>. Sideband <em>1</em> will contain | |
| packfile data, sideband <em>2</em> will be used for progress information that the | |
| client will generally print to stderr and sideband <em>3</em> is used for error | |
| information.</p> | |
| </div> | |
| <div class="paragraph"> | |
| <p>If no <em>side-band</em> capability was specified, the server will stream the | |
| entire packfile without multiplexing.</p> | |
| </div> | |
| </div> | |
| </div> | |
| <div class="sect1"> | |
| <h2 id="_pushing_data_to_a_server">Pushing Data To a Server</h2> | |
| <div class="sectionbody"> | |
| <div class="paragraph"> | |
| <p>Pushing data to a server will invoke the <em>receive-pack</em> process on the | |
| server, which will allow the client to tell it which references it should | |
| update and then send all the data the server will need for those new | |
| references to be complete. Once all the data is received and validated, | |
| the server will then update its references to what the client specified.</p> | |
| </div> | |
| </div> | |
| </div> | |
| <div class="sect1"> | |
| <h2 id="_authentication">Authentication</h2> | |
| <div class="sectionbody"> | |
| <div class="paragraph"> | |
| <p>The protocol itself contains no authentication mechanisms. That is to be | |
| handled by the transport, such as SSH, before the <em>receive-pack</em> process is | |
| invoked. If <em>receive-pack</em> is configured over the Git transport, those | |
| repositories will be writable by anyone who can access that port (9418) as | |
| that transport is unauthenticated.</p> | |
| </div> | |
| </div> | |
| </div> | |
| <div class="sect1"> | |
| <h2 id="_reference_discovery_2">Reference Discovery</h2> | |
| <div class="sectionbody"> | |
| <div class="paragraph"> | |
| <p>The reference discovery phase is done nearly the same way as it is in the | |
| fetching protocol. Each reference obj-id and name on the server is sent | |
| in packet-line format to the client, followed by a flush-pkt. The only | |
| real difference is that the capability listing is different - the only | |
| possible values are <em>report-status</em>, <em>report-status-v2</em>, <em>delete-refs</em>, | |
| <em>ofs-delta</em>, <em>atomic</em> and <em>push-options</em>.</p> | |
| </div> | |
| </div> | |
| </div> | |
| <div class="sect1"> | |
| <h2 id="_reference_update_request_and_packfile_transfer">Reference Update Request and Packfile Transfer</h2> | |
| <div class="sectionbody"> | |
| <div class="paragraph"> | |
| <p>Once the client knows what references the server is at, it can send a | |
| list of reference update requests. For each reference on the server | |
| that it wants to update, it sends a line listing the obj-id currently on | |
| the server, the obj-id the client would like to update it to and the name | |
| of the reference.</p> | |
| </div> | |
| <div class="paragraph"> | |
| <p>This list is followed by a flush-pkt.</p> | |
| </div> | |
| <div class="listingblock"> | |
| <div class="content"> | |
| <pre> update-requests = *shallow ( command-list | push-cert ) | |
| shallow = PKT-LINE("shallow" SP obj-id) | |
| command-list = PKT-LINE(command NUL capability-list) | |
| *PKT-LINE(command) | |
| flush-pkt | |
| command = create / delete / update | |
| create = zero-id SP new-id SP name | |
| delete = old-id SP zero-id SP name | |
| update = old-id SP new-id SP name | |
| old-id = obj-id | |
| new-id = obj-id | |
| push-cert = PKT-LINE("push-cert" NUL capability-list LF) | |
| PKT-LINE("certificate version 0.1" LF) | |
| PKT-LINE("pusher" SP ident LF) | |
| PKT-LINE("pushee" SP url LF) | |
| PKT-LINE("nonce" SP nonce LF) | |
| *PKT-LINE("push-option" SP push-option LF) | |
| PKT-LINE(LF) | |
| *PKT-LINE(command LF) | |
| *PKT-LINE(gpg-signature-lines LF) | |
| PKT-LINE("push-cert-end" LF) | |
| push-option = 1*( VCHAR | SP )</pre> | |
| </div> | |
| </div> | |
| <div class="paragraph"> | |
| <p>If the server has advertised the <em>push-options</em> capability and the client has | |
| specified <em>push-options</em> as part of the capability list above, the client then | |
| sends its push options followed by a flush-pkt.</p> | |
| </div> | |
| <div class="listingblock"> | |
| <div class="content"> | |
| <pre> push-options = *PKT-LINE(push-option) flush-pkt</pre> | |
| </div> | |
| </div> | |
| <div class="paragraph"> | |
| <p>For backwards compatibility with older Git servers, if the client sends a push | |
| cert and push options, it MUST send its push options both embedded within the | |
| push cert and after the push cert. (Note that the push options within the cert | |
| are prefixed, but the push options after the cert are not.) Both these lists | |
| MUST be the same, modulo the prefix.</p> | |
| </div> | |
| <div class="paragraph"> | |
| <p>After that the packfile that | |
| should contain all the objects that the server will need to complete the new | |
| references will be sent.</p> | |
| </div> | |
| <div class="listingblock"> | |
| <div class="content"> | |
| <pre> packfile = "PACK" 28*(OCTET)</pre> | |
| </div> | |
| </div> | |
| <div class="paragraph"> | |
| <p>If the receiving end does not support delete-refs, the sending end MUST | |
| NOT ask for delete command.</p> | |
| </div> | |
| <div class="paragraph"> | |
| <p>If the receiving end does not support push-cert, the sending end | |
| MUST NOT send a push-cert command. When a push-cert command is | |
| sent, command-list MUST NOT be sent; the commands recorded in the | |
| push certificate is used instead.</p> | |
| </div> | |
| <div class="paragraph"> | |
| <p>The packfile MUST NOT be sent if the only command used is <em>delete</em>.</p> | |
| </div> | |
| <div class="paragraph"> | |
| <p>A packfile MUST be sent if either create or update command is used, | |
| even if the server already has all the necessary objects. In this | |
| case the client MUST send an empty packfile. The only time this | |
| is likely to happen is if the client is creating | |
| a new branch or a tag that points to an existing obj-id.</p> | |
| </div> | |
| <div class="paragraph"> | |
| <p>The server will receive the packfile, unpack it, then validate each | |
| reference that is being updated that it hasn’t changed while the request | |
| was being processed (the obj-id is still the same as the old-id), and | |
| it will run any update hooks to make sure that the update is acceptable. | |
| If all of that is fine, the server will then update the references.</p> | |
| </div> | |
| </div> | |
| </div> | |
| <div class="sect1"> | |
| <h2 id="_push_certificate">Push Certificate</h2> | |
| <div class="sectionbody"> | |
| <div class="paragraph"> | |
| <p>A push certificate begins with a set of header lines. After the | |
| header and an empty line, the protocol commands follow, one per | |
| line. Note that the trailing LF in push-cert PKT-LINEs is <em>not</em> | |
| optional; it must be present.</p> | |
| </div> | |
| <div class="paragraph"> | |
| <p>Currently, the following header fields are defined:</p> | |
| </div> | |
| <div class="dlist"> | |
| <dl> | |
| <dt class="hdlist1"><code>pusher</code> ident</dt> | |
| <dd> | |
| <p>Identify the GPG key in "Human Readable Name <email@address>" | |
| format.</p> | |
| </dd> | |
| <dt class="hdlist1"><code>pushee</code> url</dt> | |
| <dd> | |
| <p>The repository URL (anonymized, if the URL contains | |
| authentication material) the user who ran <code>git</code> <code>push</code> | |
| intended to push into.</p> | |
| </dd> | |
| <dt class="hdlist1"><code>nonce</code> nonce</dt> | |
| <dd> | |
| <p>The <em>nonce</em> string the receiving repository asked the | |
| pushing user to include in the certificate, to prevent | |
| replay attacks.</p> | |
| </dd> | |
| </dl> | |
| </div> | |
| <div class="paragraph"> | |
| <p>The GPG signature lines are a detached signature for the contents | |
| recorded in the push certificate before the signature block begins. | |
| The detached signature is used to certify that the commands were | |
| given by the pusher, who must be the signer.</p> | |
| </div> | |
| </div> | |
| </div> | |
| <div class="sect1"> | |
| <h2 id="_report_status">Report Status</h2> | |
| <div class="sectionbody"> | |
| <div class="paragraph"> | |
| <p>After receiving the pack data from the sender, the receiver sends a | |
| report if <em>report-status</em> or <em>report-status-v2</em> capability is in effect. | |
| It is a short listing of what happened in that update. It will first | |
| list the status of the packfile unpacking as either <em>unpack ok</em> or | |
| <em>unpack [error]</em>. Then it will list the status for each of the references | |
| that it tried to update. Each line is either <em>ok [refname]</em> if the | |
| update was successful, or <em>ng [refname] [error]</em> if the update was not.</p> | |
| </div> | |
| <div class="listingblock"> | |
| <div class="content"> | |
| <pre> report-status = unpack-status | |
| 1*(command-status) | |
| flush-pkt | |
| unpack-status = PKT-LINE("unpack" SP unpack-result) | |
| unpack-result = "ok" / error-msg | |
| command-status = command-ok / command-fail | |
| command-ok = PKT-LINE("ok" SP refname) | |
| command-fail = PKT-LINE("ng" SP refname SP error-msg) | |
| error-msg = 1*(OCTET) ; where not "ok"</pre> | |
| </div> | |
| </div> | |
| <div class="paragraph"> | |
| <p>The <em>report-status-v2</em> capability extends the protocol by adding new option | |
| lines in order to support reporting of reference rewritten by the | |
| <em>proc-receive</em> hook. The <em>proc-receive</em> hook may handle a command for a | |
| pseudo-reference which may create or update one or more references, and each | |
| reference may have different name, different new-oid, and different old-oid.</p> | |
| </div> | |
| <div class="listingblock"> | |
| <div class="content"> | |
| <pre> report-status-v2 = unpack-status | |
| 1*(command-status-v2) | |
| flush-pkt | |
| unpack-status = PKT-LINE("unpack" SP unpack-result) | |
| unpack-result = "ok" / error-msg | |
| command-status-v2 = command-ok-v2 / command-fail | |
| command-ok-v2 = command-ok | |
| *option-line | |
| command-ok = PKT-LINE("ok" SP refname) | |
| command-fail = PKT-LINE("ng" SP refname SP error-msg) | |
| error-msg = 1*(OCTET) ; where not "ok" | |
| option-line = *1(option-refname) | |
| *1(option-old-oid) | |
| *1(option-new-oid) | |
| *1(option-forced-update) | |
| option-refname = PKT-LINE("option" SP "refname" SP refname) | |
| option-old-oid = PKT-LINE("option" SP "old-oid" SP obj-id) | |
| option-new-oid = PKT-LINE("option" SP "new-oid" SP obj-id) | |
| option-force = PKT-LINE("option" SP "forced-update")</pre> | |
| </div> | |
| </div> | |
| <div class="paragraph"> | |
| <p>Updates can be unsuccessful for a number of reasons. The reference can have | |
| changed since the reference discovery phase was originally sent, meaning | |
| someone pushed in the meantime. The reference being pushed could be a | |
| non-fast-forward reference and the update hooks or configuration could be | |
| set to not allow that, etc. Also, some references can be updated while others | |
| can be rejected.</p> | |
| </div> | |
| <div class="paragraph"> | |
| <p>An example client/server communication might look like this:</p> | |
| </div> | |
| <div class="listingblock"> | |
| <div class="content"> | |
| <pre> S: 006274730d410fcb6603ace96f1dc55ea6196122532d refs/heads/local\0report-status delete-refs ofs-delta\n | |
| S: 003e7d1665144a3a975c05f1f43902ddaf084e784dbe refs/heads/debug\n | |
| S: 003f74730d410fcb6603ace96f1dc55ea6196122532d refs/heads/master\n | |
| S: 003d74730d410fcb6603ace96f1dc55ea6196122532d refs/heads/team\n | |
| S: 0000 | |
| C: 00677d1665144a3a975c05f1f43902ddaf084e784dbe 74730d410fcb6603ace96f1dc55ea6196122532d refs/heads/debug\n | |
| C: 006874730d410fcb6603ace96f1dc55ea6196122532d 5a3f6be755bbb7deae50065988cbfa1ffa9ab68a refs/heads/master\n | |
| C: 0000 | |
| C: [PACKDATA] | |
| S: 000eunpack ok\n | |
| S: 0018ok refs/heads/debug\n | |
| S: 002ang refs/heads/master non-fast-forward\n</pre> | |
| </div> | |
| </div> | |
| </div> | |
| </div> | |
| <div class="sect1"> | |
| <h2 id="_git">GIT</h2> | |
| <div class="sectionbody"> | |
| <div class="paragraph"> | |
| <p>Part of the <a href="git.html">git(1)</a> suite</p> | |
| </div> | |
| </div> | |
| </div> | |
| </div> | |
| <div id="footer"> | |
| <div id="footer-text"> | |
| Last updated 2026-03-12 12:43:12 -0700 | |
| </div> | |
| </div> | |
| </body> | |
| </html> |