git-receive-pack.html

   1 <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.1//EN"\r
   2     "http://www.w3.org/TR/xhtml11/DTD/xhtml11.dtd">\r
   3 <html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en">\r
   4 <head>\r
   5 <meta http-equiv="Content-Type" content="text/html; charset=UTF-8" />\r
   6 <meta name="generator" content="AsciiDoc 7.0.1" />\r
   7 <style type="text/css">\r
   8 /* Debug borders */\r
   9 p, li, dt, dd, div, pre, h1, h2, h3, h4, h5, h6 {\r
  10 /*\r
  11   border: 1px solid red;\r
  12 */\r
  13 }\r
  14 \r
  15 body {\r
  16   margin: 1em 5% 1em 5%;\r
  17 }\r
  18 \r
  19 a { color: blue; }\r
  20 a:visited { color: fuchsia; }\r
  21 \r
  22 em {\r
  23   font-style: italic;\r
  24 }\r
  25 \r
  26 strong {\r
  27   font-weight: bold;\r
  28 }\r
  29 \r
  30 tt {\r
  31   color: navy;\r
  32 }\r
  33 \r
  34 h1, h2, h3, h4, h5, h6 {\r
  35   color: #527bbd;\r
  36   font-family: sans-serif;\r
  37   margin-top: 1.2em;\r
  38   margin-bottom: 0.5em;\r
  39   line-height: 1.3;\r
  40 }\r
  41 \r
  42 h1 {\r
  43   border-bottom: 2px solid silver;\r
  44 }\r
  45 h2 {\r
  46   border-bottom: 2px solid silver;\r
  47   padding-top: 0.5em;\r
  48 }\r
  49 \r
  50 div.sectionbody {\r
  51   font-family: serif;\r
  52   margin-left: 0;\r
  53 }\r
  54 \r
  55 hr {\r
  56   border: 1px solid silver;\r
  57 }\r
  58 \r
  59 p {\r
  60   margin-top: 0.5em;\r
  61   margin-bottom: 0.5em;\r
  62 }\r
  63 \r
  64 pre {\r
  65   padding: 0;\r
  66   margin: 0;\r
  67 }\r
  68 \r
  69 span#author {\r
  70   color: #527bbd;\r
  71   font-family: sans-serif;\r
  72   font-weight: bold;\r
  73   font-size: 1.2em;\r
  74 }\r
  75 span#email {\r
  76 }\r
  77 span#revision {\r
  78   font-family: sans-serif;\r
  79 }\r
  80 \r
  81 div#footer {\r
  82   font-family: sans-serif;\r
  83   font-size: small;\r
  84   border-top: 2px solid silver;\r
  85   padding-top: 0.5em;\r
  86   margin-top: 4.0em;\r
  87 }\r
  88 div#footer-text {\r
  89   float: left;\r
  90   padding-bottom: 0.5em;\r
  91 }\r
  92 div#footer-badges {\r
  93   float: right;\r
  94   padding-bottom: 0.5em;\r
  95 }\r
  96 \r
  97 div#preamble,\r
  98 div.tableblock, div.imageblock, div.exampleblock, div.verseblock,\r
  99 div.quoteblock, div.literalblock, div.listingblock, div.sidebarblock,\r
 100 div.admonitionblock {\r
 101   margin-right: 10%;\r
 102   margin-top: 1.5em;\r
 103   margin-bottom: 1.5em;\r
 104 }\r
 105 div.admonitionblock {\r
 106   margin-top: 2.5em;\r
 107   margin-bottom: 2.5em;\r
 108 }\r
 109 \r
 110 div.content { /* Block element content. */\r
 111   padding: 0;\r
 112 }\r
 113 \r
 114 /* Block element titles. */\r
 115 div.title, caption.title {\r
 116   font-family: sans-serif;\r
 117   font-weight: bold;\r
 118   text-align: left;\r
 119   margin-top: 1.0em;\r
 120   margin-bottom: 0.5em;\r
 121 }\r
 122 div.title + * {\r
 123   margin-top: 0;\r
 124 }\r
 125 \r
 126 td div.title:first-child {\r
 127   margin-top: 0.0em;\r
 128 }\r
 129 div.content div.title:first-child {\r
 130   margin-top: 0.0em;\r
 131 }\r
 132 div.content + div.title {\r
 133   margin-top: 0.0em;\r
 134 }\r
 135 \r
 136 div.sidebarblock > div.content {\r
 137   background: #ffffee;\r
 138   border: 1px solid silver;\r
 139   padding: 0.5em;\r
 140 }\r
 141 \r
 142 div.listingblock > div.content {\r
 143   border: 1px solid silver;\r
 144   background: #f4f4f4;\r
 145   padding: 0.5em;\r
 146 }\r
 147 \r
 148 div.quoteblock > div.content {\r
 149   padding-left: 2.0em;\r
 150 }\r
 151 div.quoteblock .attribution {\r
 152   text-align: right;\r
 153 }\r
 154 \r
 155 div.admonitionblock .icon {\r
 156   vertical-align: top;\r
 157   font-size: 1.1em;\r
 158   font-weight: bold;\r
 159   text-decoration: underline;\r
 160   color: #527bbd;\r
 161   padding-right: 0.5em;\r
 162 }\r
 163 div.admonitionblock td.content {\r
 164   padding-left: 0.5em;\r
 165   border-left: 2px solid silver;\r
 166 }\r
 167 \r
 168 div.exampleblock > div.content {\r
 169   border-left: 2px solid silver;\r
 170   padding: 0.5em;\r
 171 }\r
 172 \r
 173 div.verseblock div.content {\r
 174   white-space: pre;\r
 175 }\r
 176 \r
 177 div.imageblock div.content { padding-left: 0; }\r
 178 div.imageblock img { border: 1px solid silver; }\r
 179 span.image img { border-style: none; }\r
 180 \r
 181 dl {\r
 182   margin-top: 0.8em;\r
 183   margin-bottom: 0.8em;\r
 184 }\r
 185 dt {\r
 186   margin-top: 0.5em;\r
 187   margin-bottom: 0;\r
 188   font-style: italic;\r
 189 }\r
 190 dd > *:first-child {\r
 191   margin-top: 0;\r
 192 }\r
 193 \r
 194 ul, ol {\r
 195     list-style-position: outside;\r
 196 }\r
 197 ol.olist2 {\r
 198   list-style-type: lower-alpha;\r
 199 }\r
 200 \r
 201 div.tableblock > table {\r
 202   border-color: #527bbd;\r
 203   border-width: 3px;\r
 204 }\r
 205 thead {\r
 206   font-family: sans-serif;\r
 207   font-weight: bold;\r
 208 }\r
 209 tfoot {\r
 210   font-weight: bold;\r
 211 }\r
 212 \r
 213 div.hlist {\r
 214   margin-top: 0.8em;\r
 215   margin-bottom: 0.8em;\r
 216 }\r
 217 td.hlist1 {\r
 218   vertical-align: top;\r
 219   font-style: italic;\r
 220   padding-right: 0.8em;\r
 221 }\r
 222 td.hlist2 {\r
 223   vertical-align: top;\r
 224 }\r
 225 \r
 226 @media print {\r
 227   div#footer-badges { display: none; }\r
 228 }\r
 229 include::./stylesheets/xhtml11-manpage.css[]\r
 230 /* Workarounds for IE6's broken and incomplete CSS2. */\r
 231 \r
 232 div.sidebar-content {\r
 233   background: #ffffee;\r
 234   border: 1px solid silver;\r
 235   padding: 0.5em;\r
 236 }\r
 237 div.sidebar-title, div.image-title {\r
 238   font-family: sans-serif;\r
 239   font-weight: bold;\r
 240   margin-top: 0.0em;\r
 241   margin-bottom: 0.5em;\r
 242 }\r
 243 \r
 244 div.listingblock div.content {\r
 245   border: 1px solid silver;\r
 246   background: #f4f4f4;\r
 247   padding: 0.5em;\r
 248 }\r
 249 \r
 250 div.quoteblock-content {\r
 251   padding-left: 2.0em;\r
 252 }\r
 253 \r
 254 div.exampleblock-content {\r
 255   border-left: 2px solid silver;\r
 256   padding-left: 0.5em;\r
 257 }\r
 258 </style>\r
 259 <title>git-receive-pack(1)</title>\r
 260 </head>\r
 261 <body>\r
 262 <div id="header">\r
 263 <h1>\r
 264 git-receive-pack(1) Manual Page\r
 265 </h1>\r
 266 <h2>NAME</h2>\r
 267 <div class="sectionbody">\r
 268 <p>git-receive-pack -\r
 269    Receive what is pushed into it\r
 270 </p>\r
 271 </div>\r
 272 </div>\r
 273 <h2>SYNOPSIS</h2>\r
 274 <div class="sectionbody">\r
 275 <p><em>git-receive-pack</em> &lt;directory&gt;</p>\r
 276 </div>\r
 277 <h2>DESCRIPTION</h2>\r
 278 <div class="sectionbody">\r
 279 <p>Invoked by <em>git-send-pack</em> and updates the repository with the\r
 280 information fed from the remote end.</p>\r
 281 <p>This command is usually not invoked directly by the end user.\r
 282 The UI for the protocol is on the <em>git-send-pack</em> side, and the\r
 283 program pair is meant to be used to push updates to remote\r
 284 repository.  For pull operations, see <em>git-fetch-pack</em> and\r
 285 <em>git-clone-pack</em>.</p>\r
 286 <p>The command allows for creation and fast forwarding of sha1 refs\r
 287 (heads/tags) on the remote end (strictly speaking, it is the\r
 288 local end receive-pack runs, but to the user who is sitting at\r
 289 the send-pack end, it is updating the remote.  Confused?)</p>\r
 290 <p>Before each ref is updated, if $GIT_DIR/hooks/update file exists\r
 291 and executable, it is called with three parameters:</p>\r
 292 <div class="literalblock">\r
 293 <div class="content">\r
 294 <pre><tt>$GIT_DIR/hooks/update refname sha1-old sha1-new</tt></pre>\r
 295 </div></div>\r
 296 <p>The refname parameter is relative to $GIT_DIR; e.g. for the\r
 297 master head this is "refs/heads/master".  Two sha1 are the\r
 298 object names for the refname before and after the update.  Note\r
 299 that the hook is called before the refname is updated, so either\r
 300 should match what is recorded in refname.</p>\r
 301 <p>The hook should exit with non-zero status if it wants to\r
 302 disallow updating the named ref.  Otherwise it should exit with\r
 303 zero.</p>\r
 304 <p>Using this hook, it is easy to generate mails on updates to\r
 305 the local repository. This example script sends a mail with\r
 306 the commits pushed to the repository:</p>\r
 307 <div class="literalblock">\r
 308 <div class="content">\r
 309 <pre><tt>#!/bin/sh\r
 310 # mail out commit update information.\r
 311 if expr "$2" : '0*$' &gt;/dev/null\r
 312 then\r
 313         echo "Created a new ref, with the following commits:"\r
 314         git-rev-list --pretty "$2"\r
 315 else\r
 316         echo "New commits:"\r
 317         git-rev-list --pretty "$3" "^$2"\r
 318 fi |\r
 319 mail -s "Changes to ref $1" commit-list@mydomain\r
 320 exit 0</tt></pre>\r
 321 </div></div>\r
 322 <p>Another hook $GIT_DIR/hooks/post-update, if exists and\r
 323 executable, is called with the list of refs that have been\r
 324 updated.  This can be used to implement repository wide cleanup\r
 325 task if needed.  The exit code from this hook invocation is\r
 326 ignored; the only thing left for git-receive-pack to do at that\r
 327 point is to exit itself anyway.  This hook can be used, for\r
 328 example, to run "git-update-server-info" if the repository is\r
 329 packed and is served via a dumb transport.</p>\r
 330 <div class="literalblock">\r
 331 <div class="content">\r
 332 <pre><tt>#!/bin/sh\r
 333 exec git-update-server-info</tt></pre>\r
 334 </div></div>\r
 335 <p>There are other real-world examples of using update and\r
 336 post-update hooks found in the Documentation/howto directory.</p>\r
 337 </div>\r
 338 <h2>OPTIONS</h2>\r
 339 <div class="sectionbody">\r
 340 <dl>\r
 341 <dt>\r
 342 &lt;directory&gt;\r
 343 </dt>\r
 344 <dd>\r
 345 <p>\r
 346         The repository to sync into.\r
 347 </p>\r
 348 </dd>\r
 349 </dl>\r
 350 </div>\r
 351 <h2>SEE ALSO</h2>\r
 352 <div class="sectionbody">\r
 353 <p><a href="git-send-pack.html">git-send-pack(1)</a></p>\r
 354 </div>\r
 355 <h2>Author</h2>\r
 356 <div class="sectionbody">\r
 357 <p>Written by Linus Torvalds &lt;torvalds@osdl.org&gt;</p>\r
 358 </div>\r
 359 <h2>Documentation</h2>\r
 360 <div class="sectionbody">\r
 361 <p>Documentation by Junio C Hamano.</p>\r
 362 </div>\r
 363 <h2>GIT</h2>\r
 364 <div class="sectionbody">\r
 365 <p>Part of the <a href="git.html">git(7)</a> suite</p>\r
 366 </div>\r
 367 <div id="footer">\r
 368 <div id="footer-text">\r
 369 Last updated 27-Dec-2005 00:16:33 PDT\r
 370 </div>\r
 371 </div>\r
 372 </body>\r
 373 </html>\r