git-update-ref.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.2" />\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-update-ref(1)</title>\r
 260 </head>\r
 261 <body>\r
 262 <div id="header">\r
 263 <h1>\r
 264 git-update-ref(1) Manual Page\r
 265 </h1>\r
 266 <h2>NAME</h2>\r
 267 <div class="sectionbody">\r
 268 <p>git-update-ref -\r
 269    update the object name stored in a ref safely\r
 270 </p>\r
 271 </div>\r
 272 </div>\r
 273 <h2>SYNOPSIS</h2>\r
 274 <div class="sectionbody">\r
 275 <p><em>git-update-ref</em> &lt;ref&gt; &lt;newvalue&gt; [&lt;oldvalue&gt;]</p>\r
 276 </div>\r
 277 <h2>DESCRIPTION</h2>\r
 278 <div class="sectionbody">\r
 279 <p>Given two arguments, stores the &lt;newvalue&gt; in the &lt;ref&gt;, possibly\r
 280 dereferencing the symbolic refs.  E.g. <tt>git-update-ref HEAD\r
 281 &lt;newvalue&gt;</tt> updates the current branch head to the new object.</p>\r
 282 <p>Given three arguments, stores the &lt;newvalue&gt; in the &lt;ref&gt;,\r
 283 possibly dereferencing the symbolic refs, after verifying that\r
 284 the current value of the &lt;ref&gt; matches &lt;oldvalue&gt;.\r
 285 E.g. <tt>git-update-ref refs/heads/master &lt;newvalue&gt; &lt;oldvalue&gt;</tt>\r
 286 updates the master branch head to &lt;newvalue&gt; only if its current\r
 287 value is &lt;oldvalue&gt;.</p>\r
 288 <p>It also allows a "ref" file to be a symbolic pointer to another\r
 289 ref file by starting with the four-byte header sequence of\r
 290 "ref:".</p>\r
 291 <p>More importantly, it allows the update of a ref file to follow\r
 292 these symbolic pointers, whether they are symlinks or these\r
 293 "regular file symbolic refs".  It follows <strong>real</strong> symlinks only\r
 294 if they start with "refs/": otherwise it will just try to read\r
 295 them and update them as a regular file (i.e. it will allow the\r
 296 filesystem to follow them, but will overwrite such a symlink to\r
 297 somewhere else with a regular filename).</p>\r
 298 <p>In general, using</p>\r
 299 <div class="literalblock">\r
 300 <div class="content">\r
 301 <pre><tt>git-update-ref HEAD "$head"</tt></pre>\r
 302 </div></div>\r
 303 <p>should be a _lot_ safer than doing</p>\r
 304 <div class="literalblock">\r
 305 <div class="content">\r
 306 <pre><tt>echo "$head" &gt; "$GIT_DIR/HEAD"</tt></pre>\r
 307 </div></div>\r
 308 <p>both from a symlink following standpoint <strong>and</strong> an error checking\r
 309 standpoint.  The "refs/" rule for symlinks means that symlinks\r
 310 that point to "outside" the tree are safe: they'll be followed\r
 311 for reading but not for writing (so we'll never write through a\r
 312 ref symlink to some other tree, if you have copied a whole\r
 313 archive by creating a symlink tree).</p>\r
 314 </div>\r
 315 <h2>Author</h2>\r
 316 <div class="sectionbody">\r
 317 <p>Written by Linus Torvalds &lt;torvalds@osdl.org&gt;.</p>\r
 318 </div>\r
 319 <h2>GIT</h2>\r
 320 <div class="sectionbody">\r
 321 <p>Part of the <a href="git.html">git(7)</a> suite</p>\r
 322 </div>\r
 323 <div id="footer">\r
 324 <div id="footer-text">\r
 325 Last updated 06-Mar-2006 07:10:16 UTC\r
 326 </div>\r
 327 </div>\r
 328 </body>\r
 329 </html>\r