2 <html xmlns=
"http://www.w3.org/1999/xhtml" lang=
"en">
4 <meta charset=
"UTF-8"/>
5 <meta http-equiv=
"X-UA-Compatible" content=
"IE=edge"/>
6 <meta name=
"viewport" content=
"width=device-width, initial-scale=1.0"/>
7 <meta name=
"generator" content=
"Asciidoctor 2.0.20"/>
8 <title>Bundle URIs
</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"/>
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%}
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}
21 abbr[title]{cursor:help;border-bottom:
1px dotted #dddddf;text-decoration:none}
22 dfn{font-style:italic}
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"}
29 sub,sup{font-size:
75%;line-height:
0;position:relative;vertical-align:baseline}
33 svg:not(:root){overflow:hidden}
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}
62 img,object,svg{display:inline-block;vertical-align:middle}
63 textarea{height:auto;min-height:
50px}
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}
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}
75 h2{font-size:
1.6875em}
76 h3,#toctitle,.sidebarblock
>.content
>.title{font-size:
1.375em}
77 h4,h5{font-size:
1.125em}
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}
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}
111 .clearfix::before,.clearfix::after,.float-group::before,.float-group::after{content:
" ";display:table}
112 .clearfix::after,.float-group::after{clear:both}
113 :not(pre).nobreak{word-wrap:normal}
114 :not(pre).nowrap{white-space:nowrap}
115 :not(pre).pre-wrap{white-space:pre-wrap}
116 :not(pre):not([class^=L])
>code{font-size:
.9375em;font-style:normal!important;letter-spacing:
0;padding:
.1em
.5ex;word-spacing:-
.15em;background:#f7f7f8;border-radius:
4px;line-height:
1.45;text-rendering:optimizeSpeed}
117 pre{color:rgba(
0,
0,
0,
.9);font-family:
"Droid Sans Mono",
"DejaVu Sans Mono",monospace;line-height:
1.45;text-rendering:optimizeSpeed}
118 pre code,pre pre{color:inherit;font-size:inherit;line-height:inherit}
119 pre
>code{display:block}
120 pre.nowrap,pre.nowrap pre{white-space:pre;word-wrap:normal}
121 em em{font-style:normal}
122 strong strong{font-weight:
400}
123 .keyseq{color:rgba(
51,
51,
51,
.8)}
124 kbd{font-family:
"Droid Sans Mono",
"DejaVu Sans Mono",monospace;display:inline-block;color:rgba(
0,
0,
0,
.8);font-size:
.65em;line-height:
1.45;background:#f7f7f7;border:
1px solid #ccc;border-radius:
3px;box-shadow:
0 1px
0 rgba(
0,
0,
0,
.2),inset
0 0 0 .1em #fff;margin:
0 .15em;padding:
.2em
.5em;vertical-align:middle;position:relative;top:-
.1em;white-space:nowrap}
125 .keyseq kbd:first-child{margin-left:
0}
126 .keyseq kbd:last-child{margin-right:
0}
127 .menuseq,.menuref{color:#
000}
128 .menuseq b:not(.caret),.menuref{font-weight:inherit}
129 .menuseq{word-spacing:-
.02em}
130 .menuseq b.caret{font-size:
1.25em;line-height:
.8}
131 .menuseq i.caret{font-weight:bold;text-align:center;width:
.45em}
132 b.button::before,b.button::after{position:relative;top:-
1px;font-weight:
400}
133 b.button::before{content:
"[";padding:
0 3px
0 2px}
134 b.button::after{content:
"]";padding:
0 2px
0 3px}
135 p a
>code:hover{color:rgba(
0,
0,
0,
.9)}
136 #header,#content,#footnotes,#footer{width:
100%;margin:
0 auto;max-width:
62.5em;*zoom:
1;position:relative;padding-left:
.9375em;padding-right:
.9375em}
137 #header::before,#header::after,#content::before,#content::after,#footnotes::before,#footnotes::after,#footer::before,#footer::after{content:
" ";display:table}
138 #header::after,#content::after,#footnotes::after,#footer::after{clear:both}
139 #content{margin-top:
1.25em}
140 #content::before{content:none}
141 #header
>h1:first-child{color:rgba(
0,
0,
0,
.85);margin-top:
2.25rem;margin-bottom:
0}
142 #header
>h1:first-child+#toc{margin-top:
8px;border-top:
1px solid #dddddf}
143 #header
>h1:only-child,body.toc2 #header
>h1:nth-last-child(
2){border-bottom:
1px solid #dddddf;padding-bottom:
8px}
144 #header .details{border-bottom:
1px solid #dddddf;line-height:
1.45;padding-top:
.25em;padding-bottom:
.25em;padding-left:
.25em;color:rgba(
0,
0,
0,
.6);display:flex;flex-flow:row wrap}
145 #header .details span:first-child{margin-left:-
.125em}
146 #header .details span.email a{color:rgba(
0,
0,
0,
.85)}
147 #header .details br{display:none}
148 #header .details br+span::before{content:
"\00a0\2013\00a0"}
149 #header .details br+span.author::before{content:
"\00a0\22c5\00a0";color:rgba(
0,
0,
0,
.85)}
150 #header .details br+span#revremark::before{content:
"\00a0|\00a0"}
151 #header #revnumber{text-transform:capitalize}
152 #header #revnumber::after{content:
"\00a0"}
153 #content
>h1:first-child:not([class]){color:rgba(
0,
0,
0,
.85);border-bottom:
1px solid #dddddf;padding-bottom:
8px;margin-top:
0;padding-top:
1rem;margin-bottom:
1.25rem}
154 #toc{border-bottom:
1px solid #e7e7e9;padding-bottom:
.5em}
155 #toc
>ul{margin-left:
.125em}
156 #toc ul.sectlevel0
>li
>a{font-style:italic}
157 #toc ul.sectlevel0 ul.sectlevel1{margin:
.5em
0}
158 #toc ul{font-family:
"Open Sans",
"DejaVu Sans",sans-serif;list-style-type:none}
159 #toc li{line-height:
1.3334;margin-top:
.3334em}
160 #toc a{text-decoration:none}
161 #toc a:active{text-decoration:underline}
162 #toctitle{color:#
7a2518;font-size:
1.2em}
163 @media screen and (min-width:
768px){#toctitle{font-size:
1.375em}
164 body.toc2{padding-left:
15em;padding-right:
0}
165 #toc.toc2{margin-top:
0!important;background:#f8f8f7;position:fixed;width:
15em;left:
0;top:
0;border-right:
1px solid #e7e7e9;border-top-width:
0!important;border-bottom-width:
0!important;z-index:
1000;padding:
1.25em
1em;height:
100%;overflow:auto}
166 #toc.toc2 #toctitle{margin-top:
0;margin-bottom:
.8rem;font-size:
1.2em}
167 #toc.toc2
>ul{font-size:
.9em;margin-bottom:
0}
168 #toc.toc2 ul ul{margin-left:
0;padding-left:
1em}
169 #toc.toc2 ul.sectlevel0 ul.sectlevel1{padding-left:
0;margin-top:
.5em;margin-bottom:
.5em}
170 body.toc2.toc-right{padding-left:
0;padding-right:
15em}
171 body.toc2.toc-right #toc.toc2{border-right-width:
0;border-left:
1px solid #e7e7e9;left:auto;right:
0}}
172 @media screen and (min-width:
1280px){body.toc2{padding-left:
20em;padding-right:
0}
173 #toc.toc2{width:
20em}
174 #toc.toc2 #toctitle{font-size:
1.375em}
175 #toc.toc2
>ul{font-size:
.95em}
176 #toc.toc2 ul ul{padding-left:
1.25em}
177 body.toc2.toc-right{padding-left:
0;padding-right:
20em}}
178 #content #toc{border:
1px solid #e0e0dc;margin-bottom:
1.25em;padding:
1.25em;background:#f8f8f7;border-radius:
4px}
179 #content #toc
>:first-child{margin-top:
0}
180 #content #toc
>:last-child{margin-bottom:
0}
181 #footer{max-width:none;background:rgba(
0,
0,
0,
.8);padding:
1.25em}
182 #footer-text{color:hsla(
0,
0%,
100%,
.8);line-height:
1.44}
183 #content{margin-bottom:
.625em}
184 .sect1{padding-bottom:
.625em}
185 @media screen and (min-width:
768px){#content{margin-bottom:
1.25em}
186 .sect1{padding-bottom:
1.25em}}
187 .sect1:last-child{padding-bottom:
0}
188 .sect1+.sect1{border-top:
1px solid #e7e7e9}
189 #content h1
>a.anchor,h2
>a.anchor,h3
>a.anchor,#toctitle
>a.anchor,.sidebarblock
>.content
>.title
>a.anchor,h4
>a.anchor,h5
>a.anchor,h6
>a.anchor{position:absolute;z-index:
1001;width:
1.5ex;margin-left:-
1.5ex;display:block;text-decoration:none!important;visibility:hidden;text-align:center;font-weight:
400}
190 #content h1
>a.anchor::before,h2
>a.anchor::before,h3
>a.anchor::before,#toctitle
>a.anchor::before,.sidebarblock
>.content
>.title
>a.anchor::before,h4
>a.anchor::before,h5
>a.anchor::before,h6
>a.anchor::before{content:
"\00A7";font-size:
.85em;display:block;padding-top:
.1em}
191 #content h1:hover
>a.anchor,#content h1
>a.anchor:hover,h2:hover
>a.anchor,h2
>a.anchor:hover,h3:hover
>a.anchor,#toctitle:hover
>a.anchor,.sidebarblock
>.content
>.title:hover
>a.anchor,h3
>a.anchor:hover,#toctitle
>a.anchor:hover,.sidebarblock
>.content
>.title
>a.anchor:hover,h4:hover
>a.anchor,h4
>a.anchor:hover,h5:hover
>a.anchor,h5
>a.anchor:hover,h6:hover
>a.anchor,h6
>a.anchor:hover{visibility:visible}
192 #content h1
>a.link,h2
>a.link,h3
>a.link,#toctitle
>a.link,.sidebarblock
>.content
>.title
>a.link,h4
>a.link,h5
>a.link,h6
>a.link{color:#ba3925;text-decoration:none}
193 #content h1
>a.link:hover,h2
>a.link:hover,h3
>a.link:hover,#toctitle
>a.link:hover,.sidebarblock
>.content
>.title
>a.link:hover,h4
>a.link:hover,h5
>a.link:hover,h6
>a.link:hover{color:#a53221}
194 details,.audioblock,.imageblock,.literalblock,.listingblock,.stemblock,.videoblock{margin-bottom:
1.25em}
195 details{margin-left:
1.25rem}
196 details
>summary{cursor:pointer;display:block;position:relative;line-height:
1.6;margin-bottom:
.625rem;outline:none;-webkit-tap-highlight-color:transparent}
197 details
>summary::-webkit-details-marker{display:none}
198 details
>summary::before{content:
"";border:solid transparent;border-left:solid;border-width:
.3em
0 .3em
.5em;position:absolute;top:
.5em;left:-
1.25rem;transform:translateX(
15%)}
199 details[open]
>summary::before{border:solid transparent;border-top:solid;border-width:
.5em
.3em
0;transform:translateY(
15%)}
200 details
>summary::after{content:
"";width:
1.25rem;height:
1em;position:absolute;top:
.3em;left:-
1.25rem}
201 .admonitionblock td.content
>.title,.audioblock
>.title,.exampleblock
>.title,.imageblock
>.title,.listingblock
>.title,.literalblock
>.title,.stemblock
>.title,.openblock
>.title,.paragraph
>.title,.quoteblock
>.title,table.tableblock
>.title,.verseblock
>.title,.videoblock
>.title,.dlist
>.title,.olist
>.title,.ulist
>.title,.qlist
>.title,.hdlist
>.title{text-rendering:optimizeLegibility;text-align:left;font-family:
"Noto Serif",
"DejaVu Serif",serif;font-size:
1rem;font-style:italic}
202 table.tableblock.fit-content
>caption.title{white-space:nowrap;width:
0}
203 .paragraph.lead
>p,#preamble
>.sectionbody
>[class=paragraph]:first-of-type p{font-size:
1.21875em;line-height:
1.6;color:rgba(
0,
0,
0,
.85)}
204 .admonitionblock
>table{border-collapse:separate;border:
0;background:none;width:
100%}
205 .admonitionblock
>table td.icon{text-align:center;width:
80px}
206 .admonitionblock
>table td.icon img{max-width:none}
207 .admonitionblock
>table td.icon .title{font-weight:bold;font-family:
"Open Sans",
"DejaVu Sans",sans-serif;text-transform:uppercase}
208 .admonitionblock
>table td.content{padding-left:
1.125em;padding-right:
1.25em;border-left:
1px solid #dddddf;color:rgba(
0,
0,
0,
.6);word-wrap:anywhere}
209 .admonitionblock
>table td.content
>:last-child
>:last-child{margin-bottom:
0}
210 .exampleblock
>.content{border:
1px solid #e6e6e6;margin-bottom:
1.25em;padding:
1.25em;background:#fff;border-radius:
4px}
211 .sidebarblock{border:
1px solid #dbdbd6;margin-bottom:
1.25em;padding:
1.25em;background:#f3f3f2;border-radius:
4px}
212 .sidebarblock
>.content
>.title{color:#
7a2518;margin-top:
0;text-align:center}
213 .exampleblock
>.content
>:first-child,.sidebarblock
>.content
>:first-child{margin-top:
0}
214 .exampleblock
>.content
>:last-child,.exampleblock
>.content
>:last-child
>:last-child,.exampleblock
>.content .olist
>ol
>li:last-child
>:last-child,.exampleblock
>.content .ulist
>ul
>li:last-child
>:last-child,.exampleblock
>.content .qlist
>ol
>li:last-child
>:last-child,.sidebarblock
>.content
>:last-child,.sidebarblock
>.content
>:last-child
>:last-child,.sidebarblock
>.content .olist
>ol
>li:last-child
>:last-child,.sidebarblock
>.content .ulist
>ul
>li:last-child
>:last-child,.sidebarblock
>.content .qlist
>ol
>li:last-child
>:last-child{margin-bottom:
0}
215 .literalblock pre,.listingblock
>.content
>pre{border-radius:
4px;overflow-x:auto;padding:
1em;font-size:
.8125em}
216 @media screen and (min-width:
768px){.literalblock pre,.listingblock
>.content
>pre{font-size:
.90625em}}
217 @media screen and (min-width:
1280px){.literalblock pre,.listingblock
>.content
>pre{font-size:
1em}}
218 .literalblock pre,.listingblock
>.content
>pre:not(.highlight),.listingblock
>.content
>pre[class=highlight],.listingblock
>.content
>pre[class^=
"highlight "]{background:#f7f7f8}
219 .literalblock.output pre{color:#f7f7f8;background:rgba(
0,
0,
0,
.9)}
220 .listingblock
>.content{position:relative}
221 .listingblock code[data-lang]::before{display:none;content:attr(data-lang);position:absolute;font-size:
.75em;top:
.425rem;right:
.5rem;line-height:
1;text-transform:uppercase;color:inherit;opacity:
.5}
222 .listingblock:hover code[data-lang]::before{display:block}
223 .listingblock.terminal pre .command::before{content:attr(data-prompt);padding-right:
.5em;color:inherit;opacity:
.5}
224 .listingblock.terminal pre .command:not([data-prompt])::before{content:
"$"}
225 .listingblock pre.highlightjs{padding:
0}
226 .listingblock pre.highlightjs
>code{padding:
1em;border-radius:
4px}
227 .listingblock pre.prettyprint{border-width:
0}
228 .prettyprint{background:#f7f7f8}
229 pre.prettyprint .linenums{line-height:
1.45;margin-left:
2em}
230 pre.prettyprint li{background:none;list-style-type:inherit;padding-left:
0}
231 pre.prettyprint li code[data-lang]::before{opacity:
1}
232 pre.prettyprint li:not(:first-child) code[data-lang]::before{display:none}
233 table.linenotable{border-collapse:separate;border:
0;margin-bottom:
0;background:none}
234 table.linenotable td[class]{color:inherit;vertical-align:top;padding:
0;line-height:inherit;white-space:normal}
235 table.linenotable td.code{padding-left:
.75em}
236 table.linenotable td.linenos,pre.pygments .linenos{border-right:
1px solid;opacity:
.35;padding-right:
.5em;-webkit-user-select:none;-moz-user-select:none;-ms-user-select:none;user-select:none}
237 pre.pygments span.linenos{display:inline-block;margin-right:
.75em}
238 .quoteblock{margin:
0 1em
1.25em
1.5em;display:table}
239 .quoteblock:not(.excerpt)
>.title{margin-left:-
1.5em;margin-bottom:
.75em}
240 .quoteblock blockquote,.quoteblock p{color:rgba(
0,
0,
0,
.85);font-size:
1.15rem;line-height:
1.75;word-spacing:
.1em;letter-spacing:
0;font-style:italic;text-align:justify}
241 .quoteblock blockquote{margin:
0;padding:
0;border:
0}
242 .quoteblock blockquote::before{content:
"\201c";float:left;font-size:
2.75em;font-weight:bold;line-height:
.6em;margin-left:-
.6em;color:#
7a2518;text-shadow:
0 1px
2px rgba(
0,
0,
0,
.1)}
243 .quoteblock blockquote
>.paragraph:last-child p{margin-bottom:
0}
244 .quoteblock .attribution{margin-top:
.75em;margin-right:
.5ex;text-align:right}
245 .verseblock{margin:
0 1em
1.25em}
246 .verseblock pre{font-family:
"Open Sans",
"DejaVu Sans",sans-serif;font-size:
1.15rem;color:rgba(
0,
0,
0,
.85);font-weight:
300;text-rendering:optimizeLegibility}
247 .verseblock pre strong{font-weight:
400}
248 .verseblock .attribution{margin-top:
1.25rem;margin-left:
.5ex}
249 .quoteblock .attribution,.verseblock .attribution{font-size:
.9375em;line-height:
1.45;font-style:italic}
250 .quoteblock .attribution br,.verseblock .attribution br{display:none}
251 .quoteblock .attribution cite,.verseblock .attribution cite{display:block;letter-spacing:-
.025em;color:rgba(
0,
0,
0,
.6)}
252 .quoteblock.abstract blockquote::before,.quoteblock.excerpt blockquote::before,.quoteblock .quoteblock blockquote::before{display:none}
253 .quoteblock.abstract blockquote,.quoteblock.abstract p,.quoteblock.excerpt blockquote,.quoteblock.excerpt p,.quoteblock .quoteblock blockquote,.quoteblock .quoteblock p{line-height:
1.6;word-spacing:
0}
254 .quoteblock.abstract{margin:
0 1em
1.25em;display:block}
255 .quoteblock.abstract
>.title{margin:
0 0 .375em;font-size:
1.15em;text-align:center}
256 .quoteblock.excerpt
>blockquote,.quoteblock .quoteblock{padding:
0 0 .25em
1em;border-left:
.25em solid #dddddf}
257 .quoteblock.excerpt,.quoteblock .quoteblock{margin-left:
0}
258 .quoteblock.excerpt blockquote,.quoteblock.excerpt p,.quoteblock .quoteblock blockquote,.quoteblock .quoteblock p{color:inherit;font-size:
1.0625rem}
259 .quoteblock.excerpt .attribution,.quoteblock .quoteblock .attribution{color:inherit;font-size:
.85rem;text-align:left;margin-right:
0}
260 p.tableblock:last-child{margin-bottom:
0}
261 td.tableblock
>.content{margin-bottom:
1.25em;word-wrap:anywhere}
262 td.tableblock
>.content
>:last-child{margin-bottom:-
1.25em}
263 table.tableblock,th.tableblock,td.tableblock{border:
0 solid #dedede}
264 table.grid-all
>*
>tr
>*{border-width:
1px}
265 table.grid-cols
>*
>tr
>*{border-width:
0 1px}
266 table.grid-rows
>*
>tr
>*{border-width:
1px
0}
267 table.frame-all{border-width:
1px}
268 table.frame-ends{border-width:
1px
0}
269 table.frame-sides{border-width:
0 1px}
270 table.frame-none
>colgroup+*
>:first-child
>*,table.frame-sides
>colgroup+*
>:first-child
>*{border-top-width:
0}
271 table.frame-none
>:last-child
>:last-child
>*,table.frame-sides
>:last-child
>:last-child
>*{border-bottom-width:
0}
272 table.frame-none
>*
>tr
>:first-child,table.frame-ends
>*
>tr
>:first-child{border-left-width:
0}
273 table.frame-none
>*
>tr
>:last-child,table.frame-ends
>*
>tr
>:last-child{border-right-width:
0}
274 table.stripes-all
>*
>tr,table.stripes-odd
>*
>tr:nth-of-type(odd),table.stripes-even
>*
>tr:nth-of-type(even),table.stripes-hover
>*
>tr:hover{background:#f8f8f7}
275 th.halign-left,td.halign-left{text-align:left}
276 th.halign-right,td.halign-right{text-align:right}
277 th.halign-center,td.halign-center{text-align:center}
278 th.valign-top,td.valign-top{vertical-align:top}
279 th.valign-bottom,td.valign-bottom{vertical-align:bottom}
280 th.valign-middle,td.valign-middle{vertical-align:middle}
281 table thead th,table tfoot th{font-weight:bold}
282 tbody tr th{background:#f7f8f7}
283 tbody tr th,tbody tr th p,tfoot tr th,tfoot tr th p{color:rgba(
0,
0,
0,
.8);font-weight:bold}
284 p.tableblock
>code:only-child{background:none;padding:
0}
285 p.tableblock{font-size:
1em}
286 ol{margin-left:
1.75em}
287 ul li ol{margin-left:
1.5em}
288 dl dd{margin-left:
1.125em}
289 dl dd:last-child,dl dd:last-child
>:last-child{margin-bottom:
0}
290 li p,ul dd,ol dd,.olist .olist,.ulist .ulist,.ulist .olist,.olist .ulist{margin-bottom:
.625em}
291 ul.checklist,ul.none,ol.none,ul.no-bullet,ol.no-bullet,ol.unnumbered,ul.unstyled,ol.unstyled{list-style-type:none}
292 ul.no-bullet,ol.no-bullet,ol.unnumbered{margin-left:
.625em}
293 ul.unstyled,ol.unstyled{margin-left:
0}
294 li
>p:empty:only-child::before{content:
"";display:inline-block}
295 ul.checklist
>li
>p:first-child{margin-left:-
1em}
296 ul.checklist
>li
>p:first-child
>.fa-square-o:first-child,ul.checklist
>li
>p:first-child
>.fa-check-square-o:first-child{width:
1.25em;font-size:
.8em;position:relative;bottom:
.125em}
297 ul.checklist
>li
>p:first-child
>input[type=checkbox]:first-child{margin-right:
.25em}
298 ul.inline{display:flex;flex-flow:row wrap;list-style:none;margin:
0 0 .625em -
1.25em}
299 ul.inline
>li{margin-left:
1.25em}
300 .unstyled dl dt{font-weight:
400;font-style:normal}
301 ol.arabic{list-style-type:decimal}
302 ol.decimal{list-style-type:decimal-leading-zero}
303 ol.loweralpha{list-style-type:lower-alpha}
304 ol.upperalpha{list-style-type:upper-alpha}
305 ol.lowerroman{list-style-type:lower-roman}
306 ol.upperroman{list-style-type:upper-roman}
307 ol.lowergreek{list-style-type:lower-greek}
308 .hdlist
>table,.colist
>table{border:
0;background:none}
309 .hdlist
>table
>tbody
>tr,.colist
>table
>tbody
>tr{background:none}
310 td.hdlist1,td.hdlist2{vertical-align:top;padding:
0 .625em}
311 td.hdlist1{font-weight:bold;padding-bottom:
1.25em}
312 td.hdlist2{word-wrap:anywhere}
313 .literalblock+.colist,.listingblock+.colist{margin-top:-
.5em}
314 .colist td:not([class]):first-child{padding:
.4em
.75em
0;line-height:
1;vertical-align:top}
315 .colist td:not([class]):first-child img{max-width:none}
316 .colist td:not([class]):last-child{padding:
.25em
0}
317 .thumb,.th{line-height:
0;display:inline-block;border:
4px solid #fff;box-shadow:
0 0 0 1px #ddd}
318 .imageblock.left{margin:
.25em
.625em
1.25em
0}
319 .imageblock.right{margin:
.25em
0 1.25em
.625em}
320 .imageblock
>.title{margin-bottom:
0}
321 .imageblock.thumb,.imageblock.th{border-width:
6px}
322 .imageblock.thumb
>.title,.imageblock.th
>.title{padding:
0 .125em}
323 .image.left,.image.right{margin-top:
.25em;margin-bottom:
.25em;display:inline-block;line-height:
0}
324 .image.left{margin-right:
.625em}
325 .image.right{margin-left:
.625em}
326 a.image{text-decoration:none;display:inline-block}
327 a.image object{pointer-events:none}
328 sup.footnote,sup.footnoteref{font-size:
.875em;position:static;vertical-align:super}
329 sup.footnote a,sup.footnoteref a{text-decoration:none}
330 sup.footnote a:active,sup.footnoteref a:active{text-decoration:underline}
331 #footnotes{padding-top:
.75em;padding-bottom:
.75em;margin-bottom:
.625em}
332 #footnotes hr{width:
20%;min-width:
6.25em;margin:-
.25em
0 .75em;border-width:
1px
0 0}
333 #footnotes .footnote{padding:
0 .375em
0 .225em;line-height:
1.3334;font-size:
.875em;margin-left:
1.2em;margin-bottom:
.2em}
334 #footnotes .footnote a:first-of-type{font-weight:bold;text-decoration:none;margin-left:-
1.05em}
335 #footnotes .footnote:last-of-type{margin-bottom:
0}
336 #content #footnotes{margin-top:-
.625em;margin-bottom:
0;padding:
.75em
0}
337 div.unbreakable{page-break-inside:avoid}
338 .big{font-size:larger}
339 .small{font-size:smaller}
340 .underline{text-decoration:underline}
341 .overline{text-decoration:overline}
342 .line-through{text-decoration:line-through}
344 .aqua-background{background:#
00fafa}
346 .black-background{background:#
000}
348 .blue-background{background:#
0000fa}
349 .fuchsia{color:#bf00bf}
350 .fuchsia-background{background:#fa00fa}
352 .gray-background{background:#
7d7d7d}
353 .green{color:#
006000}
354 .green-background{background:#
007d00}
356 .lime-background{background:#
00fa00}
357 .maroon{color:#
600000}
358 .maroon-background{background:#
7d0000}
360 .navy-background{background:#
00007d}
361 .olive{color:#
606000}
362 .olive-background{background:#
7d7d00}
363 .purple{color:#
600060}
364 .purple-background{background:#
7d007d}
366 .red-background{background:#fa0000}
367 .silver{color:#
909090}
368 .silver-background{background:#bcbcbc}
370 .teal-background{background:#
007d7d}
371 .white{color:#bfbfbf}
372 .white-background{background:#fafafa}
373 .yellow{color:#bfbf00}
374 .yellow-background{background:#fafa00}
375 span.icon
>.fa{cursor:default}
376 a span.icon
>.fa{cursor:inherit}
377 .admonitionblock td.icon [class^=
"fa icon-"]{font-size:
2.5em;text-shadow:
1px
1px
2px rgba(
0,
0,
0,
.5);cursor:default}
378 .admonitionblock td.icon .icon-note::before{content:
"\f05a";color:#
19407c}
379 .admonitionblock td.icon .icon-tip::before{content:
"\f0eb";text-shadow:
1px
1px
2px rgba(
155,
155,
0,
.8);color:#
111}
380 .admonitionblock td.icon .icon-warning::before{content:
"\f071";color:#bf6900}
381 .admonitionblock td.icon .icon-caution::before{content:
"\f06d";color:#bf3400}
382 .admonitionblock td.icon .icon-important::before{content:
"\f06a";color:#bf0000}
383 .conum[data-value]{display:inline-block;color:#fff!important;background:rgba(
0,
0,
0,
.8);border-radius:
50%;text-align:center;font-size:
.75em;width:
1.67em;height:
1.67em;line-height:
1.67em;font-family:
"Open Sans",
"DejaVu Sans",sans-serif;font-style:normal;font-weight:bold}
384 .conum[data-value] *{color:#fff!important}
385 .conum[data-value]+b{display:none}
386 .conum[data-value]::after{content:attr(data-value)}
387 pre .conum[data-value]{position:relative;top:-
.125em}
388 b.conum *{color:inherit!important}
389 .conum:not([data-value]):empty{display:none}
390 dt,th.tableblock,td.content,div.footnote{text-rendering:optimizeLegibility}
391 h1,h2,p,td.content,span.alt,summary{letter-spacing:-
.01em}
392 p strong,td.content strong,div.footnote strong{letter-spacing:-
.005em}
393 p,blockquote,dt,td.content,td.hdlist1,span.alt,summary{font-size:
1.0625rem}
394 p{margin-bottom:
1.25rem}
395 .sidebarblock p,.sidebarblock dt,.sidebarblock td.content,p.tableblock{font-size:
1em}
396 .exampleblock
>.content{background:#fffef7;border-color:#e0e0dc;box-shadow:
0 1px
4px #e0e0dc}
397 .print-only{display:none!important}
398 @page{margin:
1.25cm
.75cm}
399 @media print{*{box-shadow:none!important;text-shadow:none!important}
401 a{color:inherit!important;text-decoration:underline!important}
402 a.bare,a[href^=
"#"],a[href^=
"mailto:"]{text-decoration:none!important}
403 a[href^=
"http:"]:not(.bare)::after,a[href^=
"https:"]:not(.bare)::after{content:
"(" attr(href)
")";display:inline-block;font-size:
.875em;padding-left:
.25em}
404 abbr[title]{border-bottom:
1px dotted}
405 abbr[title]::after{content:
" (" attr(title)
")"}
406 pre,blockquote,tr,img,object,svg{page-break-inside:avoid}
407 thead{display:table-header-group}
409 p,blockquote,dt,td.content{font-size:
1em;orphans:
3;widows:
3}
410 h2,h3,#toctitle,.sidebarblock
>.content
>.title{page-break-after:avoid}
411 #header,#content,#footnotes,#footer{max-width:none}
412 #toc,.sidebarblock,.exampleblock
>.content{background:none!important}
413 #toc{border-bottom:
1px solid #dddddf!important;padding-bottom:
0!important}
414 body.book #header{text-align:center}
415 body.book #header
>h1:first-child{border:
0!important;margin:
2.5em
0 1em}
416 body.book #header .details{border:
0!important;display:block;padding:
0!important}
417 body.book #header .details span:first-child{margin-left:
0!important}
418 body.book #header .details br{display:block}
419 body.book #header .details br+span::before{content:none!important}
420 body.book #toc{border:
0!important;text-align:left!important;padding:
0!important;margin:
0!important}
421 body.book #toc,body.book #preamble,body.book h1.sect0,body.book .sect1
>h2{page-break-before:always}
422 .listingblock code[data-lang]::before{display:block}
423 #footer{padding:
0 .9375em}
424 .hide-on-print{display:none!important}
425 .print-only{display:block!important}
426 .hide-for-print{display:none!important}
427 .show-for-print{display:inherit!important}}
428 @media amzn-kf8,print{#header
>h1:first-child{margin-top:
1.25rem}
429 .sect1{padding:
0!important}
430 .sect1+.sect1{border:
0}
431 #footer{background:none}
432 #footer-text{color:rgba(
0,
0,
0,
.6);font-size:
.9em}}
433 @media amzn-kf8{#header,#content,#footnotes,#footer{padding:
0}}
436 <body class=
"article">
439 <div class=
"details">
440 <span id=
"revdate">2024-
08-
23</span>
445 <div class=
"sectionbody">
446 <div class=
"paragraph">
447 <p>Git bundles are files that store a pack-file along with some extra metadata,
448 including a set of refs and a (possibly empty) set of necessary commits. See
449 <a href=
"../git-bundle.html">git-bundle(
1)
</a> and
<a href=
"../gitformat-bundle.html">gitformat-bundle(
5)
</a> for more information.
</p>
451 <div class=
"paragraph">
452 <p>Bundle URIs are locations where Git can download one or more bundles in
453 order to bootstrap the object database in advance of fetching the remaining
454 objects from a remote.
</p>
456 <div class=
"paragraph">
457 <p>One goal is to speed up clones and fetches for users with poor network
458 connectivity to the origin server. Another benefit is to allow heavy users,
459 such as CI build farms, to use local resources for the majority of Git data
460 and thereby reducing the load on the origin server.
</p>
462 <div class=
"paragraph">
463 <p>To enable the bundle URI feature, users can specify a bundle URI using
464 command-line options or the origin server can advertise one or more URIs
465 via a protocol v2 capability.
</p>
470 <h2 id=
"_design_goals">Design Goals
</h2>
471 <div class=
"sectionbody">
472 <div class=
"paragraph">
473 <p>The bundle URI standard aims to be flexible enough to satisfy multiple
474 workloads. The bundle provider and the Git client have several choices in
475 how they create and consume bundle URIs.
</p>
480 <p>Bundles can have whatever name the server desires. This name could refer
481 to immutable data by using a hash of the bundle contents. However, this
482 means that a new URI will be needed after every update of the content.
483 This might be acceptable if the server is advertising the URI (and the
484 server is aware of new bundles being generated) but would not be
485 ergonomic for users using the command line option.
</p>
488 <p>The bundles could be organized specifically for bootstrapping full
489 clones, but could also be organized with the intention of bootstrapping
490 incremental fetches. The bundle provider must decide on one of several
491 organization schemes to minimize client downloads during incremental
492 fetches, but the Git client can also choose whether to use bundles for
493 either of these operations.
</p>
496 <p>The bundle provider can choose to support full clones, partial clones,
497 or both. The client can detect which bundles are appropriate for the
498 repository
’s partial clone filter, if any.
</p>
501 <p>The bundle provider can use a single bundle (for clones only), or a
502 list of bundles. When using a list of bundles, the provider can specify
503 whether or not the client needs
<em>all
</em> of the bundle URIs for a full
504 clone, or if
<em>any
</em> one of the bundle URIs is sufficient. This allows the
505 bundle provider to use different URIs for different geographies.
</p>
508 <p>The bundle provider can organize the bundles using heuristics, such as
509 creation tokens, to help the client prevent downloading bundles it does
510 not need. When the bundle provider does not provide these heuristics,
511 the client can use optimizations to minimize how much of the data is
515 <p>The bundle provider does not need to be associated with the Git server.
516 The client can choose to use the bundle provider without it being
517 advertised by the Git server.
</p>
520 <p>The client can choose to discover bundle providers that are advertised
521 by the Git server. This could happen during
<code>git clone
</code>, during
522 <code>git fetch
</code>, both, or neither. The user can choose which combination
523 works best for them.
</p>
526 <p>The client can choose to configure a bundle provider manually at any
527 time. The client can also choose to specify a bundle provider manually
528 as a command-line option to
<code>git clone
</code>.
</p>
532 <div class=
"paragraph">
533 <p>Each repository is different and every Git server has different needs.
534 Hopefully the bundle URI feature is flexible enough to satisfy all needs.
535 If not, then the feature can be extended through its versioning mechanism.
</p>
540 <h2 id=
"_server_requirements">Server requirements
</h2>
541 <div class=
"sectionbody">
542 <div class=
"paragraph">
543 <p>To provide a server-side implementation of bundle servers, no other parts
544 of the Git protocol are required. This allows server maintainers to use
545 static content solutions such as CDNs in order to serve the bundle files.
</p>
547 <div class=
"paragraph">
548 <p>At the current scope of the bundle URI feature, all URIs are expected to
549 be HTTP(S) URLs where content is downloaded to a local file using a
<code>GET
</code>
550 request to that URL. The server could include authentication requirements
551 to those requests with the aim of triggering the configured credential
552 helper for secure access. (Future extensions could use
"file://" URIs or
555 <div class=
"paragraph">
556 <p>Assuming a
<code>200 OK
</code> response from the server, the content at the URL is
557 inspected. First, Git attempts to parse the file as a bundle file of
558 version
2 or higher. If the file is not a bundle, then the file is parsed
559 as a plain-text file using Git
’s config parser. The key-value pairs in
560 that config file are expected to describe a list of bundle URIs. If
561 neither of these parse attempts succeed, then Git will report an error to
562 the user that the bundle URI provided erroneous data.
</p>
564 <div class=
"paragraph">
565 <p>Any other data provided by the server is considered erroneous.
</p>
570 <h2 id=
"_bundle_lists">Bundle Lists
</h2>
571 <div class=
"sectionbody">
572 <div class=
"paragraph">
573 <p>The Git server can advertise bundle URIs using a set of
<code>key=value
</code> pairs.
574 A bundle URI can also serve a plain-text file in the Git config format
575 containing these same
<code>key=value
</code> pairs. In both cases, we consider this
576 to be a
<em>bundle list
</em>. The pairs specify information about the bundles
577 that the client can use to make decisions for which bundles to download
578 and which to ignore.
</p>
580 <div class=
"paragraph">
581 <p>A few keys focus on properties of the list itself.
</p>
585 <dt class=
"hdlist1">bundle.version
</dt>
587 <p>(Required) This value provides a version number for the bundle
588 list. If a future Git change enables a feature that needs the Git
589 client to react to a new key in the bundle list file, then this version
590 will increment. The only current version number is
1, and if any other
591 value is specified then Git will fail to use this file.
</p>
593 <dt class=
"hdlist1">bundle.mode
</dt>
595 <p>(Required) This value has one of two values:
<code>all
</code> and
<code>any
</code>. When
<code>all
</code>
596 is specified, then the client should expect to need all of the listed
597 bundle URIs that match their repository
’s requirements. When
<code>any
</code> is
598 specified, then the client should expect that any one of the bundle URIs
599 that match their repository
’s requirements will suffice. Typically, the
600 <code>any
</code> option is used to list a number of different bundle servers
601 located in different geographies.
</p>
603 <dt class=
"hdlist1">bundle.heuristic
</dt>
605 <p>If this string-valued key exists, then the bundle list is designed to
606 work well with incremental
<code>git fetch
</code> commands. The heuristic signals
607 that there are additional keys available for each bundle that help
608 determine which subset of bundles the client should download. The only
609 heuristic currently planned is
<code>creationToken
</code>.
</p>
613 <div class=
"paragraph">
614 <p>The remaining keys include an
<code><id
></code> segment which is a server-designated
615 name for each available bundle. The
<code><id
></code> must contain only alphanumeric
616 and
<code>-
</code> characters.
</p>
620 <dt class=
"hdlist1">bundle.
<id
>.uri
</dt>
622 <p>(Required) This string value is the URI for downloading bundle
<code><id
></code>.
623 If the URI begins with a protocol (
<code>http://
</code> or
<code>https://
</code>) then the URI
624 is absolute. Otherwise, the URI is interpreted as relative to the URI
625 used for the bundle list. If the URI begins with
<code>/
</code>, then that relative
626 path is relative to the domain name used for the bundle list. (This use
627 of relative paths is intended to make it easier to distribute a set of
628 bundles across a large number of servers or CDNs with different domain
631 <dt class=
"hdlist1">bundle.
<id
>.filter
</dt>
633 <p>This string value represents an object filter that should also appear in
634 the header of this bundle. The server uses this value to differentiate
635 different kinds of bundles from which the client can choose those that
636 match their object filters.
</p>
638 <dt class=
"hdlist1">bundle.
<id
>.creationToken
</dt>
640 <p>This value is a nonnegative
64-bit integer used for sorting the bundles
641 list. This is used to download a subset of bundles during a fetch when
642 <code>bundle.heuristic=creationToken
</code>.
</p>
644 <dt class=
"hdlist1">bundle.
<id
>.location
</dt>
646 <p>This string value advertises a real-world location from where the bundle
647 URI is served. This can be used to present the user with an option for
648 which bundle URI to use or simply as an informative indicator of which
649 bundle URI was selected by Git. This is only valuable when
650 <code>bundle.mode
</code> is
<code>any
</code>.
</p>
654 <div class=
"paragraph">
655 <p>Here is an example bundle list using the Git config format:
</p>
657 <div class=
"literalblock">
658 <div class=
"content">
662 heuristic = creationToken
</pre>
665 <div class=
"literalblock">
666 <div class=
"content">
667 <pre>[bundle
"2022-02-09-1644442601-daily"]
668 uri = https://bundles.example.com/git/git/
2022-
02-
09-
1644442601-daily.bundle
669 creationToken =
1644442601</pre>
672 <div class=
"literalblock">
673 <div class=
"content">
674 <pre>[bundle
"2022-02-02-1643842562"]
675 uri = https://bundles.example.com/git/git/
2022-
02-
02-
1643842562.bundle
676 creationToken =
1643842562</pre>
679 <div class=
"literalblock">
680 <div class=
"content">
681 <pre>[bundle
"2022-02-09-1644442631-daily-blobless"]
682 uri =
2022-
02-
09-
1644442631-daily-blobless.bundle
683 creationToken =
1644442631
684 filter = blob:none
</pre>
687 <div class=
"literalblock">
688 <div class=
"content">
689 <pre>[bundle
"2022-02-02-1643842568-blobless"]
690 uri = /git/git/
2022-
02-
02-
1643842568-blobless.bundle
691 creationToken =
1643842568
692 filter = blob:none
</pre>
695 <div class=
"paragraph">
696 <p>This example uses
<code>bundle.mode=all
</code> as well as the
697 <code>bundle.
<id
>.creationToken
</code> heuristic. It also uses the
<code>bundle.
<id
>.filter
</code>
698 options to present two parallel sets of bundles: one for full clones and
699 another for blobless partial clones.
</p>
701 <div class=
"paragraph">
702 <p>Suppose that this bundle list was found at the URI
703 <code>https://bundles.example.com/git/git/
</code> and so the two blobless bundles have
704 the following fully-expanded URIs:
</p>
709 <p><code>https://bundles.example.com/git/git/
2022-
02-
09-
1644442631-daily-blobless.bundle
</code></p>
712 <p><code>https://bundles.example.com/git/git/
2022-
02-
02-
1643842568-blobless.bundle
</code></p>
719 <h2 id=
"_advertising_bundle_uris">Advertising Bundle URIs
</h2>
720 <div class=
"sectionbody">
721 <div class=
"paragraph">
722 <p>If a user knows a bundle URI for the repository they are cloning, then
723 they can specify that URI manually through a command-line option. However,
724 a Git host may want to advertise bundle URIs during the clone operation,
725 helping users unaware of the feature.
</p>
727 <div class=
"paragraph">
728 <p>The only thing required for this feature is that the server can advertise
729 one or more bundle URIs. This advertisement takes the form of a new
730 protocol v2 capability specifically for discovering bundle URIs.
</p>
732 <div class=
"paragraph">
733 <p>The client could choose an arbitrary bundle URI as an option
<em>or
</em> select
734 the URI with best performance by some exploratory checks. It is up to the
735 bundle provider to decide if having multiple URIs is preferable to a
736 single URI that is geodistributed through server-side infrastructure.
</p>
741 <h2 id=
"_cloning_with_bundle_uris">Cloning with Bundle URIs
</h2>
742 <div class=
"sectionbody">
743 <div class=
"paragraph">
744 <p>The primary need for bundle URIs is to speed up clones. The Git client
745 will interact with bundle URIs according to the following flow:
</p>
747 <div class=
"olist arabic">
750 <p>The user specifies a bundle URI with the
<code>--bundle-uri
</code> command-line
751 option
<em>or
</em> the client discovers a bundle list advertised by the
755 <p>If the downloaded data from a bundle URI is a bundle, then the client
756 inspects the bundle headers to check that the prerequisite commit OIDs
757 are present in the client repository. If some are missing, then the
758 client delays unbundling until other bundles have been unbundled,
759 making those OIDs present. When all required OIDs are present, the
760 client unbundles that data using a refspec. The default refspec is
761 <code>+refs/heads/*:refs/bundles/*
</code>, but this can be configured. These refs
762 are stored so that later
<code>git fetch
</code> negotiations can communicate each
763 bundled ref as a
<code>have
</code>, reducing the size of the fetch over the Git
764 protocol. To allow pruning refs from this ref namespace, Git may
765 introduce a numbered namespace (such as
<code>refs/bundles/
<i
>/*
</code>) such that
766 stale bundle refs can be deleted.
</p>
769 <p>If the file is instead a bundle list, then the client inspects the
770 <code>bundle.mode
</code> to see if the list is of the
<code>all
</code> or
<code>any
</code> form.
</p>
771 <div class=
"olist loweralpha">
772 <ol class=
"loweralpha">
774 <p>If
<code>bundle.mode=all
</code>, then the client considers all bundle
775 URIs. The list is reduced based on the
<code>bundle.
<id
>.filter
</code> options
776 matching the client repository
’s partial clone filter. Then, all
777 bundle URIs are requested. If the
<code>bundle.
<id
>.creationToken
</code>
778 heuristic is provided, then the bundles are downloaded in decreasing
779 order by the creation token, stopping when a bundle has all required
780 OIDs. The bundles can then be unbundled in increasing creation token
781 order. The client stores the latest creation token as a heuristic
782 for avoiding future downloads if the bundle list does not advertise
783 bundles with larger creation tokens.
</p>
786 <p>If
<code>bundle.mode=any
</code>, then the client can choose any one of the
787 bundle URIs to inspect. The client can use a variety of ways to
788 choose among these URIs. The client can also fallback to another URI
789 if the initial choice fails to return a result.
</p>
796 <div class=
"paragraph">
797 <p>Note that during a clone we expect that all bundles will be required, and
798 heuristics such as
<code>bundle.
<uri
>.creationToken
</code> can be used to download
799 bundles in chronological order or in parallel.
</p>
801 <div class=
"paragraph">
802 <p>If a given bundle URI is a bundle list with a
<code>bundle.heuristic
</code>
803 value, then the client can choose to store that URI as its chosen bundle
804 URI. The client can then navigate directly to that URI during later
<code>git
805 fetch
</code> calls.
</p>
807 <div class=
"paragraph">
808 <p>When downloading bundle URIs, the client can choose to inspect the initial
809 content before committing to downloading the entire content. This may
810 provide enough information to determine if the URI is a bundle list or
811 a bundle. In the case of a bundle, the client may inspect the bundle
812 header to determine that all advertised tips are already in the client
813 repository and cancel the remaining download.
</p>
818 <h2 id=
"_fetching_with_bundle_uris">Fetching with Bundle URIs
</h2>
819 <div class=
"sectionbody">
820 <div class=
"paragraph">
821 <p>When the client fetches new data, it can decide to fetch from bundle
822 servers before fetching from the origin remote. This could be done via a
823 command-line option, but it is more likely useful to use a config value
824 such as the one specified during the clone.
</p>
826 <div class=
"paragraph">
827 <p>The fetch operation follows the same procedure to download bundles from a
828 bundle list (although we do
<em>not
</em> want to use parallel downloads here). We
829 expect that the process will end when all prerequisite commit OIDs in a
830 thin bundle are already in the object database.
</p>
832 <div class=
"paragraph">
833 <p>When using the
<code>creationToken
</code> heuristic, the client can avoid downloading
834 any bundles if their creation tokens are not larger than the stored
835 creation token. After fetching new bundles, Git updates this local
838 <div class=
"paragraph">
839 <p>If the bundle provider does not provide a heuristic, then the client
840 should attempt to inspect the bundle headers before downloading the full
841 bundle data in case the bundle tips already exist in the client
847 <h2 id=
"_error_conditions">Error Conditions
</h2>
848 <div class=
"sectionbody">
849 <div class=
"paragraph">
850 <p>If the Git client discovers something unexpected while downloading
851 information according to a bundle URI or the bundle list found at that
852 location, then Git can ignore that data and continue as if it was not
853 given a bundle URI. The remote Git server is the ultimate source of truth,
854 not the bundle URI.
</p>
856 <div class=
"paragraph">
857 <p>Here are a few example error conditions:
</p>
862 <p>The client fails to connect with a server at the given URI or a connection
863 is lost without any chance to recover.
</p>
866 <p>The client receives a
400-level response (such as
<code>404 Not Found
</code> or
867 <code>401 Not Authorized
</code>). The client should use the credential helper to
868 find and provide a credential for the URI, but match the semantics of
869 Git
’s other HTTP protocols in terms of handling specific
400-level
873 <p>The server reports any other failure response.
</p>
876 <p>The client receives data that is not parsable as a bundle or bundle list.
</p>
879 <p>A bundle includes a filter that does not match expectations.
</p>
882 <p>The client cannot unbundle the bundles because the prerequisite commit OIDs
883 are not in the object database and there are no more bundles to download.
</p>
887 <div class=
"paragraph">
888 <p>There are also situations that could be seen as wasteful, but are not
889 error conditions:
</p>
894 <p>The downloaded bundles contain more information than is requested by
895 the clone or fetch request. A primary example is if the user requests
896 a clone with
<code>--single-branch
</code> but downloads bundles that store every
897 reachable commit from all
<code>refs/heads/*
</code> references. This might be
898 initially wasteful, but perhaps these objects will become reachable by
899 a later ref update that the client cares about.
</p>
902 <p>A bundle download during a
<code>git fetch
</code> contains objects already in the
903 object database. This is probably unavoidable if we are using bundles
904 for fetches, since the client will almost always be slightly ahead of
905 the bundle servers after performing its
"catch-up" fetch to the remote
906 server. This extra work is most wasteful when the client is fetching
907 much more frequently than the server is computing bundles, such as if
908 the client is using hourly prefetches with background maintenance, but
909 the server is computing bundles weekly. For this reason, the client
910 should not use bundle URIs for fetch unless the server has explicitly
911 recommended it through a
<code>bundle.heuristic
</code> value.
</p>
918 <h2 id=
"_example_bundle_provider_organization">Example Bundle Provider organization
</h2>
919 <div class=
"sectionbody">
920 <div class=
"paragraph">
921 <p>The bundle URI feature is intentionally designed to be flexible to
922 different ways a bundle provider wants to organize the object data.
923 However, it can be helpful to have a complete organization model described
924 here so providers can start from that base.
</p>
926 <div class=
"paragraph">
927 <p>This example organization is a simplified model of what is used by the
928 GVFS Cache Servers (see section near the end of this document) which have
929 been beneficial in speeding up clones and fetches for very large
930 repositories, although using extra software outside of Git.
</p>
932 <div class=
"paragraph">
933 <p>The bundle provider deploys servers across multiple geographies. Each
934 server manages its own bundle set. The server can track a number of Git
935 repositories, but provides a bundle list for each based on a pattern. For
936 example, when mirroring a repository at
<code>https://
<domain
>/
<org
>/
<repo
></code>
937 the bundle server could have its bundle list available at
938 <code>https://
<server-url
>/
<domain
>/
<org
>/
<repo
></code>. The origin Git server can
939 list all of these servers under the
"any" mode:
</p>
941 <div class=
"literalblock">
942 <div class=
"content">
948 <div class=
"literalblock">
949 <div class=
"content">
950 <pre>[bundle
"eastus"]
951 uri = https://eastus.example.com/
<domain
>/
<org
>/
<repo
></pre>
954 <div class=
"literalblock">
955 <div class=
"content">
956 <pre>[bundle
"europe"]
957 uri = https://europe.example.com/
<domain
>/
<org
>/
<repo
></pre>
960 <div class=
"literalblock">
961 <div class=
"content">
963 uri = https://apac.example.com/
<domain
>/
<org
>/
<repo
></pre>
966 <div class=
"paragraph">
967 <p>This
"list of lists" is static and only changes if a bundle server is
968 added or removed.
</p>
970 <div class=
"paragraph">
971 <p>Each bundle server manages its own set of bundles. The initial bundle list
972 contains only a single bundle, containing all of the objects received from
973 cloning the repository from the origin server. The list uses the
974 <code>creationToken
</code> heuristic and a
<code>creationToken
</code> is made for the bundle
975 based on the server
’s timestamp.
</p>
977 <div class=
"paragraph">
978 <p>The bundle server runs regularly-scheduled updates for the bundle list,
979 such as once a day. During this task, the server fetches the latest
980 contents from the origin server and generates a bundle containing the
981 objects reachable from the latest origin refs, but not contained in a
982 previously-computed bundle. This bundle is added to the list, with care
983 that the
<code>creationToken
</code> is strictly greater than the previous maximum
984 <code>creationToken
</code>.
</p>
986 <div class=
"paragraph">
987 <p>When the bundle list grows too large, say more than
30 bundles, then the
988 oldest
"<em>N</em> minus 30" bundles are combined into a single bundle. This
989 bundle
’s
<code>creationToken
</code> is equal to the maximum
<code>creationToken
</code> among the
992 <div class=
"paragraph">
993 <p>An example bundle list is provided here, although it only has two daily
994 bundles and not a full list of
30:
</p>
996 <div class=
"literalblock">
997 <div class=
"content">
1001 heuristic = creationToken
</pre>
1004 <div class=
"literalblock">
1005 <div class=
"content">
1006 <pre>[bundle
"2022-02-13-1644770820-daily"]
1007 uri = https://eastus.example.com/
<domain
>/
<org
>/
<repo
>/
2022-
02-
09-
1644770820-daily.bundle
1008 creationToken =
1644770820</pre>
1011 <div class=
"literalblock">
1012 <div class=
"content">
1013 <pre>[bundle
"2022-02-09-1644442601-daily"]
1014 uri = https://eastus.example.com/
<domain
>/
<org
>/
<repo
>/
2022-
02-
09-
1644442601-daily.bundle
1015 creationToken =
1644442601</pre>
1018 <div class=
"literalblock">
1019 <div class=
"content">
1020 <pre>[bundle
"2022-02-02-1643842562"]
1021 uri = https://eastus.example.com/
<domain
>/
<org
>/
<repo
>/
2022-
02-
02-
1643842562.bundle
1022 creationToken =
1643842562</pre>
1025 <div class=
"paragraph">
1026 <p>To avoid storing and serving object data in perpetuity despite becoming
1027 unreachable in the origin server, this bundle merge can be more careful.
1028 Instead of taking an absolute union of the old bundles, instead the bundle
1029 can be created by looking at the newer bundles and ensuring that their
1030 necessary commits are all available in this merged bundle (or in another
1031 one of the newer bundles). This allows
"expiring" object data that is not
1032 being used by new commits in this window of time. That data could be
1033 reintroduced by a later push.
</p>
1035 <div class=
"paragraph">
1036 <p>The intention of this data organization has two main goals. First, initial
1037 clones of the repository become faster by downloading precomputed object
1038 data from a closer source. Second,
<code>git fetch
</code> commands can be faster,
1039 especially if the client has not fetched for a few days. However, if a
1040 client does not fetch for
30 days, then the bundle list organization would
1041 cause redownloading a large amount of object data.
</p>
1043 <div class=
"paragraph">
1044 <p>One way to make this organization more useful to users who fetch frequently
1045 is to have more frequent bundle creation. For example, bundles could be
1046 created every hour, and then once a day those
"hourly" bundles could be
1047 merged into a
"daily" bundle. The daily bundles are merged into the
1048 oldest bundle after
30 days.
</p>
1050 <div class=
"paragraph">
1051 <p>It is recommended that this bundle strategy is repeated with the
<code>blob:none
</code>
1052 filter if clients of this repository are expecting to use blobless partial
1053 clones. This list of blobless bundles stays in the same list as the full
1054 bundles, but uses the
<code>bundle.
<id
>.filter
</code> key to separate the two groups.
1055 For very large repositories, the bundle provider may want to
<em>only
</em> provide
1056 blobless bundles.
</p>
1061 <h2 id=
"_implementation_plan">Implementation Plan
</h2>
1062 <div class=
"sectionbody">
1063 <div class=
"paragraph">
1064 <p>This design document is being submitted on its own as an aspirational
1065 document, with the goal of implementing all of the mentioned client
1066 features over the course of several patch series. Here is a potential
1067 outline for submitting these features:
</p>
1069 <div class=
"olist arabic">
1072 <p>Integrate bundle URIs into
<code>git clone
</code> with a
<code>--bundle-uri
</code> option.
1073 This will include a new
<code>git fetch --bundle-uri
</code> mode for use as the
1074 implementation underneath
<code>git clone
</code>. The initial version here will
1075 expect a single bundle at the given URI.
</p>
1078 <p>Implement the ability to parse a bundle list from a bundle URI and
1079 update the
<code>git fetch --bundle-uri
</code> logic to properly distinguish
1080 between
<code>bundle.mode
</code> options. Specifically design the feature so
1081 that the config format parsing feeds a list of key-value pairs into the
1082 bundle list logic.
</p>
1085 <p>Create the
<code>bundle-uri
</code> protocol v2 command so Git servers can advertise
1086 bundle URIs using the key-value pairs. Plug into the existing key-value
1087 input to the bundle list logic. Allow
<code>git clone
</code> to discover these
1088 bundle URIs and bootstrap the client repository from the bundle data.
1089 (This choice is an opt-in via a config option and a command-line
1093 <p>Allow the client to understand the
<code>bundle.heuristic
</code> configuration key
1094 and the
<code>bundle.
<id
>.creationToken
</code> heuristic. When
<code>git clone
</code>
1095 discovers a bundle URI with
<code>bundle.heuristic
</code>, it configures the client
1096 repository to check that bundle URI during later
<code>git fetch
<remote
></code>
1100 <p>Allow clients to discover bundle URIs during
<code>git fetch
</code> and configure
1101 a bundle URI for later fetches if
<code>bundle.heuristic
</code> is set.
</p>
1104 <p>Implement the
"inspect headers" heuristic to reduce data downloads when
1105 the
<code>bundle.
<id
>.creationToken
</code> heuristic is not available.
</p>
1109 <div class=
"paragraph">
1110 <p>As these features are reviewed, this plan might be updated. We also expect
1111 that new designs will be discovered and implemented as this feature
1112 matures and becomes used in real-world scenarios.
</p>
1117 <h2 id=
"_related_work_packfile_uris">Related Work: Packfile URIs
</h2>
1118 <div class=
"sectionbody">
1119 <div class=
"paragraph">
1120 <p>The Git protocol already has a capability where the Git server can list
1121 a set of URLs along with the packfile response when serving a client
1122 request. The client is then expected to download the packfiles at those
1123 locations in order to have a complete understanding of the response.
</p>
1125 <div class=
"paragraph">
1126 <p>This mechanism is used by the Gerrit server (implemented with JGit) and
1127 has been effective at reducing CPU load and improving user performance for
1130 <div class=
"paragraph">
1131 <p>A major downside to this mechanism is that the origin server needs to know
1132 <em>exactly
</em> what is in those packfiles, and the packfiles need to be available
1133 to the user for some time after the server has responded. This coupling
1134 between the origin and the packfile data is difficult to manage.
</p>
1136 <div class=
"paragraph">
1137 <p>Further, this implementation is extremely hard to make work with fetches.
</p>
1142 <h2 id=
"_related_work_gvfs_cache_servers">Related Work: GVFS Cache Servers
</h2>
1143 <div class=
"sectionbody">
1144 <div class=
"paragraph">
1145 <p>The GVFS Protocol [
2] is a set of HTTP endpoints designed independently of
1146 the Git project before Git
’s partial clone was created. One feature of this
1147 protocol is the idea of a
"cache server" which can be colocated with build
1148 machines or developer offices to transfer Git data without overloading the
1151 <div class=
"paragraph">
1152 <p>The endpoint that VFS for Git is famous for is the
<code>GET /gvfs/objects/{oid}
</code>
1153 endpoint, which allows downloading an object on-demand. This is a critical
1154 piece of the filesystem virtualization of that product.
</p>
1156 <div class=
"paragraph">
1157 <p>However, a more subtle need is the
<code>GET /gvfs/prefetch?lastPackTimestamp=
<t
></code>
1158 endpoint. Given an optional timestamp, the cache server responds with a list
1159 of precomputed packfiles containing the commits and trees that were introduced
1160 in those time intervals.
</p>
1162 <div class=
"paragraph">
1163 <p>The cache server computes these
"prefetch" packfiles using the following
1166 <div class=
"olist arabic">
1169 <p>Every hour, an
"hourly" pack is generated with a given timestamp.
</p>
1172 <p>Nightly, the previous
24 hourly packs are rolled up into a
"daily" pack.
</p>
1175 <p>Nightly, all prefetch packs more than
30 days old are rolled up into
1180 <div class=
"paragraph">
1181 <p>When a user runs
<code>gvfs clone
</code> or
<code>scalar clone
</code> against a repo with cache
1182 servers, the client requests all prefetch packfiles, which is at most
1183 <code>24 +
30 +
1</code> packfiles downloading only commits and trees. The client
1184 then follows with a request to the origin server for the references, and
1185 attempts to checkout that tip reference. (There is an extra endpoint that
1186 helps get all reachable trees from a given commit, in case that commit
1187 was not already in a prefetch packfile.)
</p>
1189 <div class=
"paragraph">
1190 <p>During a
<code>git fetch
</code>, a hook requests the prefetch endpoint using the
1191 most-recent timestamp from a previously-downloaded prefetch packfile.
1192 Only the list of packfiles with later timestamps are downloaded. Most
1193 users fetch hourly, so they get at most one hourly prefetch pack. Users
1194 whose machines have been off or otherwise have not fetched in over
30 days
1195 might redownload all prefetch packfiles. This is rare.
</p>
1197 <div class=
"paragraph">
1198 <p>It is important to note that the clients always contact the origin server
1199 for the refs advertisement, so the refs are frequently
"ahead" of the
1200 prefetched pack data. The missing objects are downloaded on-demand using
1201 the
<code>GET gvfs/objects/{oid}
</code> requests, when needed by a command such as
1202 <code>git checkout
</code> or
<code>git log
</code>. Some Git optimizations disable checks that
1203 would cause these on-demand downloads to be too aggressive.
</p>
1208 <h2 id=
"_see_also">See Also
</h2>
1209 <div class=
"sectionbody">
1210 <div class=
"paragraph">
1211 <p>[
1]
<a href=
"https://lore.kernel.org/git/RFC-cover-00.13-0000000000-20210805T150534Z-avarab@gmail.com/" class=
"bare">https://lore.kernel.org/git/RFC-cover-
00.13-
0000000000-
20210805T150534Z-avarab@gmail.com/
</a>
1212 An earlier RFC for a bundle URI feature.
</p>
1214 <div class=
"paragraph">
1215 <p>[
2]
<a href=
"https://github.com/microsoft/VFSForGit/blob/master/Protocol.md" class=
"bare">https://github.com/microsoft/VFSForGit/blob/master/Protocol.md
</a>
1216 The GVFS Protocol
</p>
1222 <div id=
"footer-text">
1223 Last updated
2023-
02-
22 15:
29:
29 -
0800