Autogenerated HTML docs for v2.46.0-469-g4590f
[git-htmldocs.git] / git-maintenance.html
blob1544a784d6257ba144b749d89109bea35b6fc96b
1 <!DOCTYPE html>
2 <html xmlns="http://www.w3.org/1999/xhtml" lang="en">
3 <head>
4 <meta charset="UTF-8"/>
5 <meta http-equiv="X-UA-Compatible" content="IE=edge"/>
6 <meta name="viewport" content="width=device-width, initial-scale=1.0"/>
7 <meta name="generator" content="Asciidoctor 2.0.20"/>
8 <title>git-maintenance(1)</title>
9 <link rel="stylesheet" href="https://fonts.googleapis.com/css?family=Open+Sans:300,300italic,400,400italic,600,600italic%7CNoto+Serif:400,400italic,700,700italic%7CDroid+Sans+Mono:400,700"/>
10 <style>
11 /*! Asciidoctor default stylesheet | MIT License | https://asciidoctor.org */
12 /* Uncomment the following line when using as a custom stylesheet */
13 /* @import "https://fonts.googleapis.com/css?family=Open+Sans:300,300italic,400,400italic,600,600italic%7CNoto+Serif:400,400italic,700,700italic%7CDroid+Sans+Mono:400,700"; */
14 html{font-family:sans-serif;-webkit-text-size-adjust:100%}
15 a{background:none}
16 a:focus{outline:thin dotted}
17 a:active,a:hover{outline:0}
18 h1{font-size:2em;margin:.67em 0}
19 b,strong{font-weight:bold}
20 abbr{font-size:.9em}
21 abbr[title]{cursor:help;border-bottom:1px dotted #dddddf;text-decoration:none}
22 dfn{font-style:italic}
23 hr{height:0}
24 mark{background:#ff0;color:#000}
25 code,kbd,pre,samp{font-family:monospace;font-size:1em}
26 pre{white-space:pre-wrap}
27 q{quotes:"\201C" "\201D" "\2018" "\2019"}
28 small{font-size:80%}
29 sub,sup{font-size:75%;line-height:0;position:relative;vertical-align:baseline}
30 sup{top:-.5em}
31 sub{bottom:-.25em}
32 img{border:0}
33 svg:not(:root){overflow:hidden}
34 figure{margin:0}
35 audio,video{display:inline-block}
36 audio:not([controls]){display:none;height:0}
37 fieldset{border:1px solid silver;margin:0 2px;padding:.35em .625em .75em}
38 legend{border:0;padding:0}
39 button,input,select,textarea{font-family:inherit;font-size:100%;margin:0}
40 button,input{line-height:normal}
41 button,select{text-transform:none}
42 button,html input[type=button],input[type=reset],input[type=submit]{-webkit-appearance:button;cursor:pointer}
43 button[disabled],html input[disabled]{cursor:default}
44 input[type=checkbox],input[type=radio]{padding:0}
45 button::-moz-focus-inner,input::-moz-focus-inner{border:0;padding:0}
46 textarea{overflow:auto;vertical-align:top}
47 table{border-collapse:collapse;border-spacing:0}
48 *,::before,::after{box-sizing:border-box}
49 html,body{font-size:100%}
50 body{background:#fff;color:rgba(0,0,0,.8);padding:0;margin:0;font-family:"Noto Serif","DejaVu Serif",serif;line-height:1;position:relative;cursor:auto;-moz-tab-size:4;-o-tab-size:4;tab-size:4;word-wrap:anywhere;-moz-osx-font-smoothing:grayscale;-webkit-font-smoothing:antialiased}
51 a:hover{cursor:pointer}
52 img,object,embed{max-width:100%;height:auto}
53 object,embed{height:100%}
54 img{-ms-interpolation-mode:bicubic}
55 .left{float:left!important}
56 .right{float:right!important}
57 .text-left{text-align:left!important}
58 .text-right{text-align:right!important}
59 .text-center{text-align:center!important}
60 .text-justify{text-align:justify!important}
61 .hide{display:none}
62 img,object,svg{display:inline-block;vertical-align:middle}
63 textarea{height:auto;min-height:50px}
64 select{width:100%}
65 .subheader,.admonitionblock td.content>.title,.audioblock>.title,.exampleblock>.title,.imageblock>.title,.listingblock>.title,.literalblock>.title,.stemblock>.title,.openblock>.title,.paragraph>.title,.quoteblock>.title,table.tableblock>.title,.verseblock>.title,.videoblock>.title,.dlist>.title,.olist>.title,.ulist>.title,.qlist>.title,.hdlist>.title{line-height:1.45;color:#7a2518;font-weight:400;margin-top:0;margin-bottom:.25em}
66 div,dl,dt,dd,ul,ol,li,h1,h2,h3,#toctitle,.sidebarblock>.content>.title,h4,h5,h6,pre,form,p,blockquote,th,td{margin:0;padding:0}
67 a{color:#2156a5;text-decoration:underline;line-height:inherit}
68 a:hover,a:focus{color:#1d4b8f}
69 a img{border:0}
70 p{line-height:1.6;margin-bottom:1.25em;text-rendering:optimizeLegibility}
71 p aside{font-size:.875em;line-height:1.35;font-style:italic}
72 h1,h2,h3,#toctitle,.sidebarblock>.content>.title,h4,h5,h6{font-family:"Open Sans","DejaVu Sans",sans-serif;font-weight:300;font-style:normal;color:#ba3925;text-rendering:optimizeLegibility;margin-top:1em;margin-bottom:.5em;line-height:1.0125em}
73 h1 small,h2 small,h3 small,#toctitle small,.sidebarblock>.content>.title small,h4 small,h5 small,h6 small{font-size:60%;color:#e99b8f;line-height:0}
74 h1{font-size:2.125em}
75 h2{font-size:1.6875em}
76 h3,#toctitle,.sidebarblock>.content>.title{font-size:1.375em}
77 h4,h5{font-size:1.125em}
78 h6{font-size:1em}
79 hr{border:solid #dddddf;border-width:1px 0 0;clear:both;margin:1.25em 0 1.1875em}
80 em,i{font-style:italic;line-height:inherit}
81 strong,b{font-weight:bold;line-height:inherit}
82 small{font-size:60%;line-height:inherit}
83 code{font-family:"Droid Sans Mono","DejaVu Sans Mono",monospace;font-weight:400;color:rgba(0,0,0,.9)}
84 ul,ol,dl{line-height:1.6;margin-bottom:1.25em;list-style-position:outside;font-family:inherit}
85 ul,ol{margin-left:1.5em}
86 ul li ul,ul li ol{margin-left:1.25em;margin-bottom:0}
87 ul.circle{list-style-type:circle}
88 ul.disc{list-style-type:disc}
89 ul.square{list-style-type:square}
90 ul.circle ul:not([class]),ul.disc ul:not([class]),ul.square ul:not([class]){list-style:inherit}
91 ol li ul,ol li ol{margin-left:1.25em;margin-bottom:0}
92 dl dt{margin-bottom:.3125em;font-weight:bold}
93 dl dd{margin-bottom:1.25em}
94 blockquote{margin:0 0 1.25em;padding:.5625em 1.25em 0 1.1875em;border-left:1px solid #ddd}
95 blockquote,blockquote p{line-height:1.6;color:rgba(0,0,0,.85)}
96 @media screen and (min-width:768px){h1,h2,h3,#toctitle,.sidebarblock>.content>.title,h4,h5,h6{line-height:1.2}
97 h1{font-size:2.75em}
98 h2{font-size:2.3125em}
99 h3,#toctitle,.sidebarblock>.content>.title{font-size:1.6875em}
100 h4{font-size:1.4375em}}
101 table{background:#fff;margin-bottom:1.25em;border:1px solid #dedede;word-wrap:normal}
102 table thead,table tfoot{background:#f7f8f7}
103 table thead tr th,table thead tr td,table tfoot tr th,table tfoot tr td{padding:.5em .625em .625em;font-size:inherit;color:rgba(0,0,0,.8);text-align:left}
104 table tr th,table tr td{padding:.5625em .625em;font-size:inherit;color:rgba(0,0,0,.8)}
105 table tr.even,table tr.alt{background:#f8f8f7}
106 table thead tr th,table tfoot tr th,table tbody tr td,table tr td,table tfoot tr td{line-height:1.6}
107 h1,h2,h3,#toctitle,.sidebarblock>.content>.title,h4,h5,h6{line-height:1.2;word-spacing:-.05em}
108 h1 strong,h2 strong,h3 strong,#toctitle strong,.sidebarblock>.content>.title strong,h4 strong,h5 strong,h6 strong{font-weight:400}
109 .center{margin-left:auto;margin-right:auto}
110 .stretch{width:100%}
111 .clearfix::before,.clearfix::after,.float-group::before,.float-group::after{content:" ";display:table}
112 .clearfix::after,.float-group::after{clear:both}
113 :not(pre).nobreak{word-wrap:normal}
114 :not(pre).nowrap{white-space:nowrap}
115 :not(pre).pre-wrap{white-space:pre-wrap}
116 :not(pre):not([class^=L])>code{font-size:.9375em;font-style:normal!important;letter-spacing:0;padding:.1em .5ex;word-spacing:-.15em;background:#f7f7f8;border-radius:4px;line-height:1.45;text-rendering:optimizeSpeed}
117 pre{color:rgba(0,0,0,.9);font-family:"Droid Sans Mono","DejaVu Sans Mono",monospace;line-height:1.45;text-rendering:optimizeSpeed}
118 pre code,pre pre{color:inherit;font-size:inherit;line-height:inherit}
119 pre>code{display:block}
120 pre.nowrap,pre.nowrap pre{white-space:pre;word-wrap:normal}
121 em em{font-style:normal}
122 strong strong{font-weight:400}
123 .keyseq{color:rgba(51,51,51,.8)}
124 kbd{font-family:"Droid Sans Mono","DejaVu Sans Mono",monospace;display:inline-block;color:rgba(0,0,0,.8);font-size:.65em;line-height:1.45;background:#f7f7f7;border:1px solid #ccc;border-radius:3px;box-shadow:0 1px 0 rgba(0,0,0,.2),inset 0 0 0 .1em #fff;margin:0 .15em;padding:.2em .5em;vertical-align:middle;position:relative;top:-.1em;white-space:nowrap}
125 .keyseq kbd:first-child{margin-left:0}
126 .keyseq kbd:last-child{margin-right:0}
127 .menuseq,.menuref{color:#000}
128 .menuseq b:not(.caret),.menuref{font-weight:inherit}
129 .menuseq{word-spacing:-.02em}
130 .menuseq b.caret{font-size:1.25em;line-height:.8}
131 .menuseq i.caret{font-weight:bold;text-align:center;width:.45em}
132 b.button::before,b.button::after{position:relative;top:-1px;font-weight:400}
133 b.button::before{content:"[";padding:0 3px 0 2px}
134 b.button::after{content:"]";padding:0 2px 0 3px}
135 p a>code:hover{color:rgba(0,0,0,.9)}
136 #header,#content,#footnotes,#footer{width:100%;margin:0 auto;max-width:62.5em;*zoom:1;position:relative;padding-left:.9375em;padding-right:.9375em}
137 #header::before,#header::after,#content::before,#content::after,#footnotes::before,#footnotes::after,#footer::before,#footer::after{content:" ";display:table}
138 #header::after,#content::after,#footnotes::after,#footer::after{clear:both}
139 #content{margin-top:1.25em}
140 #content::before{content:none}
141 #header>h1:first-child{color:rgba(0,0,0,.85);margin-top:2.25rem;margin-bottom:0}
142 #header>h1:first-child+#toc{margin-top:8px;border-top:1px solid #dddddf}
143 #header>h1:only-child,body.toc2 #header>h1:nth-last-child(2){border-bottom:1px solid #dddddf;padding-bottom:8px}
144 #header .details{border-bottom:1px solid #dddddf;line-height:1.45;padding-top:.25em;padding-bottom:.25em;padding-left:.25em;color:rgba(0,0,0,.6);display:flex;flex-flow:row wrap}
145 #header .details span:first-child{margin-left:-.125em}
146 #header .details span.email a{color:rgba(0,0,0,.85)}
147 #header .details br{display:none}
148 #header .details br+span::before{content:"\00a0\2013\00a0"}
149 #header .details br+span.author::before{content:"\00a0\22c5\00a0";color:rgba(0,0,0,.85)}
150 #header .details br+span#revremark::before{content:"\00a0|\00a0"}
151 #header #revnumber{text-transform:capitalize}
152 #header #revnumber::after{content:"\00a0"}
153 #content>h1:first-child:not([class]){color:rgba(0,0,0,.85);border-bottom:1px solid #dddddf;padding-bottom:8px;margin-top:0;padding-top:1rem;margin-bottom:1.25rem}
154 #toc{border-bottom:1px solid #e7e7e9;padding-bottom:.5em}
155 #toc>ul{margin-left:.125em}
156 #toc ul.sectlevel0>li>a{font-style:italic}
157 #toc ul.sectlevel0 ul.sectlevel1{margin:.5em 0}
158 #toc ul{font-family:"Open Sans","DejaVu Sans",sans-serif;list-style-type:none}
159 #toc li{line-height:1.3334;margin-top:.3334em}
160 #toc a{text-decoration:none}
161 #toc a:active{text-decoration:underline}
162 #toctitle{color:#7a2518;font-size:1.2em}
163 @media screen and (min-width:768px){#toctitle{font-size:1.375em}
164 body.toc2{padding-left:15em;padding-right:0}
165 #toc.toc2{margin-top:0!important;background:#f8f8f7;position:fixed;width:15em;left:0;top:0;border-right:1px solid #e7e7e9;border-top-width:0!important;border-bottom-width:0!important;z-index:1000;padding:1.25em 1em;height:100%;overflow:auto}
166 #toc.toc2 #toctitle{margin-top:0;margin-bottom:.8rem;font-size:1.2em}
167 #toc.toc2>ul{font-size:.9em;margin-bottom:0}
168 #toc.toc2 ul ul{margin-left:0;padding-left:1em}
169 #toc.toc2 ul.sectlevel0 ul.sectlevel1{padding-left:0;margin-top:.5em;margin-bottom:.5em}
170 body.toc2.toc-right{padding-left:0;padding-right:15em}
171 body.toc2.toc-right #toc.toc2{border-right-width:0;border-left:1px solid #e7e7e9;left:auto;right:0}}
172 @media screen and (min-width:1280px){body.toc2{padding-left:20em;padding-right:0}
173 #toc.toc2{width:20em}
174 #toc.toc2 #toctitle{font-size:1.375em}
175 #toc.toc2>ul{font-size:.95em}
176 #toc.toc2 ul ul{padding-left:1.25em}
177 body.toc2.toc-right{padding-left:0;padding-right:20em}}
178 #content #toc{border:1px solid #e0e0dc;margin-bottom:1.25em;padding:1.25em;background:#f8f8f7;border-radius:4px}
179 #content #toc>:first-child{margin-top:0}
180 #content #toc>:last-child{margin-bottom:0}
181 #footer{max-width:none;background:rgba(0,0,0,.8);padding:1.25em}
182 #footer-text{color:hsla(0,0%,100%,.8);line-height:1.44}
183 #content{margin-bottom:.625em}
184 .sect1{padding-bottom:.625em}
185 @media screen and (min-width:768px){#content{margin-bottom:1.25em}
186 .sect1{padding-bottom:1.25em}}
187 .sect1:last-child{padding-bottom:0}
188 .sect1+.sect1{border-top:1px solid #e7e7e9}
189 #content h1>a.anchor,h2>a.anchor,h3>a.anchor,#toctitle>a.anchor,.sidebarblock>.content>.title>a.anchor,h4>a.anchor,h5>a.anchor,h6>a.anchor{position:absolute;z-index:1001;width:1.5ex;margin-left:-1.5ex;display:block;text-decoration:none!important;visibility:hidden;text-align:center;font-weight:400}
190 #content h1>a.anchor::before,h2>a.anchor::before,h3>a.anchor::before,#toctitle>a.anchor::before,.sidebarblock>.content>.title>a.anchor::before,h4>a.anchor::before,h5>a.anchor::before,h6>a.anchor::before{content:"\00A7";font-size:.85em;display:block;padding-top:.1em}
191 #content h1:hover>a.anchor,#content h1>a.anchor:hover,h2:hover>a.anchor,h2>a.anchor:hover,h3:hover>a.anchor,#toctitle:hover>a.anchor,.sidebarblock>.content>.title:hover>a.anchor,h3>a.anchor:hover,#toctitle>a.anchor:hover,.sidebarblock>.content>.title>a.anchor:hover,h4:hover>a.anchor,h4>a.anchor:hover,h5:hover>a.anchor,h5>a.anchor:hover,h6:hover>a.anchor,h6>a.anchor:hover{visibility:visible}
192 #content h1>a.link,h2>a.link,h3>a.link,#toctitle>a.link,.sidebarblock>.content>.title>a.link,h4>a.link,h5>a.link,h6>a.link{color:#ba3925;text-decoration:none}
193 #content h1>a.link:hover,h2>a.link:hover,h3>a.link:hover,#toctitle>a.link:hover,.sidebarblock>.content>.title>a.link:hover,h4>a.link:hover,h5>a.link:hover,h6>a.link:hover{color:#a53221}
194 details,.audioblock,.imageblock,.literalblock,.listingblock,.stemblock,.videoblock{margin-bottom:1.25em}
195 details{margin-left:1.25rem}
196 details>summary{cursor:pointer;display:block;position:relative;line-height:1.6;margin-bottom:.625rem;outline:none;-webkit-tap-highlight-color:transparent}
197 details>summary::-webkit-details-marker{display:none}
198 details>summary::before{content:"";border:solid transparent;border-left:solid;border-width:.3em 0 .3em .5em;position:absolute;top:.5em;left:-1.25rem;transform:translateX(15%)}
199 details[open]>summary::before{border:solid transparent;border-top:solid;border-width:.5em .3em 0;transform:translateY(15%)}
200 details>summary::after{content:"";width:1.25rem;height:1em;position:absolute;top:.3em;left:-1.25rem}
201 .admonitionblock td.content>.title,.audioblock>.title,.exampleblock>.title,.imageblock>.title,.listingblock>.title,.literalblock>.title,.stemblock>.title,.openblock>.title,.paragraph>.title,.quoteblock>.title,table.tableblock>.title,.verseblock>.title,.videoblock>.title,.dlist>.title,.olist>.title,.ulist>.title,.qlist>.title,.hdlist>.title{text-rendering:optimizeLegibility;text-align:left;font-family:"Noto Serif","DejaVu Serif",serif;font-size:1rem;font-style:italic}
202 table.tableblock.fit-content>caption.title{white-space:nowrap;width:0}
203 .paragraph.lead>p,#preamble>.sectionbody>[class=paragraph]:first-of-type p{font-size:1.21875em;line-height:1.6;color:rgba(0,0,0,.85)}
204 .admonitionblock>table{border-collapse:separate;border:0;background:none;width:100%}
205 .admonitionblock>table td.icon{text-align:center;width:80px}
206 .admonitionblock>table td.icon img{max-width:none}
207 .admonitionblock>table td.icon .title{font-weight:bold;font-family:"Open Sans","DejaVu Sans",sans-serif;text-transform:uppercase}
208 .admonitionblock>table td.content{padding-left:1.125em;padding-right:1.25em;border-left:1px solid #dddddf;color:rgba(0,0,0,.6);word-wrap:anywhere}
209 .admonitionblock>table td.content>:last-child>:last-child{margin-bottom:0}
210 .exampleblock>.content{border:1px solid #e6e6e6;margin-bottom:1.25em;padding:1.25em;background:#fff;border-radius:4px}
211 .sidebarblock{border:1px solid #dbdbd6;margin-bottom:1.25em;padding:1.25em;background:#f3f3f2;border-radius:4px}
212 .sidebarblock>.content>.title{color:#7a2518;margin-top:0;text-align:center}
213 .exampleblock>.content>:first-child,.sidebarblock>.content>:first-child{margin-top:0}
214 .exampleblock>.content>:last-child,.exampleblock>.content>:last-child>:last-child,.exampleblock>.content .olist>ol>li:last-child>:last-child,.exampleblock>.content .ulist>ul>li:last-child>:last-child,.exampleblock>.content .qlist>ol>li:last-child>:last-child,.sidebarblock>.content>:last-child,.sidebarblock>.content>:last-child>:last-child,.sidebarblock>.content .olist>ol>li:last-child>:last-child,.sidebarblock>.content .ulist>ul>li:last-child>:last-child,.sidebarblock>.content .qlist>ol>li:last-child>:last-child{margin-bottom:0}
215 .literalblock pre,.listingblock>.content>pre{border-radius:4px;overflow-x:auto;padding:1em;font-size:.8125em}
216 @media screen and (min-width:768px){.literalblock pre,.listingblock>.content>pre{font-size:.90625em}}
217 @media screen and (min-width:1280px){.literalblock pre,.listingblock>.content>pre{font-size:1em}}
218 .literalblock pre,.listingblock>.content>pre:not(.highlight),.listingblock>.content>pre[class=highlight],.listingblock>.content>pre[class^="highlight "]{background:#f7f7f8}
219 .literalblock.output pre{color:#f7f7f8;background:rgba(0,0,0,.9)}
220 .listingblock>.content{position:relative}
221 .listingblock code[data-lang]::before{display:none;content:attr(data-lang);position:absolute;font-size:.75em;top:.425rem;right:.5rem;line-height:1;text-transform:uppercase;color:inherit;opacity:.5}
222 .listingblock:hover code[data-lang]::before{display:block}
223 .listingblock.terminal pre .command::before{content:attr(data-prompt);padding-right:.5em;color:inherit;opacity:.5}
224 .listingblock.terminal pre .command:not([data-prompt])::before{content:"$"}
225 .listingblock pre.highlightjs{padding:0}
226 .listingblock pre.highlightjs>code{padding:1em;border-radius:4px}
227 .listingblock pre.prettyprint{border-width:0}
228 .prettyprint{background:#f7f7f8}
229 pre.prettyprint .linenums{line-height:1.45;margin-left:2em}
230 pre.prettyprint li{background:none;list-style-type:inherit;padding-left:0}
231 pre.prettyprint li code[data-lang]::before{opacity:1}
232 pre.prettyprint li:not(:first-child) code[data-lang]::before{display:none}
233 table.linenotable{border-collapse:separate;border:0;margin-bottom:0;background:none}
234 table.linenotable td[class]{color:inherit;vertical-align:top;padding:0;line-height:inherit;white-space:normal}
235 table.linenotable td.code{padding-left:.75em}
236 table.linenotable td.linenos,pre.pygments .linenos{border-right:1px solid;opacity:.35;padding-right:.5em;-webkit-user-select:none;-moz-user-select:none;-ms-user-select:none;user-select:none}
237 pre.pygments span.linenos{display:inline-block;margin-right:.75em}
238 .quoteblock{margin:0 1em 1.25em 1.5em;display:table}
239 .quoteblock:not(.excerpt)>.title{margin-left:-1.5em;margin-bottom:.75em}
240 .quoteblock blockquote,.quoteblock p{color:rgba(0,0,0,.85);font-size:1.15rem;line-height:1.75;word-spacing:.1em;letter-spacing:0;font-style:italic;text-align:justify}
241 .quoteblock blockquote{margin:0;padding:0;border:0}
242 .quoteblock blockquote::before{content:"\201c";float:left;font-size:2.75em;font-weight:bold;line-height:.6em;margin-left:-.6em;color:#7a2518;text-shadow:0 1px 2px rgba(0,0,0,.1)}
243 .quoteblock blockquote>.paragraph:last-child p{margin-bottom:0}
244 .quoteblock .attribution{margin-top:.75em;margin-right:.5ex;text-align:right}
245 .verseblock{margin:0 1em 1.25em}
246 .verseblock pre{font-family:"Open Sans","DejaVu Sans",sans-serif;font-size:1.15rem;color:rgba(0,0,0,.85);font-weight:300;text-rendering:optimizeLegibility}
247 .verseblock pre strong{font-weight:400}
248 .verseblock .attribution{margin-top:1.25rem;margin-left:.5ex}
249 .quoteblock .attribution,.verseblock .attribution{font-size:.9375em;line-height:1.45;font-style:italic}
250 .quoteblock .attribution br,.verseblock .attribution br{display:none}
251 .quoteblock .attribution cite,.verseblock .attribution cite{display:block;letter-spacing:-.025em;color:rgba(0,0,0,.6)}
252 .quoteblock.abstract blockquote::before,.quoteblock.excerpt blockquote::before,.quoteblock .quoteblock blockquote::before{display:none}
253 .quoteblock.abstract blockquote,.quoteblock.abstract p,.quoteblock.excerpt blockquote,.quoteblock.excerpt p,.quoteblock .quoteblock blockquote,.quoteblock .quoteblock p{line-height:1.6;word-spacing:0}
254 .quoteblock.abstract{margin:0 1em 1.25em;display:block}
255 .quoteblock.abstract>.title{margin:0 0 .375em;font-size:1.15em;text-align:center}
256 .quoteblock.excerpt>blockquote,.quoteblock .quoteblock{padding:0 0 .25em 1em;border-left:.25em solid #dddddf}
257 .quoteblock.excerpt,.quoteblock .quoteblock{margin-left:0}
258 .quoteblock.excerpt blockquote,.quoteblock.excerpt p,.quoteblock .quoteblock blockquote,.quoteblock .quoteblock p{color:inherit;font-size:1.0625rem}
259 .quoteblock.excerpt .attribution,.quoteblock .quoteblock .attribution{color:inherit;font-size:.85rem;text-align:left;margin-right:0}
260 p.tableblock:last-child{margin-bottom:0}
261 td.tableblock>.content{margin-bottom:1.25em;word-wrap:anywhere}
262 td.tableblock>.content>:last-child{margin-bottom:-1.25em}
263 table.tableblock,th.tableblock,td.tableblock{border:0 solid #dedede}
264 table.grid-all>*>tr>*{border-width:1px}
265 table.grid-cols>*>tr>*{border-width:0 1px}
266 table.grid-rows>*>tr>*{border-width:1px 0}
267 table.frame-all{border-width:1px}
268 table.frame-ends{border-width:1px 0}
269 table.frame-sides{border-width:0 1px}
270 table.frame-none>colgroup+*>:first-child>*,table.frame-sides>colgroup+*>:first-child>*{border-top-width:0}
271 table.frame-none>:last-child>:last-child>*,table.frame-sides>:last-child>:last-child>*{border-bottom-width:0}
272 table.frame-none>*>tr>:first-child,table.frame-ends>*>tr>:first-child{border-left-width:0}
273 table.frame-none>*>tr>:last-child,table.frame-ends>*>tr>:last-child{border-right-width:0}
274 table.stripes-all>*>tr,table.stripes-odd>*>tr:nth-of-type(odd),table.stripes-even>*>tr:nth-of-type(even),table.stripes-hover>*>tr:hover{background:#f8f8f7}
275 th.halign-left,td.halign-left{text-align:left}
276 th.halign-right,td.halign-right{text-align:right}
277 th.halign-center,td.halign-center{text-align:center}
278 th.valign-top,td.valign-top{vertical-align:top}
279 th.valign-bottom,td.valign-bottom{vertical-align:bottom}
280 th.valign-middle,td.valign-middle{vertical-align:middle}
281 table thead th,table tfoot th{font-weight:bold}
282 tbody tr th{background:#f7f8f7}
283 tbody tr th,tbody tr th p,tfoot tr th,tfoot tr th p{color:rgba(0,0,0,.8);font-weight:bold}
284 p.tableblock>code:only-child{background:none;padding:0}
285 p.tableblock{font-size:1em}
286 ol{margin-left:1.75em}
287 ul li ol{margin-left:1.5em}
288 dl dd{margin-left:1.125em}
289 dl dd:last-child,dl dd:last-child>:last-child{margin-bottom:0}
290 li p,ul dd,ol dd,.olist .olist,.ulist .ulist,.ulist .olist,.olist .ulist{margin-bottom:.625em}
291 ul.checklist,ul.none,ol.none,ul.no-bullet,ol.no-bullet,ol.unnumbered,ul.unstyled,ol.unstyled{list-style-type:none}
292 ul.no-bullet,ol.no-bullet,ol.unnumbered{margin-left:.625em}
293 ul.unstyled,ol.unstyled{margin-left:0}
294 li>p:empty:only-child::before{content:"";display:inline-block}
295 ul.checklist>li>p:first-child{margin-left:-1em}
296 ul.checklist>li>p:first-child>.fa-square-o:first-child,ul.checklist>li>p:first-child>.fa-check-square-o:first-child{width:1.25em;font-size:.8em;position:relative;bottom:.125em}
297 ul.checklist>li>p:first-child>input[type=checkbox]:first-child{margin-right:.25em}
298 ul.inline{display:flex;flex-flow:row wrap;list-style:none;margin:0 0 .625em -1.25em}
299 ul.inline>li{margin-left:1.25em}
300 .unstyled dl dt{font-weight:400;font-style:normal}
301 ol.arabic{list-style-type:decimal}
302 ol.decimal{list-style-type:decimal-leading-zero}
303 ol.loweralpha{list-style-type:lower-alpha}
304 ol.upperalpha{list-style-type:upper-alpha}
305 ol.lowerroman{list-style-type:lower-roman}
306 ol.upperroman{list-style-type:upper-roman}
307 ol.lowergreek{list-style-type:lower-greek}
308 .hdlist>table,.colist>table{border:0;background:none}
309 .hdlist>table>tbody>tr,.colist>table>tbody>tr{background:none}
310 td.hdlist1,td.hdlist2{vertical-align:top;padding:0 .625em}
311 td.hdlist1{font-weight:bold;padding-bottom:1.25em}
312 td.hdlist2{word-wrap:anywhere}
313 .literalblock+.colist,.listingblock+.colist{margin-top:-.5em}
314 .colist td:not([class]):first-child{padding:.4em .75em 0;line-height:1;vertical-align:top}
315 .colist td:not([class]):first-child img{max-width:none}
316 .colist td:not([class]):last-child{padding:.25em 0}
317 .thumb,.th{line-height:0;display:inline-block;border:4px solid #fff;box-shadow:0 0 0 1px #ddd}
318 .imageblock.left{margin:.25em .625em 1.25em 0}
319 .imageblock.right{margin:.25em 0 1.25em .625em}
320 .imageblock>.title{margin-bottom:0}
321 .imageblock.thumb,.imageblock.th{border-width:6px}
322 .imageblock.thumb>.title,.imageblock.th>.title{padding:0 .125em}
323 .image.left,.image.right{margin-top:.25em;margin-bottom:.25em;display:inline-block;line-height:0}
324 .image.left{margin-right:.625em}
325 .image.right{margin-left:.625em}
326 a.image{text-decoration:none;display:inline-block}
327 a.image object{pointer-events:none}
328 sup.footnote,sup.footnoteref{font-size:.875em;position:static;vertical-align:super}
329 sup.footnote a,sup.footnoteref a{text-decoration:none}
330 sup.footnote a:active,sup.footnoteref a:active{text-decoration:underline}
331 #footnotes{padding-top:.75em;padding-bottom:.75em;margin-bottom:.625em}
332 #footnotes hr{width:20%;min-width:6.25em;margin:-.25em 0 .75em;border-width:1px 0 0}
333 #footnotes .footnote{padding:0 .375em 0 .225em;line-height:1.3334;font-size:.875em;margin-left:1.2em;margin-bottom:.2em}
334 #footnotes .footnote a:first-of-type{font-weight:bold;text-decoration:none;margin-left:-1.05em}
335 #footnotes .footnote:last-of-type{margin-bottom:0}
336 #content #footnotes{margin-top:-.625em;margin-bottom:0;padding:.75em 0}
337 div.unbreakable{page-break-inside:avoid}
338 .big{font-size:larger}
339 .small{font-size:smaller}
340 .underline{text-decoration:underline}
341 .overline{text-decoration:overline}
342 .line-through{text-decoration:line-through}
343 .aqua{color:#00bfbf}
344 .aqua-background{background:#00fafa}
345 .black{color:#000}
346 .black-background{background:#000}
347 .blue{color:#0000bf}
348 .blue-background{background:#0000fa}
349 .fuchsia{color:#bf00bf}
350 .fuchsia-background{background:#fa00fa}
351 .gray{color:#606060}
352 .gray-background{background:#7d7d7d}
353 .green{color:#006000}
354 .green-background{background:#007d00}
355 .lime{color:#00bf00}
356 .lime-background{background:#00fa00}
357 .maroon{color:#600000}
358 .maroon-background{background:#7d0000}
359 .navy{color:#000060}
360 .navy-background{background:#00007d}
361 .olive{color:#606000}
362 .olive-background{background:#7d7d00}
363 .purple{color:#600060}
364 .purple-background{background:#7d007d}
365 .red{color:#bf0000}
366 .red-background{background:#fa0000}
367 .silver{color:#909090}
368 .silver-background{background:#bcbcbc}
369 .teal{color:#006060}
370 .teal-background{background:#007d7d}
371 .white{color:#bfbfbf}
372 .white-background{background:#fafafa}
373 .yellow{color:#bfbf00}
374 .yellow-background{background:#fafa00}
375 span.icon>.fa{cursor:default}
376 a span.icon>.fa{cursor:inherit}
377 .admonitionblock td.icon [class^="fa icon-"]{font-size:2.5em;text-shadow:1px 1px 2px rgba(0,0,0,.5);cursor:default}
378 .admonitionblock td.icon .icon-note::before{content:"\f05a";color:#19407c}
379 .admonitionblock td.icon .icon-tip::before{content:"\f0eb";text-shadow:1px 1px 2px rgba(155,155,0,.8);color:#111}
380 .admonitionblock td.icon .icon-warning::before{content:"\f071";color:#bf6900}
381 .admonitionblock td.icon .icon-caution::before{content:"\f06d";color:#bf3400}
382 .admonitionblock td.icon .icon-important::before{content:"\f06a";color:#bf0000}
383 .conum[data-value]{display:inline-block;color:#fff!important;background:rgba(0,0,0,.8);border-radius:50%;text-align:center;font-size:.75em;width:1.67em;height:1.67em;line-height:1.67em;font-family:"Open Sans","DejaVu Sans",sans-serif;font-style:normal;font-weight:bold}
384 .conum[data-value] *{color:#fff!important}
385 .conum[data-value]+b{display:none}
386 .conum[data-value]::after{content:attr(data-value)}
387 pre .conum[data-value]{position:relative;top:-.125em}
388 b.conum *{color:inherit!important}
389 .conum:not([data-value]):empty{display:none}
390 dt,th.tableblock,td.content,div.footnote{text-rendering:optimizeLegibility}
391 h1,h2,p,td.content,span.alt,summary{letter-spacing:-.01em}
392 p strong,td.content strong,div.footnote strong{letter-spacing:-.005em}
393 p,blockquote,dt,td.content,td.hdlist1,span.alt,summary{font-size:1.0625rem}
394 p{margin-bottom:1.25rem}
395 .sidebarblock p,.sidebarblock dt,.sidebarblock td.content,p.tableblock{font-size:1em}
396 .exampleblock>.content{background:#fffef7;border-color:#e0e0dc;box-shadow:0 1px 4px #e0e0dc}
397 .print-only{display:none!important}
398 @page{margin:1.25cm .75cm}
399 @media print{*{box-shadow:none!important;text-shadow:none!important}
400 html{font-size:80%}
401 a{color:inherit!important;text-decoration:underline!important}
402 a.bare,a[href^="#"],a[href^="mailto:"]{text-decoration:none!important}
403 a[href^="http:"]:not(.bare)::after,a[href^="https:"]:not(.bare)::after{content:"(" attr(href) ")";display:inline-block;font-size:.875em;padding-left:.25em}
404 abbr[title]{border-bottom:1px dotted}
405 abbr[title]::after{content:" (" attr(title) ")"}
406 pre,blockquote,tr,img,object,svg{page-break-inside:avoid}
407 thead{display:table-header-group}
408 svg{max-width:100%}
409 p,blockquote,dt,td.content{font-size:1em;orphans:3;widows:3}
410 h2,h3,#toctitle,.sidebarblock>.content>.title{page-break-after:avoid}
411 #header,#content,#footnotes,#footer{max-width:none}
412 #toc,.sidebarblock,.exampleblock>.content{background:none!important}
413 #toc{border-bottom:1px solid #dddddf!important;padding-bottom:0!important}
414 body.book #header{text-align:center}
415 body.book #header>h1:first-child{border:0!important;margin:2.5em 0 1em}
416 body.book #header .details{border:0!important;display:block;padding:0!important}
417 body.book #header .details span:first-child{margin-left:0!important}
418 body.book #header .details br{display:block}
419 body.book #header .details br+span::before{content:none!important}
420 body.book #toc{border:0!important;text-align:left!important;padding:0!important;margin:0!important}
421 body.book #toc,body.book #preamble,body.book h1.sect0,body.book .sect1>h2{page-break-before:always}
422 .listingblock code[data-lang]::before{display:block}
423 #footer{padding:0 .9375em}
424 .hide-on-print{display:none!important}
425 .print-only{display:block!important}
426 .hide-for-print{display:none!important}
427 .show-for-print{display:inherit!important}}
428 @media amzn-kf8,print{#header>h1:first-child{margin-top:1.25rem}
429 .sect1{padding:0!important}
430 .sect1+.sect1{border:0}
431 #footer{background:none}
432 #footer-text{color:rgba(0,0,0,.6);font-size:.9em}}
433 @media amzn-kf8{#header,#content,#footnotes,#footer{padding:0}}
434 </style>
435 <style>
436 pre>code {
437 display: inline;
439 </style>
440 </head>
441 <body class="manpage">
442 <div id="header">
443 <h1>git-maintenance(1) Manual Page</h1>
444 <h2 id="_name">NAME</h2>
445 <div class="sectionbody">
446 <p>git-maintenance - Run tasks to optimize Git repository data</p>
447 </div>
448 </div>
449 <div id="content">
450 <div class="sect1">
451 <h2 id="_synopsis">SYNOPSIS</h2>
452 <div class="sectionbody">
453 <div class="verseblock">
454 <pre class="content"><em>git maintenance</em> run [&lt;options&gt;]
455 <em>git maintenance</em> start [--scheduler=&lt;scheduler&gt;]
456 <em>git maintenance</em> (stop|register|unregister) [&lt;options&gt;]</pre>
457 </div>
458 </div>
459 </div>
460 <div class="sect1">
461 <h2 id="_description">DESCRIPTION</h2>
462 <div class="sectionbody">
463 <div class="paragraph">
464 <p>Run tasks to optimize Git repository data, speeding up other Git commands
465 and reducing storage requirements for the repository.</p>
466 </div>
467 <div class="paragraph">
468 <p>Git commands that add repository data, such as <code>git add</code> or <code>git fetch</code>,
469 are optimized for a responsive user experience. These commands do not take
470 time to optimize the Git data, since such optimizations scale with the full
471 size of the repository while these user commands each perform a relatively
472 small action.</p>
473 </div>
474 <div class="paragraph">
475 <p>The <code>git maintenance</code> command provides flexibility for how to optimize the
476 Git repository.</p>
477 </div>
478 </div>
479 </div>
480 <div class="sect1">
481 <h2 id="_subcommands">SUBCOMMANDS</h2>
482 <div class="sectionbody">
483 <div class="dlist">
484 <dl>
485 <dt class="hdlist1">run</dt>
486 <dd>
487 <p>Run one or more maintenance tasks. If one or more <code>--task</code> options
488 are specified, then those tasks are run in that order. Otherwise,
489 the tasks are determined by which <code>maintenance.&lt;task&gt;.enabled</code>
490 config options are true. By default, only <code>maintenance.gc.enabled</code>
491 is true.</p>
492 </dd>
493 <dt class="hdlist1">start</dt>
494 <dd>
495 <p>Start running maintenance on the current repository. This performs
496 the same config updates as the <code>register</code> subcommand, then updates
497 the background scheduler to run <code>git maintenance run --scheduled</code>
498 on an hourly basis.</p>
499 </dd>
500 <dt class="hdlist1">stop</dt>
501 <dd>
502 <p>Halt the background maintenance schedule. The current repository
503 is not removed from the list of maintained repositories, in case
504 the background maintenance is restarted later.</p>
505 </dd>
506 <dt class="hdlist1">register</dt>
507 <dd>
508 <p>Initialize Git config values so any scheduled maintenance will start
509 running on this repository. This adds the repository to the
510 <code>maintenance.repo</code> config variable in the current user&#8217;s global config,
511 or the config specified by --config-file option, and enables some
512 recommended configuration values for <code>maintenance.&lt;task&gt;.schedule</code>. The
513 tasks that are enabled are safe for running in the background without
514 disrupting foreground processes.</p>
515 <div class="paragraph">
516 <p>The <code>register</code> subcommand will also set the <code>maintenance.strategy</code> config
517 value to <code>incremental</code>, if this value is not previously set. The
518 <code>incremental</code> strategy uses the following schedule for each maintenance
519 task:</p>
520 </div>
521 <div class="openblock">
522 <div class="content">
523 <div class="ulist">
524 <ul>
525 <li>
526 <p><code>gc</code>: disabled.</p>
527 </li>
528 <li>
529 <p><code>commit-graph</code>: hourly.</p>
530 </li>
531 <li>
532 <p><code>prefetch</code>: hourly.</p>
533 </li>
534 <li>
535 <p><code>loose-objects</code>: daily.</p>
536 </li>
537 <li>
538 <p><code>incremental-repack</code>: daily.</p>
539 </li>
540 </ul>
541 </div>
542 </div>
543 </div>
544 <div class="paragraph">
545 <p><code>git maintenance register</code> will also disable foreground maintenance by
546 setting <code>maintenance.auto = false</code> in the current repository. This config
547 setting will remain after a <code>git maintenance unregister</code> command.</p>
548 </div>
549 </dd>
550 <dt class="hdlist1">unregister</dt>
551 <dd>
552 <p>Remove the current repository from background maintenance. This
553 only removes the repository from the configured list. It does not
554 stop the background maintenance processes from running.</p>
555 <div class="paragraph">
556 <p>The <code>unregister</code> subcommand will report an error if the current repository
557 is not already registered. Use the <code>--force</code> option to return success even
558 when the current repository is not registered.</p>
559 </div>
560 </dd>
561 </dl>
562 </div>
563 </div>
564 </div>
565 <div class="sect1">
566 <h2 id="_tasks">TASKS</h2>
567 <div class="sectionbody">
568 <div class="dlist">
569 <dl>
570 <dt class="hdlist1">commit-graph</dt>
571 <dd>
572 <p>The <code>commit-graph</code> job updates the <code>commit-graph</code> files incrementally,
573 then verifies that the written data is correct. The incremental
574 write is safe to run alongside concurrent Git processes since it
575 will not expire <code>.graph</code> files that were in the previous
576 <code>commit-graph-chain</code> file. They will be deleted by a later run based
577 on the expiration delay.</p>
578 </dd>
579 <dt class="hdlist1">prefetch</dt>
580 <dd>
581 <p>The <code>prefetch</code> task updates the object directory with the latest
582 objects from all registered remotes. For each remote, a <code>git fetch</code>
583 command is run. The configured refspec is modified to place all
584 requested refs within <code>refs/prefetch/</code>. Also, tags are not updated.</p>
585 <div class="paragraph">
586 <p>This is done to avoid disrupting the remote-tracking branches. The end users
587 expect these refs to stay unmoved unless they initiate a fetch. However,
588 with the prefetch task, the objects necessary to complete a later real fetch
589 would already be obtained, making the real fetch faster. In the ideal case,
590 it will just become an update to a bunch of remote-tracking branches without
591 any object transfer.</p>
592 </div>
593 </dd>
594 <dt class="hdlist1">gc</dt>
595 <dd>
596 <p>Clean up unnecessary files and optimize the local repository. "GC"
597 stands for "garbage collection," but this task performs many
598 smaller tasks. This task can be expensive for large repositories,
599 as it repacks all Git objects into a single pack-file. It can also
600 be disruptive in some situations, as it deletes stale data. See
601 <a href="git-gc.html">git-gc(1)</a> for more details on garbage collection in Git.</p>
602 </dd>
603 <dt class="hdlist1">loose-objects</dt>
604 <dd>
605 <p>The <code>loose-objects</code> job cleans up loose objects and places them into
606 pack-files. In order to prevent race conditions with concurrent Git
607 commands, it follows a two-step process. First, it deletes any loose
608 objects that already exist in a pack-file; concurrent Git processes
609 will examine the pack-file for the object data instead of the loose
610 object. Second, it creates a new pack-file (starting with "loose-")
611 containing a batch of loose objects. The batch size is limited to 50
612 thousand objects to prevent the job from taking too long on a
613 repository with many loose objects. The <code>gc</code> task writes unreachable
614 objects as loose objects to be cleaned up by a later step only if
615 they are not re-added to a pack-file; for this reason it is not
616 advisable to enable both the <code>loose-objects</code> and <code>gc</code> tasks at the
617 same time.</p>
618 </dd>
619 <dt class="hdlist1">incremental-repack</dt>
620 <dd>
621 <p>The <code>incremental-repack</code> job repacks the object directory
622 using the <code>multi-pack-index</code> feature. In order to prevent race
623 conditions with concurrent Git commands, it follows a two-step
624 process. First, it calls <code>git multi-pack-index expire</code> to delete
625 pack-files unreferenced by the <code>multi-pack-index</code> file. Second, it
626 calls <code>git multi-pack-index repack</code> to select several small
627 pack-files and repack them into a bigger one, and then update the
628 <code>multi-pack-index</code> entries that refer to the small pack-files to
629 refer to the new pack-file. This prepares those small pack-files
630 for deletion upon the next run of <code>git multi-pack-index expire</code>.
631 The selection of the small pack-files is such that the expected
632 size of the big pack-file is at least the batch size; see the
633 <code>--batch-size</code> option for the <code>repack</code> subcommand in
634 <a href="git-multi-pack-index.html">git-multi-pack-index(1)</a>. The default batch-size is zero,
635 which is a special case that attempts to repack all pack-files
636 into a single pack-file.</p>
637 </dd>
638 <dt class="hdlist1">pack-refs</dt>
639 <dd>
640 <p>The <code>pack-refs</code> task collects the loose reference files and
641 collects them into a single file. This speeds up operations that
642 need to iterate across many references. See <a href="git-pack-refs.html">git-pack-refs(1)</a>
643 for more information.</p>
644 </dd>
645 </dl>
646 </div>
647 </div>
648 </div>
649 <div class="sect1">
650 <h2 id="_options">OPTIONS</h2>
651 <div class="sectionbody">
652 <div class="dlist">
653 <dl>
654 <dt class="hdlist1">--auto</dt>
655 <dd>
656 <p>When combined with the <code>run</code> subcommand, run maintenance tasks
657 only if certain thresholds are met. For example, the <code>gc</code> task
658 runs when the number of loose objects exceeds the number stored
659 in the <code>gc.auto</code> config setting, or when the number of pack-files
660 exceeds the <code>gc.autoPackLimit</code> config setting. Not compatible with
661 the <code>--schedule</code> option.</p>
662 </dd>
663 <dt class="hdlist1">--schedule</dt>
664 <dd>
665 <p>When combined with the <code>run</code> subcommand, run maintenance tasks
666 only if certain time conditions are met, as specified by the
667 <code>maintenance.&lt;task&gt;.schedule</code> config value for each <code>&lt;task&gt;</code>.
668 This config value specifies a number of seconds since the last
669 time that task ran, according to the <code>maintenance.&lt;task&gt;.lastRun</code>
670 config value. The tasks that are tested are those provided by
671 the <code>--task=&lt;task&gt;</code> option(s) or those with
672 <code>maintenance.&lt;task&gt;.enabled</code> set to true.</p>
673 </dd>
674 <dt class="hdlist1">--quiet</dt>
675 <dd>
676 <p>Do not report progress or other information over <code>stderr</code>.</p>
677 </dd>
678 <dt class="hdlist1">--task=&lt;task&gt;</dt>
679 <dd>
680 <p>If this option is specified one or more times, then only run the
681 specified tasks in the specified order. If no <code>--task=&lt;task&gt;</code>
682 arguments are specified, then only the tasks with
683 <code>maintenance.&lt;task&gt;.enabled</code> configured as <code>true</code> are considered.
684 See the <em>TASKS</em> section for the list of accepted <code>&lt;task&gt;</code> values.</p>
685 </dd>
686 <dt class="hdlist1">--scheduler=auto|crontab|systemd-timer|launchctl|schtasks</dt>
687 <dd>
688 <p>When combined with the <code>start</code> subcommand, specify the scheduler
689 for running the hourly, daily and weekly executions of
690 <code>git maintenance run</code>.
691 Possible values for <code>&lt;scheduler&gt;</code> are <code>auto</code>, <code>crontab</code>
692 (POSIX), <code>systemd-timer</code> (Linux), <code>launchctl</code> (macOS), and
693 <code>schtasks</code> (Windows). When <code>auto</code> is specified, the
694 appropriate platform-specific scheduler is used; on Linux,
695 <code>systemd-timer</code> is used if available, otherwise
696 <code>crontab</code>. Default is <code>auto</code>.</p>
697 </dd>
698 </dl>
699 </div>
700 </div>
701 </div>
702 <div class="sect1">
703 <h2 id="_troubleshooting">TROUBLESHOOTING</h2>
704 <div class="sectionbody">
705 <div class="paragraph">
706 <p>The <code>git maintenance</code> command is designed to simplify the repository
707 maintenance patterns while minimizing user wait time during Git commands.
708 A variety of configuration options are available to allow customizing this
709 process. The default maintenance options focus on operations that complete
710 quickly, even on large repositories.</p>
711 </div>
712 <div class="paragraph">
713 <p>Users may find some cases where scheduled maintenance tasks do not run as
714 frequently as intended. Each <code>git maintenance run</code> command takes a lock on
715 the repository&#8217;s object database, and this prevents other concurrent
716 <code>git maintenance run</code> commands from running on the same repository. Without
717 this safeguard, competing processes could leave the repository in an
718 unpredictable state.</p>
719 </div>
720 <div class="paragraph">
721 <p>The background maintenance schedule runs <code>git maintenance run</code> processes
722 on an hourly basis. Each run executes the "hourly" tasks. At midnight,
723 that process also executes the "daily" tasks. At midnight on the first day
724 of the week, that process also executes the "weekly" tasks. A single
725 process iterates over each registered repository, performing the scheduled
726 tasks for that frequency. Depending on the number of registered
727 repositories and their sizes, this process may take longer than an hour.
728 In this case, multiple <code>git maintenance run</code> commands may run on the same
729 repository at the same time, colliding on the object database lock. This
730 results in one of the two tasks not running.</p>
731 </div>
732 <div class="paragraph">
733 <p>If you find that some maintenance windows are taking longer than one hour
734 to complete, then consider reducing the complexity of your maintenance
735 tasks. For example, the <code>gc</code> task is much slower than the
736 <code>incremental-repack</code> task. However, this comes at a cost of a slightly
737 larger object database. Consider moving more expensive tasks to be run
738 less frequently.</p>
739 </div>
740 <div class="paragraph">
741 <p>Expert users may consider scheduling their own maintenance tasks using a
742 different schedule than is available through <code>git maintenance start</code> and
743 Git configuration options. These users should be aware of the object
744 database lock and how concurrent <code>git maintenance run</code> commands behave.
745 Further, the <code>git gc</code> command should not be combined with
746 <code>git maintenance run</code> commands. <code>git gc</code> modifies the object database
747 but does not take the lock in the same way as <code>git maintenance run</code>. If
748 possible, use <code>git maintenance run --task=gc</code> instead of <code>git gc</code>.</p>
749 </div>
750 <div class="paragraph">
751 <p>The following sections describe the mechanisms put in place to run
752 background maintenance by <code>git maintenance start</code> and how to customize
753 them.</p>
754 </div>
755 </div>
756 </div>
757 <div class="sect1">
758 <h2 id="_background_maintenance_on_posix_systems">BACKGROUND MAINTENANCE ON POSIX SYSTEMS</h2>
759 <div class="sectionbody">
760 <div class="paragraph">
761 <p>The standard mechanism for scheduling background tasks on POSIX systems
762 is cron(8). This tool executes commands based on a given schedule. The
763 current list of user-scheduled tasks can be found by running <code>crontab -l</code>.
764 The schedule written by <code>git maintenance start</code> is similar to this:</p>
765 </div>
766 <div class="listingblock">
767 <div class="content">
768 <pre># BEGIN GIT MAINTENANCE SCHEDULE
769 # The following schedule was created by Git
770 # Any edits made in this region might be
771 # replaced in the future by a Git command.
773 0 1-23 * * * "/&lt;path&gt;/git" --exec-path="/&lt;path&gt;" for-each-repo --config=maintenance.repo maintenance run --schedule=hourly
774 0 0 * * 1-6 "/&lt;path&gt;/git" --exec-path="/&lt;path&gt;" for-each-repo --config=maintenance.repo maintenance run --schedule=daily
775 0 0 * * 0 "/&lt;path&gt;/git" --exec-path="/&lt;path&gt;" for-each-repo --config=maintenance.repo maintenance run --schedule=weekly
777 # END GIT MAINTENANCE SCHEDULE</pre>
778 </div>
779 </div>
780 <div class="paragraph">
781 <p>The comments are used as a region to mark the schedule as written by Git.
782 Any modifications within this region will be completely deleted by
783 <code>git maintenance stop</code> or overwritten by <code>git maintenance start</code>.</p>
784 </div>
785 <div class="paragraph">
786 <p>The <code>crontab</code> entry specifies the full path of the <code>git</code> executable to
787 ensure that the executed <code>git</code> command is the same one with which
788 <code>git maintenance start</code> was issued independent of <code>PATH</code>. If the same user
789 runs <code>git maintenance start</code> with multiple Git executables, then only the
790 latest executable is used.</p>
791 </div>
792 <div class="paragraph">
793 <p>These commands use <code>git for-each-repo --config=maintenance.repo</code> to run
794 <code>git maintenance run --schedule=&lt;frequency&gt;</code> on each repository listed in
795 the multi-valued <code>maintenance.repo</code> config option. These are typically
796 loaded from the user-specific global config. The <code>git maintenance</code> process
797 then determines which maintenance tasks are configured to run on each
798 repository with each <code>&lt;frequency&gt;</code> using the <code>maintenance.&lt;task&gt;.schedule</code>
799 config options. These values are loaded from the global or repository
800 config values.</p>
801 </div>
802 <div class="paragraph">
803 <p>If the config values are insufficient to achieve your desired background
804 maintenance schedule, then you can create your own schedule. If you run
805 <code>crontab -e</code>, then an editor will load with your user-specific <code>cron</code>
806 schedule. In that editor, you can add your own schedule lines. You could
807 start by adapting the default schedule listed earlier, or you could read
808 the crontab(5) documentation for advanced scheduling techniques. Please
809 do use the full path and <code>--exec-path</code> techniques from the default
810 schedule to ensure you are executing the correct binaries in your
811 schedule.</p>
812 </div>
813 </div>
814 </div>
815 <div class="sect1">
816 <h2 id="_background_maintenance_on_linux_systemd_systems">BACKGROUND MAINTENANCE ON LINUX SYSTEMD SYSTEMS</h2>
817 <div class="sectionbody">
818 <div class="paragraph">
819 <p>While Linux supports <code>cron</code>, depending on the distribution, <code>cron</code> may
820 be an optional package not necessarily installed. On modern Linux
821 distributions, systemd timers are superseding it.</p>
822 </div>
823 <div class="paragraph">
824 <p>If user systemd timers are available, they will be used as a replacement
825 of <code>cron</code>.</p>
826 </div>
827 <div class="paragraph">
828 <p>In this case, <code>git maintenance start</code> will create user systemd timer units
829 and start the timers. The current list of user-scheduled tasks can be found
830 by running <code>systemctl --user list-timers</code>. The timers written by <code>git
831 maintenance start</code> are similar to this:</p>
832 </div>
833 <div class="listingblock">
834 <div class="content">
835 <pre>$ systemctl --user list-timers
836 NEXT LEFT LAST PASSED UNIT ACTIVATES
837 Thu 2021-04-29 19:00:00 CEST 42min left Thu 2021-04-29 18:00:11 CEST 17min ago git-maintenance@hourly.timer git-maintenance@hourly.service
838 Fri 2021-04-30 00:00:00 CEST 5h 42min left Thu 2021-04-29 00:00:11 CEST 18h ago git-maintenance@daily.timer git-maintenance@daily.service
839 Mon 2021-05-03 00:00:00 CEST 3 days left Mon 2021-04-26 00:00:11 CEST 3 days ago git-maintenance@weekly.timer git-maintenance@weekly.service</pre>
840 </div>
841 </div>
842 <div class="paragraph">
843 <p>One timer is registered for each <code>--schedule=&lt;frequency&gt;</code> option.</p>
844 </div>
845 <div class="paragraph">
846 <p>The definition of the systemd units can be inspected in the following files:</p>
847 </div>
848 <div class="listingblock">
849 <div class="content">
850 <pre>~/.config/systemd/user/git-maintenance@.timer
851 ~/.config/systemd/user/git-maintenance@.service
852 ~/.config/systemd/user/timers.target.wants/git-maintenance@hourly.timer
853 ~/.config/systemd/user/timers.target.wants/git-maintenance@daily.timer
854 ~/.config/systemd/user/timers.target.wants/git-maintenance@weekly.timer</pre>
855 </div>
856 </div>
857 <div class="paragraph">
858 <p><code>git maintenance start</code> will overwrite these files and start the timer
859 again with <code>systemctl --user</code>, so any customization should be done by
860 creating a drop-in file, i.e. a <code>.conf</code> suffixed file in the
861 <code>~/.config/systemd/user/git-maintenance@.service.d</code> directory.</p>
862 </div>
863 <div class="paragraph">
864 <p><code>git maintenance stop</code> will stop the user systemd timers and delete
865 the above mentioned files.</p>
866 </div>
867 <div class="paragraph">
868 <p>For more details, see <code>systemd.timer(5)</code>.</p>
869 </div>
870 </div>
871 </div>
872 <div class="sect1">
873 <h2 id="_background_maintenance_on_macos_systems">BACKGROUND MAINTENANCE ON MACOS SYSTEMS</h2>
874 <div class="sectionbody">
875 <div class="paragraph">
876 <p>While macOS technically supports <code>cron</code>, using <code>crontab -e</code> requires
877 elevated privileges and the executed process does not have a full user
878 context. Without a full user context, Git and its credential helpers
879 cannot access stored credentials, so some maintenance tasks are not
880 functional.</p>
881 </div>
882 <div class="paragraph">
883 <p>Instead, <code>git maintenance start</code> interacts with the <code>launchctl</code> tool,
884 which is the recommended way to schedule timed jobs in macOS. Scheduling
885 maintenance through <code>git maintenance (start|stop)</code> requires some
886 <code>launchctl</code> features available only in macOS 10.11 or later.</p>
887 </div>
888 <div class="paragraph">
889 <p>Your user-specific scheduled tasks are stored as XML-formatted <code>.plist</code>
890 files in <code>~/Library/LaunchAgents/</code>. You can see the currently-registered
891 tasks using the following command:</p>
892 </div>
893 <div class="listingblock">
894 <div class="content">
895 <pre>$ ls ~/Library/LaunchAgents/org.git-scm.git*
896 org.git-scm.git.daily.plist
897 org.git-scm.git.hourly.plist
898 org.git-scm.git.weekly.plist</pre>
899 </div>
900 </div>
901 <div class="paragraph">
902 <p>One task is registered for each <code>--schedule=&lt;frequency&gt;</code> option. To
903 inspect how the XML format describes each schedule, open one of these
904 <code>.plist</code> files in an editor and inspect the <code>&lt;array&gt;</code> element following
905 the <code>&lt;key&gt;StartCalendarInterval&lt;/key&gt;</code> element.</p>
906 </div>
907 <div class="paragraph">
908 <p><code>git maintenance start</code> will overwrite these files and register the
909 tasks again with <code>launchctl</code>, so any customizations should be done by
910 creating your own <code>.plist</code> files with distinct names. Similarly, the
911 <code>git maintenance stop</code> command will unregister the tasks with <code>launchctl</code>
912 and delete the <code>.plist</code> files.</p>
913 </div>
914 <div class="paragraph">
915 <p>To create more advanced customizations to your background tasks, see
916 launchctl.plist(5) for more information.</p>
917 </div>
918 </div>
919 </div>
920 <div class="sect1">
921 <h2 id="_background_maintenance_on_windows_systems">BACKGROUND MAINTENANCE ON WINDOWS SYSTEMS</h2>
922 <div class="sectionbody">
923 <div class="paragraph">
924 <p>Windows does not support <code>cron</code> and instead has its own system for
925 scheduling background tasks. The <code>git maintenance start</code> command uses
926 the <code>schtasks</code> command to submit tasks to this system. You can inspect
927 all background tasks using the Task Scheduler application. The tasks
928 added by Git have names of the form <code>Git Maintenance (&lt;frequency&gt;)</code>.
929 The Task Scheduler GUI has ways to inspect these tasks, but you can also
930 export the tasks to XML files and view the details there.</p>
931 </div>
932 <div class="paragraph">
933 <p>Note that since Git is a console application, these background tasks
934 create a console window visible to the current user. This can be changed
935 manually by selecting the "Run whether user is logged in or not" option
936 in Task Scheduler. This change requires a password input, which is why
937 <code>git maintenance start</code> does not select it by default.</p>
938 </div>
939 <div class="paragraph">
940 <p>If you want to customize the background tasks, please rename the tasks
941 so future calls to <code>git maintenance (start|stop)</code> do not overwrite your
942 custom tasks.</p>
943 </div>
944 </div>
945 </div>
946 <div class="sect1">
947 <h2 id="_configuration">CONFIGURATION</h2>
948 <div class="sectionbody">
949 <div class="paragraph">
950 <p>Everything below this line in this section is selectively included
951 from the <a href="git-config.html">git-config(1)</a> documentation. The content is the same
952 as what&#8217;s found there:</p>
953 </div>
954 <div class="dlist">
955 <dl>
956 <dt class="hdlist1">maintenance.auto</dt>
957 <dd>
958 <p>This boolean config option controls whether some commands run
959 <code>git maintenance run --auto</code> after doing their normal work. Defaults
960 to true.</p>
961 </dd>
962 <dt class="hdlist1">maintenance.autoDetach</dt>
963 <dd>
964 <p>Many Git commands trigger automatic maintenance after they have
965 written data into the repository. This boolean config option
966 controls whether this automatic maintenance shall happen in the
967 foreground or whether the maintenance process shall detach and
968 continue to run in the background.</p>
969 <div class="paragraph">
970 <p>If unset, the value of <code>gc.autoDetach</code> is used as a fallback. Defaults
971 to true if both are unset, meaning that the maintenance process will
972 detach.</p>
973 </div>
974 </dd>
975 <dt class="hdlist1">maintenance.strategy</dt>
976 <dd>
977 <p>This string config option provides a way to specify one of a few
978 recommended schedules for background maintenance. This only affects
979 which tasks are run during <code>git maintenance run --schedule=X</code>
980 commands, provided no <code>--task=&lt;task&gt;</code> arguments are provided.
981 Further, if a <code>maintenance.&lt;task&gt;.schedule</code> config value is set,
982 then that value is used instead of the one provided by
983 <code>maintenance.strategy</code>. The possible strategy strings are:</p>
984 <div class="ulist">
985 <ul>
986 <li>
987 <p><code>none</code>: This default setting implies no tasks are run at any schedule.</p>
988 </li>
989 <li>
990 <p><code>incremental</code>: This setting optimizes for performing small maintenance
991 activities that do not delete any data. This does not schedule the <code>gc</code>
992 task, but runs the <code>prefetch</code> and <code>commit-graph</code> tasks hourly, the
993 <code>loose-objects</code> and <code>incremental-repack</code> tasks daily, and the <code>pack-refs</code>
994 task weekly.</p>
995 </li>
996 </ul>
997 </div>
998 </dd>
999 <dt class="hdlist1">maintenance.&lt;task&gt;.enabled</dt>
1000 <dd>
1001 <p>This boolean config option controls whether the maintenance task
1002 with name <code>&lt;task&gt;</code> is run when no <code>--task</code> option is specified to
1003 <code>git maintenance run</code>. These config values are ignored if a
1004 <code>--task</code> option exists. By default, only <code>maintenance.gc.enabled</code>
1005 is true.</p>
1006 </dd>
1007 <dt class="hdlist1">maintenance.&lt;task&gt;.schedule</dt>
1008 <dd>
1009 <p>This config option controls whether or not the given <code>&lt;task&gt;</code> runs
1010 during a <code>git maintenance run --schedule=&lt;frequency&gt;</code> command. The
1011 value must be one of "hourly", "daily", or "weekly".</p>
1012 </dd>
1013 <dt class="hdlist1">maintenance.commit-graph.auto</dt>
1014 <dd>
1015 <p>This integer config option controls how often the <code>commit-graph</code> task
1016 should be run as part of <code>git maintenance run --auto</code>. If zero, then
1017 the <code>commit-graph</code> task will not run with the <code>--auto</code> option. A
1018 negative value will force the task to run every time. Otherwise, a
1019 positive value implies the command should run when the number of
1020 reachable commits that are not in the commit-graph file is at least
1021 the value of <code>maintenance.commit-graph.auto</code>. The default value is
1022 100.</p>
1023 </dd>
1024 <dt class="hdlist1">maintenance.loose-objects.auto</dt>
1025 <dd>
1026 <p>This integer config option controls how often the <code>loose-objects</code> task
1027 should be run as part of <code>git maintenance run --auto</code>. If zero, then
1028 the <code>loose-objects</code> task will not run with the <code>--auto</code> option. A
1029 negative value will force the task to run every time. Otherwise, a
1030 positive value implies the command should run when the number of
1031 loose objects is at least the value of <code>maintenance.loose-objects.auto</code>.
1032 The default value is 100.</p>
1033 </dd>
1034 <dt class="hdlist1">maintenance.incremental-repack.auto</dt>
1035 <dd>
1036 <p>This integer config option controls how often the <code>incremental-repack</code>
1037 task should be run as part of <code>git maintenance run --auto</code>. If zero,
1038 then the <code>incremental-repack</code> task will not run with the <code>--auto</code>
1039 option. A negative value will force the task to run every time.
1040 Otherwise, a positive value implies the command should run when the
1041 number of pack-files not in the multi-pack-index is at least the value
1042 of <code>maintenance.incremental-repack.auto</code>. The default value is 10.</p>
1043 </dd>
1044 </dl>
1045 </div>
1046 </div>
1047 </div>
1048 <div class="sect1">
1049 <h2 id="_git">GIT</h2>
1050 <div class="sectionbody">
1051 <div class="paragraph">
1052 <p>Part of the <a href="git.html">git(1)</a> suite</p>
1053 </div>
1054 </div>
1055 </div>
1056 </div>
1057 <div id="footer">
1058 <div id="footer-text">
1059 Last updated 2023-10-23 14:43:46 -0700
1060 </div>
1061 </div>
1062 </body>
1063 </html>