| <!DOCTYPE html> |
| <html xmlns="http://www.w3.org/1999/xhtml" lang="en"> |
| <head> |
| <meta charset="UTF-8"/> |
| <meta http-equiv="X-UA-Compatible" content="IE=edge"/> |
| <meta name="viewport" content="width=device-width, initial-scale=1.0"/> |
| <meta name="generator" content="Asciidoctor 2.0.26"/> |
| <title>git-hook(1)</title> |
| <link rel="stylesheet" href="https://fonts.googleapis.com/css?family=Open+Sans:300,300italic,400,400italic,600,600italic%7CNoto+Serif:400,400italic,700,700italic%7CDroid+Sans+Mono:400,700"/> |
| <style> |
| /*! Asciidoctor default stylesheet | MIT License | https://asciidoctor.org */ |
| /* Uncomment the following line when using as a custom stylesheet */ |
| /* @import "https://fonts.googleapis.com/css?family=Open+Sans:300,300italic,400,400italic,600,600italic%7CNoto+Serif:400,400italic,700,700italic%7CDroid+Sans+Mono:400,700"; */ |
| html{font-family:sans-serif;-webkit-text-size-adjust:100%} |
| a{background:none} |
| a:focus{outline:thin dotted} |
| a:active,a:hover{outline:0} |
| h1{font-size:2em;margin:.67em 0} |
| b,strong{font-weight:bold} |
| abbr{font-size:.9em} |
| abbr[title]{cursor:help;border-bottom:1px dotted #dddddf;text-decoration:none} |
| dfn{font-style:italic} |
| hr{height:0} |
| mark{background:#ff0;color:#000} |
| code,kbd,pre,samp{font-family:monospace;font-size:1em} |
| pre{white-space:pre-wrap} |
| q{quotes:"\201C" "\201D" "\2018" "\2019"} |
| small{font-size:80%} |
| sub,sup{font-size:75%;line-height:0;position:relative;vertical-align:baseline} |
| sup{top:-.5em} |
| sub{bottom:-.25em} |
| img{border:0} |
| svg:not(:root){overflow:hidden} |
| figure{margin:0} |
| audio,video{display:inline-block} |
| audio:not([controls]){display:none;height:0} |
| fieldset{border:1px solid silver;margin:0 2px;padding:.35em .625em .75em} |
| legend{border:0;padding:0} |
| button,input,select,textarea{font-family:inherit;font-size:100%;margin:0} |
| button,input{line-height:normal} |
| button,select{text-transform:none} |
| button,html input[type=button],input[type=reset],input[type=submit]{-webkit-appearance:button;cursor:pointer} |
| button[disabled],html input[disabled]{cursor:default} |
| input[type=checkbox],input[type=radio]{padding:0} |
| button::-moz-focus-inner,input::-moz-focus-inner{border:0;padding:0} |
| textarea{overflow:auto;vertical-align:top} |
| table{border-collapse:collapse;border-spacing:0} |
| *,::before,::after{box-sizing:border-box} |
| html,body{font-size:100%} |
| body{background:#fff;color:rgba(0,0,0,.8);padding:0;margin:0;font-family:"Noto Serif","DejaVu Serif",serif;line-height:1;position:relative;cursor:auto;-moz-tab-size:4;-o-tab-size:4;tab-size:4;word-wrap:anywhere;-moz-osx-font-smoothing:grayscale;-webkit-font-smoothing:antialiased} |
| a:hover{cursor:pointer} |
| img,object,embed{max-width:100%;height:auto} |
| object,embed{height:100%} |
| img{-ms-interpolation-mode:bicubic} |
| .left{float:left!important} |
| .right{float:right!important} |
| .text-left{text-align:left!important} |
| .text-right{text-align:right!important} |
| .text-center{text-align:center!important} |
| .text-justify{text-align:justify!important} |
| .hide{display:none} |
| img,object,svg{display:inline-block;vertical-align:middle} |
| textarea{height:auto;min-height:50px} |
| select{width:100%} |
| .subheader,.admonitionblock td.content>.title,.audioblock>.title,.exampleblock>.title,.imageblock>.title,.listingblock>.title,.literalblock>.title,.stemblock>.title,.openblock>.title,.paragraph>.title,.quoteblock>.title,table.tableblock>.title,.verseblock>.title,.videoblock>.title,.dlist>.title,.olist>.title,.ulist>.title,.qlist>.title,.hdlist>.title{line-height:1.45;color:#7a2518;font-weight:400;margin-top:0;margin-bottom:.25em} |
| div,dl,dt,dd,ul,ol,li,h1,h2,h3,#toctitle,.sidebarblock>.content>.title,h4,h5,h6,pre,form,p,blockquote,th,td{margin:0;padding:0} |
| a{color:#2156a5;text-decoration:underline;line-height:inherit} |
| a:hover,a:focus{color:#1d4b8f} |
| a img{border:0} |
| p{line-height:1.6;margin-bottom:1.25em;text-rendering:optimizeLegibility} |
| p aside{font-size:.875em;line-height:1.35;font-style:italic} |
| h1,h2,h3,#toctitle,.sidebarblock>.content>.title,h4,h5,h6{font-family:"Open Sans","DejaVu Sans",sans-serif;font-weight:300;font-style:normal;color:#ba3925;text-rendering:optimizeLegibility;margin-top:1em;margin-bottom:.5em;line-height:1.0125em} |
| h1 small,h2 small,h3 small,#toctitle small,.sidebarblock>.content>.title small,h4 small,h5 small,h6 small{font-size:60%;color:#e99b8f;line-height:0} |
| h1{font-size:2.125em} |
| h2{font-size:1.6875em} |
| h3,#toctitle,.sidebarblock>.content>.title{font-size:1.375em} |
| h4,h5{font-size:1.125em} |
| h6{font-size:1em} |
| hr{border:solid #dddddf;border-width:1px 0 0;clear:both;margin:1.25em 0 1.1875em} |
| em,i{font-style:italic;line-height:inherit} |
| strong,b{font-weight:bold;line-height:inherit} |
| small{font-size:60%;line-height:inherit} |
| code{font-family:"Droid Sans Mono","DejaVu Sans Mono",monospace;font-weight:400;color:rgba(0,0,0,.9)} |
| ul,ol,dl{line-height:1.6;margin-bottom:1.25em;list-style-position:outside;font-family:inherit} |
| ul,ol{margin-left:1.5em} |
| ul li ul,ul li ol{margin-left:1.25em;margin-bottom:0} |
| ul.circle{list-style-type:circle} |
| ul.disc{list-style-type:disc} |
| ul.square{list-style-type:square} |
| ul.circle ul:not([class]),ul.disc ul:not([class]),ul.square ul:not([class]){list-style:inherit} |
| ol li ul,ol li ol{margin-left:1.25em;margin-bottom:0} |
| dl dt{margin-bottom:.3125em;font-weight:bold} |
| dl dd{margin-bottom:1.25em} |
| blockquote{margin:0 0 1.25em;padding:.5625em 1.25em 0 1.1875em;border-left:1px solid #ddd} |
| blockquote,blockquote p{line-height:1.6;color:rgba(0,0,0,.85)} |
| @media screen and (min-width:768px){h1,h2,h3,#toctitle,.sidebarblock>.content>.title,h4,h5,h6{line-height:1.2} |
| h1{font-size:2.75em} |
| h2{font-size:2.3125em} |
| h3,#toctitle,.sidebarblock>.content>.title{font-size:1.6875em} |
| h4{font-size:1.4375em}} |
| table{background:#fff;margin-bottom:1.25em;border:1px solid #dedede;word-wrap:normal} |
| table thead,table tfoot{background:#f7f8f7} |
| table thead tr th,table thead tr td,table tfoot tr th,table tfoot tr td{padding:.5em .625em .625em;font-size:inherit;color:rgba(0,0,0,.8);text-align:left} |
| table tr th,table tr td{padding:.5625em .625em;font-size:inherit;color:rgba(0,0,0,.8)} |
| table tr.even,table tr.alt{background:#f8f8f7} |
| table thead tr th,table tfoot tr th,table tbody tr td,table tr td,table tfoot tr td{line-height:1.6} |
| h1,h2,h3,#toctitle,.sidebarblock>.content>.title,h4,h5,h6{line-height:1.2;word-spacing:-.05em} |
| h1 strong,h2 strong,h3 strong,#toctitle strong,.sidebarblock>.content>.title strong,h4 strong,h5 strong,h6 strong{font-weight:400} |
| .center{margin-left:auto;margin-right:auto} |
| .stretch{width:100%} |
| .clearfix::before,.clearfix::after,.float-group::before,.float-group::after{content:" ";display:table} |
| .clearfix::after,.float-group::after{clear:both} |
| :not(pre).nobreak{word-wrap:normal} |
| :not(pre).nowrap{white-space:nowrap} |
| :not(pre).pre-wrap{white-space:pre-wrap} |
| :not(pre):not([class^=L])>code{font-size:.9375em;font-style:normal!important;letter-spacing:0;padding:.1em .5ex;word-spacing:-.15em;background:#f7f7f8;border-radius:4px;line-height:1.45;text-rendering:optimizeSpeed} |
| pre{color:rgba(0,0,0,.9);font-family:"Droid Sans Mono","DejaVu Sans Mono",monospace;line-height:1.45;text-rendering:optimizeSpeed} |
| pre code,pre pre{color:inherit;font-size:inherit;line-height:inherit} |
| pre.nowrap,pre.nowrap pre{white-space:pre;word-wrap:normal} |
| em em{font-style:normal} |
| strong strong{font-weight:400} |
| .keyseq{color:rgba(51,51,51,.8)} |
| kbd{font-family:"Droid Sans Mono","DejaVu Sans Mono",monospace;display:inline-block;color:rgba(0,0,0,.8);font-size:.65em;line-height:1.45;background:#f7f7f7;border:1px solid #ccc;border-radius:3px;box-shadow:0 1px 0 rgba(0,0,0,.2),inset 0 0 0 .1em #fff;margin:0 .15em;padding:.2em .5em;vertical-align:middle;position:relative;top:-.1em;white-space:nowrap} |
| .keyseq kbd:first-child{margin-left:0} |
| .keyseq kbd:last-child{margin-right:0} |
| .menuseq,.menuref{color:#000} |
| .menuseq b:not(.caret),.menuref{font-weight:inherit} |
| .menuseq{word-spacing:-.02em} |
| .menuseq b.caret{font-size:1.25em;line-height:.8} |
| .menuseq i.caret{font-weight:bold;text-align:center;width:.45em} |
| b.button::before,b.button::after{position:relative;top:-1px;font-weight:400} |
| b.button::before{content:"[";padding:0 3px 0 2px} |
| b.button::after{content:"]";padding:0 2px 0 3px} |
| p a>code:hover{color:rgba(0,0,0,.9)} |
| #header,#content,#footnotes,#footer{width:100%;margin:0 auto;max-width:62.5em;*zoom:1;position:relative;padding-left:.9375em;padding-right:.9375em} |
| #header::before,#header::after,#content::before,#content::after,#footnotes::before,#footnotes::after,#footer::before,#footer::after{content:" ";display:table} |
| #header::after,#content::after,#footnotes::after,#footer::after{clear:both} |
| #content{margin-top:1.25em} |
| #content::before{content:none} |
| #header>h1:first-child{color:rgba(0,0,0,.85);margin-top:2.25rem;margin-bottom:0} |
| #header>h1:first-child+#toc{margin-top:8px;border-top:1px solid #dddddf} |
| #header>h1:only-child{border-bottom:1px solid #dddddf;padding-bottom:8px} |
| #header .details{border-bottom:1px solid #dddddf;line-height:1.45;padding-top:.25em;padding-bottom:.25em;padding-left:.25em;color:rgba(0,0,0,.6);display:flex;flex-flow:row wrap} |
| #header .details span:first-child{margin-left:-.125em} |
| #header .details span.email a{color:rgba(0,0,0,.85)} |
| #header .details br{display:none} |
| #header .details br+span::before{content:"\00a0\2013\00a0"} |
| #header .details br+span.author::before{content:"\00a0\22c5\00a0";color:rgba(0,0,0,.85)} |
| #header .details br+span#revremark::before{content:"\00a0|\00a0"} |
| #header #revnumber{text-transform:capitalize} |
| #header #revnumber::after{content:"\00a0"} |
| #content>h1:first-child:not([class]){color:rgba(0,0,0,.85);border-bottom:1px solid #dddddf;padding-bottom:8px;margin-top:0;padding-top:1rem;margin-bottom:1.25rem} |
| #toc{border-bottom:1px solid #e7e7e9;padding-bottom:.5em} |
| #toc>ul{margin-left:.125em} |
| #toc ul.sectlevel0>li>a{font-style:italic} |
| #toc ul.sectlevel0 ul.sectlevel1{margin:.5em 0} |
| #toc ul{font-family:"Open Sans","DejaVu Sans",sans-serif;list-style-type:none} |
| #toc li{line-height:1.3334;margin-top:.3334em} |
| #toc a{text-decoration:none} |
| #toc a:active{text-decoration:underline} |
| #toctitle{color:#7a2518;font-size:1.2em} |
| @media screen and (min-width:768px){#toctitle{font-size:1.375em} |
| body.toc2{padding-left:15em;padding-right:0} |
| body.toc2 #header>h1:nth-last-child(2){border-bottom:1px solid #dddddf;padding-bottom:8px} |
| #toc.toc2{margin-top:0!important;background:#f8f8f7;position:fixed;width:15em;left:0;top:0;border-right:1px solid #e7e7e9;border-top-width:0!important;border-bottom-width:0!important;z-index:1000;padding:1.25em 1em;height:100%;overflow:auto} |
| #toc.toc2 #toctitle{margin-top:0;margin-bottom:.8rem;font-size:1.2em} |
| #toc.toc2>ul{font-size:.9em;margin-bottom:0} |
| #toc.toc2 ul ul{margin-left:0;padding-left:1em} |
| #toc.toc2 ul.sectlevel0 ul.sectlevel1{padding-left:0;margin-top:.5em;margin-bottom:.5em} |
| body.toc2.toc-right{padding-left:0;padding-right:15em} |
| body.toc2.toc-right #toc.toc2{border-right-width:0;border-left:1px solid #e7e7e9;left:auto;right:0}} |
| @media screen and (min-width:1280px){body.toc2{padding-left:20em;padding-right:0} |
| #toc.toc2{width:20em} |
| #toc.toc2 #toctitle{font-size:1.375em} |
| #toc.toc2>ul{font-size:.95em} |
| #toc.toc2 ul ul{padding-left:1.25em} |
| body.toc2.toc-right{padding-left:0;padding-right:20em}} |
| #content #toc{border:1px solid #e0e0dc;margin-bottom:1.25em;padding:1.25em;background:#f8f8f7;border-radius:4px} |
| #content #toc>:first-child{margin-top:0} |
| #content #toc>:last-child{margin-bottom:0} |
| #footer{max-width:none;background:rgba(0,0,0,.8);padding:1.25em} |
| #footer-text{color:hsla(0,0%,100%,.8);line-height:1.44} |
| #content{margin-bottom:.625em} |
| .sect1{padding-bottom:.625em} |
| @media screen and (min-width:768px){#content{margin-bottom:1.25em} |
| .sect1{padding-bottom:1.25em}} |
| .sect1:last-child{padding-bottom:0} |
| .sect1+.sect1{border-top:1px solid #e7e7e9} |
| #content h1>a.anchor,h2>a.anchor,h3>a.anchor,#toctitle>a.anchor,.sidebarblock>.content>.title>a.anchor,h4>a.anchor,h5>a.anchor,h6>a.anchor{position:absolute;z-index:1001;width:1.5ex;margin-left:-1.5ex;display:block;text-decoration:none!important;visibility:hidden;text-align:center;font-weight:400} |
| #content h1>a.anchor::before,h2>a.anchor::before,h3>a.anchor::before,#toctitle>a.anchor::before,.sidebarblock>.content>.title>a.anchor::before,h4>a.anchor::before,h5>a.anchor::before,h6>a.anchor::before{content:"\00A7";font-size:.85em;display:block;padding-top:.1em} |
| #content h1:hover>a.anchor,#content h1>a.anchor:hover,h2:hover>a.anchor,h2>a.anchor:hover,h3:hover>a.anchor,#toctitle:hover>a.anchor,.sidebarblock>.content>.title:hover>a.anchor,h3>a.anchor:hover,#toctitle>a.anchor:hover,.sidebarblock>.content>.title>a.anchor:hover,h4:hover>a.anchor,h4>a.anchor:hover,h5:hover>a.anchor,h5>a.anchor:hover,h6:hover>a.anchor,h6>a.anchor:hover{visibility:visible} |
| #content h1>a.link,h2>a.link,h3>a.link,#toctitle>a.link,.sidebarblock>.content>.title>a.link,h4>a.link,h5>a.link,h6>a.link{color:#ba3925;text-decoration:none} |
| #content h1>a.link:hover,h2>a.link:hover,h3>a.link:hover,#toctitle>a.link:hover,.sidebarblock>.content>.title>a.link:hover,h4>a.link:hover,h5>a.link:hover,h6>a.link:hover{color:#a53221} |
| details,.audioblock,.imageblock,.literalblock,.listingblock,.stemblock,.videoblock{margin-bottom:1.25em} |
| details{margin-left:1.25rem} |
| details>summary{cursor:pointer;display:block;position:relative;line-height:1.6;margin-bottom:.625rem;outline:none;-webkit-tap-highlight-color:transparent} |
| details>summary::-webkit-details-marker{display:none} |
| details>summary::before{content:"";border:solid transparent;border-left:solid;border-width:.3em 0 .3em .5em;position:absolute;top:.5em;left:-1.25rem;transform:translateX(15%)} |
| details[open]>summary::before{border:solid transparent;border-top:solid;border-width:.5em .3em 0;transform:translateY(15%)} |
| details>summary::after{content:"";width:1.25rem;height:1em;position:absolute;top:.3em;left:-1.25rem} |
| .admonitionblock td.content>.title,.audioblock>.title,.exampleblock>.title,.imageblock>.title,.listingblock>.title,.literalblock>.title,.stemblock>.title,.openblock>.title,.paragraph>.title,.quoteblock>.title,table.tableblock>.title,.verseblock>.title,.videoblock>.title,.dlist>.title,.olist>.title,.ulist>.title,.qlist>.title,.hdlist>.title{text-rendering:optimizeLegibility;text-align:left;font-family:"Noto Serif","DejaVu Serif",serif;font-size:1rem;font-style:italic} |
| table.tableblock.fit-content>caption.title{white-space:nowrap;width:0} |
| .paragraph.lead>p,#preamble>.sectionbody>[class=paragraph]:first-of-type p{font-size:1.21875em;line-height:1.6;color:rgba(0,0,0,.85)} |
| .admonitionblock>table{border-collapse:separate;border:0;background:none;width:100%} |
| .admonitionblock>table td.icon{text-align:center;width:80px} |
| .admonitionblock>table td.icon img{max-width:none} |
| .admonitionblock>table td.icon .title{font-weight:bold;font-family:"Open Sans","DejaVu Sans",sans-serif;text-transform:uppercase} |
| .admonitionblock>table td.content{padding-left:1.125em;padding-right:1.25em;border-left:1px solid #dddddf;color:rgba(0,0,0,.6);word-wrap:anywhere} |
| .admonitionblock>table td.content>:last-child>:last-child{margin-bottom:0} |
| .exampleblock>.content{border:1px solid #e6e6e6;margin-bottom:1.25em;padding:1.25em;background:#fff;border-radius:4px} |
| .sidebarblock{border:1px solid #dbdbd6;margin-bottom:1.25em;padding:1.25em;background:#f3f3f2;border-radius:4px} |
| .sidebarblock>.content>.title{color:#7a2518;margin-top:0;text-align:center} |
| .exampleblock>.content>:first-child,.sidebarblock>.content>:first-child{margin-top:0} |
| .exampleblock>.content>:last-child,.exampleblock>.content>:last-child>:last-child,.exampleblock>.content .olist>ol>li:last-child>:last-child,.exampleblock>.content .ulist>ul>li:last-child>:last-child,.exampleblock>.content .qlist>ol>li:last-child>:last-child,.sidebarblock>.content>:last-child,.sidebarblock>.content>:last-child>:last-child,.sidebarblock>.content .olist>ol>li:last-child>:last-child,.sidebarblock>.content .ulist>ul>li:last-child>:last-child,.sidebarblock>.content .qlist>ol>li:last-child>:last-child{margin-bottom:0} |
| .literalblock pre,.listingblock>.content>pre{border-radius:4px;overflow-x:auto;padding:1em;font-size:.8125em} |
| @media screen and (min-width:768px){.literalblock pre,.listingblock>.content>pre{font-size:.90625em}} |
| @media screen and (min-width:1280px){.literalblock pre,.listingblock>.content>pre{font-size:1em}} |
| .literalblock pre,.listingblock>.content>pre:not(.highlight),.listingblock>.content>pre[class=highlight],.listingblock>.content>pre[class^="highlight "]{background:#f7f7f8} |
| .literalblock.output pre{color:#f7f7f8;background:rgba(0,0,0,.9)} |
| .listingblock>.content{position:relative} |
| .listingblock pre>code{display:block} |
| .listingblock code[data-lang]::before{display:none;content:attr(data-lang);position:absolute;font-size:.75em;top:.425rem;right:.5rem;line-height:1;text-transform:uppercase;color:inherit;opacity:.5} |
| .listingblock:hover code[data-lang]::before{display:block} |
| .listingblock.terminal pre .command::before{content:attr(data-prompt);padding-right:.5em;color:inherit;opacity:.5} |
| .listingblock.terminal pre .command:not([data-prompt])::before{content:"$"} |
| .listingblock pre.highlightjs{padding:0} |
| .listingblock pre.highlightjs>code{padding:1em;border-radius:4px} |
| .listingblock pre.prettyprint{border-width:0} |
| .prettyprint{background:#f7f7f8} |
| pre.prettyprint .linenums{line-height:1.45;margin-left:2em} |
| pre.prettyprint li{background:none;list-style-type:inherit;padding-left:0} |
| pre.prettyprint li code[data-lang]::before{opacity:1} |
| pre.prettyprint li:not(:first-child) code[data-lang]::before{display:none} |
| table.linenotable{border-collapse:separate;border:0;margin-bottom:0;background:none} |
| table.linenotable td[class]{color:inherit;vertical-align:top;padding:0;line-height:inherit;white-space:normal} |
| table.linenotable td.code{padding-left:.75em} |
| table.linenotable td.linenos,pre.pygments .linenos{border-right:1px solid;opacity:.35;padding-right:.5em;-webkit-user-select:none;-moz-user-select:none;-ms-user-select:none;user-select:none} |
| pre.pygments span.linenos{display:inline-block;margin-right:.75em} |
| .quoteblock{margin:0 1em 1.25em 1.5em;display:table} |
| .quoteblock:not(.excerpt)>.title{margin-left:-1.5em;margin-bottom:.75em} |
| .quoteblock blockquote,.quoteblock p{color:rgba(0,0,0,.85);font-size:1.15rem;line-height:1.75;word-spacing:.1em;letter-spacing:0;font-style:italic;text-align:justify} |
| .quoteblock blockquote{margin:0;padding:0;border:0} |
| .quoteblock blockquote::before{content:"\201c";float:left;font-size:2.75em;font-weight:bold;line-height:.6em;margin-left:-.6em;color:#7a2518;text-shadow:0 1px 2px rgba(0,0,0,.1)} |
| .quoteblock blockquote>.paragraph:last-child p{margin-bottom:0} |
| .quoteblock .attribution{margin-top:.75em;margin-right:.5ex;text-align:right} |
| .verseblock{margin:0 1em 1.25em} |
| .verseblock pre{font-family:"Open Sans","DejaVu Sans",sans-serif;font-size:1.15rem;color:rgba(0,0,0,.85);font-weight:300;text-rendering:optimizeLegibility} |
| .verseblock pre strong{font-weight:400} |
| .verseblock .attribution{margin-top:1.25rem;margin-left:.5ex} |
| .quoteblock .attribution,.verseblock .attribution{font-size:.9375em;line-height:1.45;font-style:italic} |
| .quoteblock .attribution br,.verseblock .attribution br{display:none} |
| .quoteblock .attribution cite,.verseblock .attribution cite{display:block;letter-spacing:-.025em;color:rgba(0,0,0,.6)} |
| .quoteblock.abstract blockquote::before,.quoteblock.excerpt blockquote::before,.quoteblock .quoteblock blockquote::before{display:none} |
| .quoteblock.abstract blockquote,.quoteblock.abstract p,.quoteblock.excerpt blockquote,.quoteblock.excerpt p,.quoteblock .quoteblock blockquote,.quoteblock .quoteblock p{line-height:1.6;word-spacing:0} |
| .quoteblock.abstract{margin:0 1em 1.25em;display:block} |
| .quoteblock.abstract>.title{margin:0 0 .375em;font-size:1.15em;text-align:center} |
| .quoteblock.excerpt>blockquote,.quoteblock .quoteblock{padding:0 0 .25em 1em;border-left:.25em solid #dddddf} |
| .quoteblock.excerpt,.quoteblock .quoteblock{margin-left:0} |
| .quoteblock.excerpt blockquote,.quoteblock.excerpt p,.quoteblock .quoteblock blockquote,.quoteblock .quoteblock p{color:inherit;font-size:1.0625rem} |
| .quoteblock.excerpt .attribution,.quoteblock .quoteblock .attribution{color:inherit;font-size:.85rem;text-align:left;margin-right:0} |
| p.tableblock:last-child{margin-bottom:0} |
| td.tableblock>.content{margin-bottom:1.25em;word-wrap:anywhere} |
| td.tableblock>.content>:last-child{margin-bottom:-1.25em} |
| table.tableblock,th.tableblock,td.tableblock{border:0 solid #dedede} |
| table.grid-all>*>tr>*{border-width:1px} |
| table.grid-cols>*>tr>*{border-width:0 1px} |
| table.grid-rows>*>tr>*{border-width:1px 0} |
| table.frame-all{border-width:1px} |
| table.frame-ends{border-width:1px 0} |
| table.frame-sides{border-width:0 1px} |
| table.frame-none>colgroup+*>:first-child>*,table.frame-sides>colgroup+*>:first-child>*{border-top-width:0} |
| table.frame-none>:last-child>:last-child>*,table.frame-sides>:last-child>:last-child>*{border-bottom-width:0} |
| table.frame-none>*>tr>:first-child,table.frame-ends>*>tr>:first-child{border-left-width:0} |
| table.frame-none>*>tr>:last-child,table.frame-ends>*>tr>:last-child{border-right-width:0} |
| table.stripes-all>*>tr,table.stripes-odd>*>tr:nth-of-type(odd),table.stripes-even>*>tr:nth-of-type(even),table.stripes-hover>*>tr:hover{background:#f8f8f7} |
| th.halign-left,td.halign-left{text-align:left} |
| th.halign-right,td.halign-right{text-align:right} |
| th.halign-center,td.halign-center{text-align:center} |
| th.valign-top,td.valign-top{vertical-align:top} |
| th.valign-bottom,td.valign-bottom{vertical-align:bottom} |
| th.valign-middle,td.valign-middle{vertical-align:middle} |
| table thead th,table tfoot th{font-weight:bold} |
| tbody tr th{background:#f7f8f7} |
| tbody tr th,tbody tr th p,tfoot tr th,tfoot tr th p{color:rgba(0,0,0,.8);font-weight:bold} |
| p.tableblock>code:only-child{background:none;padding:0} |
| p.tableblock{font-size:1em} |
| ol{margin-left:1.75em} |
| ul li ol{margin-left:1.5em} |
| dl dd{margin-left:1.125em} |
| dl dd:last-child,dl dd:last-child>:last-child{margin-bottom:0} |
| li p,ul dd,ol dd,.olist .olist,.ulist .ulist,.ulist .olist,.olist .ulist{margin-bottom:.625em} |
| ul.checklist,ul.none,ol.none,ul.no-bullet,ol.no-bullet,ol.unnumbered,ul.unstyled,ol.unstyled{list-style-type:none} |
| ul.no-bullet,ol.no-bullet,ol.unnumbered{margin-left:.625em} |
| ul.unstyled,ol.unstyled{margin-left:0} |
| li>p:empty:only-child::before{content:"";display:inline-block} |
| ul.checklist>li>p:first-child{margin-left:-1em} |
| ul.checklist>li>p:first-child>.fa-square-o:first-child,ul.checklist>li>p:first-child>.fa-check-square-o:first-child{width:1.25em;font-size:.8em;position:relative;bottom:.125em} |
| ul.checklist>li>p:first-child>input[type=checkbox]:first-child{margin-right:.25em} |
| ul.inline{display:flex;flex-flow:row wrap;list-style:none;margin:0 0 .625em -1.25em} |
| ul.inline>li{margin-left:1.25em} |
| .unstyled dl dt{font-weight:400;font-style:normal} |
| ol.arabic{list-style-type:decimal} |
| ol.decimal{list-style-type:decimal-leading-zero} |
| ol.loweralpha{list-style-type:lower-alpha} |
| ol.upperalpha{list-style-type:upper-alpha} |
| ol.lowerroman{list-style-type:lower-roman} |
| ol.upperroman{list-style-type:upper-roman} |
| ol.lowergreek{list-style-type:lower-greek} |
| .hdlist>table,.colist>table{border:0;background:none} |
| .hdlist>table>tbody>tr,.colist>table>tbody>tr{background:none} |
| td.hdlist1,td.hdlist2{vertical-align:top;padding:0 .625em} |
| td.hdlist1{font-weight:bold;padding-bottom:1.25em} |
| td.hdlist2{word-wrap:anywhere} |
| .literalblock+.colist,.listingblock+.colist{margin-top:-.5em} |
| .colist td:not([class]):first-child{padding:.4em .75em 0;line-height:1;vertical-align:top} |
| .colist td:not([class]):first-child img{max-width:none} |
| .colist td:not([class]):last-child{padding:.25em 0} |
| .thumb,.th{line-height:0;display:inline-block;border:4px solid #fff;box-shadow:0 0 0 1px #ddd} |
| .imageblock.left{margin:.25em .625em 1.25em 0} |
| .imageblock.right{margin:.25em 0 1.25em .625em} |
| .imageblock>.title{margin-bottom:0} |
| .imageblock.thumb,.imageblock.th{border-width:6px} |
| .imageblock.thumb>.title,.imageblock.th>.title{padding:0 .125em} |
| .image.left,.image.right{margin-top:.25em;margin-bottom:.25em;display:inline-block;line-height:0} |
| .image.left{margin-right:.625em} |
| .image.right{margin-left:.625em} |
| a.image{text-decoration:none;display:inline-block} |
| a.image object{pointer-events:none} |
| sup.footnote,sup.footnoteref{font-size:.875em;position:static;vertical-align:super} |
| sup.footnote a,sup.footnoteref a{text-decoration:none} |
| sup.footnote a:active,sup.footnoteref a:active,#footnotes .footnote a:first-of-type:active{text-decoration:underline} |
| #footnotes{padding-top:.75em;padding-bottom:.75em;margin-bottom:.625em} |
| #footnotes hr{width:20%;min-width:6.25em;margin:-.25em 0 .75em;border-width:1px 0 0} |
| #footnotes .footnote{padding:0 .375em 0 .225em;line-height:1.3334;font-size:.875em;margin-left:1.2em;margin-bottom:.2em} |
| #footnotes .footnote a:first-of-type{font-weight:bold;text-decoration:none;margin-left:-1.05em} |
| #footnotes .footnote:last-of-type{margin-bottom:0} |
| #content #footnotes{margin-top:-.625em;margin-bottom:0;padding:.75em 0} |
| div.unbreakable{page-break-inside:avoid} |
| .big{font-size:larger} |
| .small{font-size:smaller} |
| .underline{text-decoration:underline} |
| .overline{text-decoration:overline} |
| .line-through{text-decoration:line-through} |
| .aqua{color:#00bfbf} |
| .aqua-background{background:#00fafa} |
| .black{color:#000} |
| .black-background{background:#000} |
| .blue{color:#0000bf} |
| .blue-background{background:#0000fa} |
| .fuchsia{color:#bf00bf} |
| .fuchsia-background{background:#fa00fa} |
| .gray{color:#606060} |
| .gray-background{background:#7d7d7d} |
| .green{color:#006000} |
| .green-background{background:#007d00} |
| .lime{color:#00bf00} |
| .lime-background{background:#00fa00} |
| .maroon{color:#600000} |
| .maroon-background{background:#7d0000} |
| .navy{color:#000060} |
| .navy-background{background:#00007d} |
| .olive{color:#606000} |
| .olive-background{background:#7d7d00} |
| .purple{color:#600060} |
| .purple-background{background:#7d007d} |
| .red{color:#bf0000} |
| .red-background{background:#fa0000} |
| .silver{color:#909090} |
| .silver-background{background:#bcbcbc} |
| .teal{color:#006060} |
| .teal-background{background:#007d7d} |
| .white{color:#bfbfbf} |
| .white-background{background:#fafafa} |
| .yellow{color:#bfbf00} |
| .yellow-background{background:#fafa00} |
| span.icon>.fa{cursor:default} |
| a span.icon>.fa{cursor:inherit} |
| .admonitionblock td.icon [class^="fa icon-"]{font-size:2.5em;text-shadow:1px 1px 2px rgba(0,0,0,.5);cursor:default} |
| .admonitionblock td.icon .icon-note::before{content:"\f05a";color:#19407c} |
| .admonitionblock td.icon .icon-tip::before{content:"\f0eb";text-shadow:1px 1px 2px rgba(155,155,0,.8);color:#111} |
| .admonitionblock td.icon .icon-warning::before{content:"\f071";color:#bf6900} |
| .admonitionblock td.icon .icon-caution::before{content:"\f06d";color:#bf3400} |
| .admonitionblock td.icon .icon-important::before{content:"\f06a";color:#bf0000} |
| .conum[data-value]{display:inline-block;color:#fff!important;background:rgba(0,0,0,.8);border-radius:50%;text-align:center;font-size:.75em;width:1.67em;height:1.67em;line-height:1.67em;font-family:"Open Sans","DejaVu Sans",sans-serif;font-style:normal;font-weight:bold} |
| .conum[data-value] *{color:#fff!important} |
| .conum[data-value]+b{display:none} |
| .conum[data-value]::after{content:attr(data-value)} |
| pre .conum[data-value]{position:relative;top:-.125em} |
| b.conum *{color:inherit!important} |
| .conum:not([data-value]):empty{display:none} |
| dt,th.tableblock,td.content,div.footnote{text-rendering:optimizeLegibility} |
| h1,h2,p,td.content,span.alt,summary{letter-spacing:-.01em} |
| p strong,td.content strong,div.footnote strong{letter-spacing:-.005em} |
| p,blockquote,dt,td.content,td.hdlist1,span.alt,summary{font-size:1.0625rem} |
| p{margin-bottom:1.25rem} |
| .sidebarblock p,.sidebarblock dt,.sidebarblock td.content,p.tableblock{font-size:1em} |
| .exampleblock>.content{background:#fffef7;border-color:#e0e0dc;box-shadow:0 1px 4px #e0e0dc} |
| .print-only{display:none!important} |
| @page{margin:1.25cm .75cm} |
| @media print{*{box-shadow:none!important;text-shadow:none!important} |
| html{font-size:80%} |
| a{color:inherit!important;text-decoration:underline!important} |
| a.bare,a[href^="#"],a[href^="mailto:"]{text-decoration:none!important} |
| a[href^="http:"]:not(.bare)::after,a[href^="https:"]:not(.bare)::after{content:"(" attr(href) ")";display:inline-block;font-size:.875em;padding-left:.25em} |
| abbr[title]{border-bottom:1px dotted} |
| abbr[title]::after{content:" (" attr(title) ")"} |
| pre,blockquote,tr,img,object,svg{page-break-inside:avoid} |
| thead{display:table-header-group} |
| svg{max-width:100%} |
| p,blockquote,dt,td.content{font-size:1em;orphans:3;widows:3} |
| h2,h3,#toctitle,.sidebarblock>.content>.title{page-break-after:avoid} |
| #header,#content,#footnotes,#footer{max-width:none} |
| #toc,.sidebarblock,.exampleblock>.content{background:none!important} |
| #toc{border-bottom:1px solid #dddddf!important;padding-bottom:0!important} |
| body.book #header{text-align:center} |
| body.book #header>h1:first-child{border:0!important;margin:2.5em 0 1em} |
| body.book #header .details{border:0!important;display:block;padding:0!important} |
| body.book #header .details span:first-child{margin-left:0!important} |
| body.book #header .details br{display:block} |
| body.book #header .details br+span::before{content:none!important} |
| body.book #toc{border:0!important;text-align:left!important;padding:0!important;margin:0!important} |
| body.book #toc,body.book #preamble,body.book h1.sect0,body.book .sect1>h2{page-break-before:always} |
| .listingblock code[data-lang]::before{display:block} |
| #footer{padding:0 .9375em} |
| .hide-on-print{display:none!important} |
| .print-only{display:block!important} |
| .hide-for-print{display:none!important} |
| .show-for-print{display:inherit!important}} |
| @media amzn-kf8,print{#header>h1:first-child{margin-top:1.25rem} |
| .sect1{padding:0!important} |
| .sect1+.sect1{border:0} |
| #footer{background:none} |
| #footer-text{color:rgba(0,0,0,.6);font-size:.9em}} |
| @media amzn-kf8{#header,#content,#footnotes,#footer{padding:0}} |
| </style> |
| <style> |
| pre>code { |
| display: inline; |
| } |
| </style> |
| </head> |
| <body class="manpage"> |
| <div id="header"> |
| <h1>git-hook(1) Manual Page</h1> |
| <h2 id="_name">NAME</h2> |
| <div class="sectionbody"> |
| <p>git-hook - Run git hooks</p> |
| </div> |
| </div> |
| <div id="content"> |
| <div class="sect1"> |
| <h2 id="_synopsis">SYNOPSIS</h2> |
| <div class="sectionbody"> |
| <div class="verseblock"> |
| <pre class="content"><em>git hook</em> run [--allow-unknown-hook-name] [--ignore-missing] [--to-stdin=<path>] [(-j|--jobs) <n>] |
| <hook-name> [-- <hook-args>] |
| <em>git hook</em> list [--allow-unknown-hook-name] [-z] [--show-scope] <hook-name></pre> |
| </div> |
| </div> |
| </div> |
| <div class="sect1"> |
| <h2 id="_description">DESCRIPTION</h2> |
| <div class="sectionbody"> |
| <div class="paragraph"> |
| <p>A command interface for running git hooks (see <a href="githooks.html">githooks(5)</a>), |
| for use by other scripted git commands.</p> |
| </div> |
| <div class="paragraph"> |
| <p>This command parses the default configuration files for sets of configs like |
| so:</p> |
| </div> |
| <div class="literalblock"> |
| <div class="content"> |
| <pre>[hook "linter"] |
| event = pre-commit |
| command = ~/bin/linter --cpp20</pre> |
| </div> |
| </div> |
| <div class="paragraph"> |
| <p>In this example, [<code>hook</code> "linter"] represents one script - <code>~/bin/linter</code> |
| <code>--cpp20</code> - which can be shared by many repos, and even by many hook events, if |
| appropriate.</p> |
| </div> |
| <div class="paragraph"> |
| <p>To add an unrelated hook which runs on a different event, for example a |
| spell-checker for your commit messages, you would write a configuration like so:</p> |
| </div> |
| <div class="literalblock"> |
| <div class="content"> |
| <pre>[hook "linter"] |
| event = pre-commit |
| command = ~/bin/linter --cpp20 |
| [hook "spellcheck"] |
| event = commit-msg |
| command = ~/bin/spellchecker</pre> |
| </div> |
| </div> |
| <div class="paragraph"> |
| <p>With this config, when you run <em>git commit</em>, first <code>~/bin/linter</code> <code>--cpp20</code> will |
| have a chance to check your files to be committed (during the <code>pre-commit</code> hook |
| event`), and then <code>~/bin/spellchecker</code> will have a chance to check your commit |
| message (during the <code>commit-msg</code> hook event).</p> |
| </div> |
| <div class="paragraph"> |
| <p>Commands are run in the order Git encounters their associated |
| <code>hook.</code><em><friendly-name></em><code>.event</code> configs during the configuration parse (see |
| <a href="git-config.html">git-config(1)</a>). Although multiple <code>hook.linter.event</code> configs can be |
| added, only one <code>hook.linter.command</code> event is valid - Git uses "last-one-wins" |
| to determine which command to run.</p> |
| </div> |
| <div class="paragraph"> |
| <p>So if you wanted your linter to run when you commit as well as when you push, |
| you would configure it like so:</p> |
| </div> |
| <div class="literalblock"> |
| <div class="content"> |
| <pre>[hook "linter"] |
| event = pre-commit |
| event = pre-push |
| command = ~/bin/linter --cpp20</pre> |
| </div> |
| </div> |
| <div class="paragraph"> |
| <p>With this config, <code>~/bin/linter</code> <code>--cpp20</code> would be run by Git before a commit is |
| generated (during <code>pre-commit</code>) as well as before a push is performed (during |
| <code>pre-push</code>).</p> |
| </div> |
| <div class="paragraph"> |
| <p>And if you wanted to run your linter as well as a secret-leak detector during |
| only the "pre-commit" hook event, you would configure it instead like so:</p> |
| </div> |
| <div class="literalblock"> |
| <div class="content"> |
| <pre>[hook "linter"] |
| event = pre-commit |
| command = ~/bin/linter --cpp20 |
| [hook "no-leaks"] |
| event = pre-commit |
| command = ~/bin/leak-detector</pre> |
| </div> |
| </div> |
| <div class="paragraph"> |
| <p>With this config, before a commit is generated (during <code>pre-commit</code>), Git would |
| first start <code>~/bin/linter</code> <code>--cpp20</code> and second start <code>~/bin/leak-detector</code>. It |
| would evaluate the output of each when deciding whether to proceed with the |
| commit.</p> |
| </div> |
| <div class="paragraph"> |
| <p>For a full list of hook events which you can set your <code>hook.</code><em><friendly-name></em><code>.event</code> to, |
| and how hooks are invoked during those events, see <a href="githooks.html">githooks(5)</a>.</p> |
| </div> |
| <div class="paragraph"> |
| <p>Git will ignore any <code>hook.</code><em><friendly-name></em><code>.event</code> that specifies an event it doesn’t |
| recognize. This is intended so that tools which wrap Git can use the hook |
| infrastructure to run their own hooks; see "WRAPPERS" for more guidance.</p> |
| </div> |
| <div class="paragraph"> |
| <p>In general, when instructions suggest adding a script to |
| .<code>git/hooks/</code><em><hook-event></em>, you can specify it in the config instead by running:</p> |
| </div> |
| <div class="listingblock"> |
| <div class="content"> |
| <pre>git config set hook.<some-name>.command <path-to-script> |
| git config set --append hook.<some-name>.event <hook-event></pre> |
| </div> |
| </div> |
| <div class="paragraph"> |
| <p>This way you can share the script between multiple repos. That is, <code>cp</code> |
| <code>~/my-script.sh</code> <code>~/project/.git/hooks/pre-commit</code> would become:</p> |
| </div> |
| <div class="listingblock"> |
| <div class="content"> |
| <pre>git config set hook.my-script.command ~/my-script.sh |
| git config set --append hook.my-script.event pre-commit</pre> |
| </div> |
| </div> |
| </div> |
| </div> |
| <div class="sect1"> |
| <h2 id="_subcommands">SUBCOMMANDS</h2> |
| <div class="sectionbody"> |
| <div class="dlist"> |
| <dl> |
| <dt class="hdlist1">run</dt> |
| <dd> |
| <p>Runs hooks configured for <em><hook-name></em>, in the order they are |
| discovered during the config parse. The default <em><hook-name></em> from |
| the hookdir is run last. See <a href="githooks.html">githooks(5)</a> for supported |
| hook names.</p> |
| <div class="paragraph"> |
| <p>Any positional arguments to the hook should be passed after a |
| mandatory <code>--</code> (or <code>--end-of-options</code>, see <a href="gitcli.html">gitcli(7)</a>). See |
| <a href="githooks.html">githooks(5)</a> for arguments hooks might expect (if any).</p> |
| </div> |
| </dd> |
| <dt class="hdlist1">list [-z] [--show-scope]</dt> |
| <dd> |
| <p>Print a list of hooks which will be run on <em><hook-name></em> event. If no |
| hooks are configured for that event, print a warning and return 1. |
| Use <code>-z</code> to terminate output lines with NUL instead of newlines.</p> |
| </dd> |
| </dl> |
| </div> |
| </div> |
| </div> |
| <div class="sect1"> |
| <h2 id="_options">OPTIONS</h2> |
| <div class="sectionbody"> |
| <div class="dlist"> |
| <dl> |
| <dt class="hdlist1">--allow-unknown-hook-name</dt> |
| <dd> |
| <p>By default <code>git</code> <code>hook</code> <code>run</code> and <code>git</code> <code>hook</code> <code>list</code> will bail out when |
| <em><hook-name></em> is not a hook event known to Git (see <a href="githooks.html">githooks(5)</a> |
| for the list of known hooks). This is meant to help catch typos |
| such as <code>prereceive</code> when <code>pre-receive</code> was intended. Pass this |
| flag to allow unknown hook names.</p> |
| </dd> |
| <dt class="hdlist1">--to-stdin</dt> |
| <dd> |
| <p>For "run"; specify a file which will be streamed into the |
| hook’s stdin. The hook will receive the entire file from |
| beginning to EOF.</p> |
| </dd> |
| <dt class="hdlist1">--ignore-missing</dt> |
| <dd> |
| <p>Ignore any missing hook by quietly returning zero. Used for |
| tools that want to do a blind one-shot run of a hook that may |
| or may not be present.</p> |
| </dd> |
| <dt class="hdlist1">-z</dt> |
| <dd> |
| <p>Terminate "list" output lines with NUL instead of newlines.</p> |
| </dd> |
| <dt class="hdlist1">--show-scope</dt> |
| <dd> |
| <p>For "list"; prefix each configured hook’s friendly name with a |
| tab-separated config scope (e.g. <code>local</code>, <code>global</code>, <code>system</code>), |
| mirroring the output style of <code>git</code> <code>config</code> <code>--show-scope</code>. Traditional |
| hooks from the hookdir are unaffected.</p> |
| </dd> |
| <dt class="hdlist1">-j</dt> |
| <dt class="hdlist1">--jobs</dt> |
| <dd> |
| <p>Only valid for <code>run</code>.</p> |
| <div class="paragraph"> |
| <p>Specify how many hooks to run simultaneously. If this flag is not specified, |
| the value of the <code>hook.jobs</code> config is used, see <a href="git-config.html">git-config(1)</a>. If |
| neither is specified, defaults to 1 (serial execution).</p> |
| </div> |
| <div class="paragraph"> |
| <p>When greater than 1, it overrides the per-hook <code>hook.</code><em><friendly-name></em><code>.parallel</code> |
| setting, allowing all hooks for the event to run concurrently, even if they |
| are not individually marked as parallel.</p> |
| </div> |
| <div class="paragraph"> |
| <p>Some hooks always run sequentially regardless of this flag or the |
| <code>hook.jobs</code> config, because git knows they cannot safely run in parallel: |
| <code>applypatch-msg</code>, <code>pre-commit</code>, <code>prepare-commit-msg</code>, <code>commit-msg</code>, |
| <code>post-commit</code>, <code>post-checkout</code>, and <code>push-to-checkout</code>.</p> |
| </div> |
| </dd> |
| </dl> |
| </div> |
| </div> |
| </div> |
| <div class="sect1"> |
| <h2 id="_wrappers">WRAPPERS</h2> |
| <div class="sectionbody"> |
| <div class="paragraph"> |
| <p><code>git</code> <code>hook</code> <code>run</code> has been designed to make it easy for tools which wrap Git to |
| configure and execute hooks using the Git hook infrastructure. It is possible to |
| provide arguments and stdin via the command line, as well as specifying parallel |
| or series execution if the user has provided multiple hooks.</p> |
| </div> |
| <div class="paragraph"> |
| <p>Assuming your wrapper wants to support a hook named "mywrapper-start-tests", you |
| can have your users specify their hooks like so:</p> |
| </div> |
| <div class="literalblock"> |
| <div class="content"> |
| <pre>[hook "setup-test-dashboard"] |
| event = mywrapper-start-tests |
| command = ~/mywrapper/setup-dashboard.py --tap</pre> |
| </div> |
| </div> |
| <div class="paragraph"> |
| <p>Then, in your <em>mywrapper</em> tool, you can invoke any users' configured hooks by |
| running:</p> |
| </div> |
| <div class="listingblock"> |
| <div class="content"> |
| <pre>git hook run --allow-unknown-hook-name mywrapper-start-tests \ |
| # providing something to stdin |
| --stdin some-tempfile-123 \ |
| # execute multiple hooks in parallel |
| --jobs 3 \ |
| # plus some arguments of your own... |
| -- \ |
| --testname bar \ |
| baz</pre> |
| </div> |
| </div> |
| <div class="paragraph"> |
| <p>Take care to name your wrapper’s hook events in a way which is unlikely to |
| overlap with Git’s native hooks (see <a href="githooks.html">githooks(5)</a>) - a hook event named |
| <code>mywrappertool-validate-commit</code> is much less likely to be added to native Git |
| than a hook event named <code>validate-commit</code>. If Git begins to use a hook event |
| named the same thing as your wrapper hook, it may invoke your users' hooks in |
| unintended and unsupported ways.</p> |
| </div> |
| </div> |
| </div> |
| <div class="sect1"> |
| <h2 id="_configuration">CONFIGURATION</h2> |
| <div class="sectionbody"> |
| <div class="dlist"> |
| <dl> |
| <dt class="hdlist1">hook.<friendly-name>.command</dt> |
| <dd> |
| <p>The command to execute for <code>hook.</code><em><friendly-name></em>. <em><friendly-name></em> |
| is a unique name that identifies this hook. The hook events that |
| trigger the command are configured with <code>hook.</code><em><friendly-name></em><code>.event</code>. |
| The value can be an executable path or a shell oneliner. If more than |
| one value is specified for the same <em><friendly-name></em>, only the last |
| value parsed is used. See <a href="git-hook.html">git-hook(1)</a>.</p> |
| </dd> |
| <dt class="hdlist1">hook.<friendly-name>.event</dt> |
| <dd> |
| <p>The hook events that trigger <code>hook.</code><em><friendly-name></em>. The value is the |
| name of a hook event, like "pre-commit" or "update". (See |
| <a href="githooks.html">githooks(5)</a> for a complete list of hook events.) On the |
| specified event, the associated <code>hook.</code><em><friendly-name></em><code>.command</code> is executed. |
| This is a multi-valued key. To run <code>hook.</code><em><friendly-name></em> on multiple |
| events, specify the key more than once. An empty value resets |
| the list of events, clearing any previously defined events for |
| <code>hook.</code><em><friendly-name></em>. See <a href="git-hook.html">git-hook(1)</a>.</p> |
| <div class="paragraph"> |
| <p>The <em><friendly-name></em> must not be the same as a known hook event name |
| (e.g. do not use <code>hook.pre-commit.event</code>). Using a known event name as |
| a friendly-name is a fatal error because it creates an ambiguity with |
| <code>hook.</code><em><event></em><code>.enabled</code> and <code>hook.</code><em><event></em><code>.jobs</code>. For unknown event names, |
| a warning is issued when <em><friendly-name></em> matches the event value.</p> |
| </div> |
| </dd> |
| <dt class="hdlist1">hook.<friendly-name>.enabled</dt> |
| <dd> |
| <p>Whether the hook <code>hook.</code><em><friendly-name></em> is enabled. Defaults to <code>true</code>. |
| Set to <code>false</code> to disable the hook without removing its |
| configuration. This is particularly useful when a hook is defined |
| in a system or global config file and needs to be disabled for a |
| specific repository. See <a href="git-hook.html">git-hook(1)</a>.</p> |
| </dd> |
| <dt class="hdlist1">hook.<friendly-name>.parallel</dt> |
| <dd> |
| <p>Whether the hook <code>hook.</code><em><friendly-name></em> may run in parallel with other hooks |
| for the same event. Defaults to <code>false</code>. Set to <code>true</code> only when the |
| hook script is safe to run concurrently with other hooks for the same |
| event. If any hook for an event does not have this set to <code>true</code>, |
| all hooks for that event run sequentially regardless of <code>hook.jobs</code>. |
| Only configured (named) hooks need to declare this. Traditional hooks |
| found in the hooks directory do not need to, and run in parallel when |
| the effective job count is greater than 1. See <a href="git-hook.html">git-hook(1)</a>.</p> |
| </dd> |
| <dt class="hdlist1">hook.<event>.enabled</dt> |
| <dd> |
| <p>Switch to enable or disable all hooks for the <em><event></em> hook event. |
| When set to <code>false</code>, no hooks fire for that event, regardless of any |
| per-hook <code>hook.</code><em><friendly-name></em><code>.enabled</code> settings. Defaults to <code>true</code>. |
| See <a href="git-hook.html">git-hook(1)</a>.</p> |
| <div class="paragraph"> |
| <p>Note on naming: <em><event></em> must be the event name (e.g. <code>pre-commit</code>), |
| not a hook friendly-name. Since using a known event name as a |
| friendly-name is disallowed (see <code>hook.</code><em><friendly-name></em><code>.event</code> above), |
| there is no ambiguity between event-level and per-hook .<code>enabled</code> |
| settings for known events. For unknown events, if a friendly-name |
| matches the event name despite the warning, .<code>enabled</code> is treated |
| as per-hook only.</p> |
| </div> |
| </dd> |
| <dt class="hdlist1">hook.<event>.jobs</dt> |
| <dd> |
| <p>Specifies how many hooks can be run simultaneously for the <em><event></em> |
| hook event (e.g. <code>hook.post-receive.jobs</code> <code>=</code> <code>4</code>). Overrides <code>hook.jobs</code> |
| for this specific event. The same parallelism restrictions apply: this |
| setting has no effect unless all configured hooks for the event have |
| <code>hook.</code><em><friendly-name></em><code>.parallel</code> set to <code>true</code>. Set to <code>-1</code> to use the |
| number of available CPU cores. Must be a positive integer or <code>-1</code>; |
| zero is rejected with a warning. See <a href="git-hook.html">git-hook(1)</a>.</p> |
| <div class="paragraph"> |
| <p>Note on naming: although this key resembles <code>hook.</code><em><friendly-name></em><code>.*</code> |
| (a per-hook setting), <em><event></em> must be the event name, not a hook |
| friendly name. The key component is stored literally and looked up by |
| event name at runtime with no translation between the two namespaces. |
| A key like <code>hook.my-hook.jobs</code> is stored under "my-hook" but the |
| lookup at runtime uses the event name (e.g. "post-receive"), so |
| <code>hook.my-hook.jobs</code> is silently ignored even when <code>my-hook</code> is |
| registered for that event. Use <code>hook.post-receive.jobs</code> or any other |
| valid event name when setting <code>hook.</code><em><event></em><code>.jobs</code>.</p> |
| </div> |
| </dd> |
| <dt class="hdlist1">hook.jobs</dt> |
| <dd> |
| <p>Specifies how many hooks can be run simultaneously during parallelized |
| hook execution. If unspecified, defaults to 1 (serial execution). |
| Set to <code>-1</code> to use the number of available CPU cores. |
| Can be overridden on a per-event basis with <code>hook.</code><em><event></em><code>.jobs</code>. |
| Some hooks always run sequentially regardless of this setting because |
| they operate on shared data and cannot safely be parallelized:</p> |
| <div class="openblock"> |
| <div class="content"> |
| <div class="dlist"> |
| <dl> |
| <dt class="hdlist1"><code>applypatch-msg</code></dt> |
| <dt class="hdlist1"><code>prepare-commit-msg</code></dt> |
| <dt class="hdlist1"><code>commit-msg</code></dt> |
| <dd> |
| <p>Receive a commit message file and may rewrite it in place.</p> |
| </dd> |
| <dt class="hdlist1"><code>pre-commit</code></dt> |
| <dt class="hdlist1"><code>post-checkout</code></dt> |
| <dt class="hdlist1"><code>push-to-checkout</code></dt> |
| <dt class="hdlist1"><code>post-commit</code></dt> |
| <dd> |
| <p>Access the working tree, index, or repository state.</p> |
| </dd> |
| </dl> |
| </div> |
| </div> |
| </div> |
| <div class="paragraph"> |
| <p>This setting has no effect unless all configured hooks for the event have |
| <code>hook.</code><em><friendly-name></em><code>.parallel</code> set to <code>true</code>.</p> |
| </div> |
| <div class="paragraph"> |
| <p>For <code>pre-push</code> hooks, which normally keep stdout and stderr separate, |
| setting this to a value greater than 1 (or passing <code>-j</code>) will merge stdout |
| into stderr to allow correct de-interleaving of parallel output.</p> |
| </div> |
| </dd> |
| </dl> |
| </div> |
| </div> |
| </div> |
| <div class="sect1"> |
| <h2 id="_see_also">SEE ALSO</h2> |
| <div class="sectionbody"> |
| <div class="paragraph"> |
| <p><a href="githooks.html">githooks(5)</a></p> |
| </div> |
| </div> |
| </div> |
| <div class="sect1"> |
| <h2 id="_git">GIT</h2> |
| <div class="sectionbody"> |
| <div class="paragraph"> |
| <p>Part of the <a href="git.html">git(1)</a> suite</p> |
| </div> |
| </div> |
| </div> |
| </div> |
| <div id="footer"> |
| <div id="footer-text"> |
| Last updated 2026-05-11 11:04:23 +0900 |
| </div> |
| </div> |
| </body> |
| </html> |
