git-sh-setup.html

   1 <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.1//EN"
   2     "http://www.w3.org/TR/xhtml11/DTD/xhtml11.dtd">
   3 <html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en">
   4 <head>
   5 <meta http-equiv="Content-Type" content="text/html; charset=UTF-8" />
   6 <meta name="generator" content="AsciiDoc 8.2.5" />
   7 <style type="text/css">
   8 /* Debug borders */
   9 p, li, dt, dd, div, pre, h1, h2, h3, h4, h5, h6 {
  10 /*
  11   border: 1px solid red;
  12 */
  13 }
  14
  15 body {
  16   margin: 1em 5% 1em 5%;
  17 }
  18
  19 a {
  20   color: blue;
  21   text-decoration: underline;
  22 }
  23 a:visited {
  24   color: fuchsia;
  25 }
  26
  27 em {
  28   font-style: italic;
  29 }
  30
  31 strong {
  32   font-weight: bold;
  33 }
  34
  35 tt {
  36   color: navy;
  37 }
  38
  39 h1, h2, h3, h4, h5, h6 {
  40   color: #527bbd;
  41   font-family: sans-serif;
  42   margin-top: 1.2em;
  43   margin-bottom: 0.5em;
  44   line-height: 1.3;
  45 }
  46
  47 h1, h2, h3 {
  48   border-bottom: 2px solid silver;
  49 }
  50 h2 {
  51   padding-top: 0.5em;
  52 }
  53 h3 {
  54   float: left;
  55 }
  56 h3 + * {
  57   clear: left;
  58 }
  59
  60 div.sectionbody {
  61   font-family: serif;
  62   margin-left: 0;
  63 }
  64
  65 hr {
  66   border: 1px solid silver;
  67 }
  68
  69 p {
  70   margin-top: 0.5em;
  71   margin-bottom: 0.5em;
  72 }
  73
  74 pre {
  75   padding: 0;
  76   margin: 0;
  77 }
  78
  79 span#author {
  80   color: #527bbd;
  81   font-family: sans-serif;
  82   font-weight: bold;
  83   font-size: 1.1em;
  84 }
  85 span#email {
  86 }
  87 span#revision {
  88   font-family: sans-serif;
  89 }
  90
  91 div#footer {
  92   font-family: sans-serif;
  93   font-size: small;
  94   border-top: 2px solid silver;
  95   padding-top: 0.5em;
  96   margin-top: 4.0em;
  97 }
  98 div#footer-text {
  99   float: left;
 100   padding-bottom: 0.5em;
 101 }
 102 div#footer-badges {
 103   float: right;
 104   padding-bottom: 0.5em;
 105 }
 106
 107 div#preamble,
 108 div.tableblock, div.imageblock, div.exampleblock, div.verseblock,
 109 div.quoteblock, div.literalblock, div.listingblock, div.sidebarblock,
 110 div.admonitionblock {
 111   margin-right: 10%;
 112   margin-top: 1.5em;
 113   margin-bottom: 1.5em;
 114 }
 115 div.admonitionblock {
 116   margin-top: 2.5em;
 117   margin-bottom: 2.5em;
 118 }
 119
 120 div.content { /* Block element content. */
 121   padding: 0;
 122 }
 123
 124 /* Block element titles. */
 125 div.title, caption.title {
 126   font-family: sans-serif;
 127   font-weight: bold;
 128   text-align: left;
 129   margin-top: 1.0em;
 130   margin-bottom: 0.5em;
 131 }
 132 div.title + * {
 133   margin-top: 0;
 134 }
 135
 136 td div.title:first-child {
 137   margin-top: 0.0em;
 138 }
 139 div.content div.title:first-child {
 140   margin-top: 0.0em;
 141 }
 142 div.content + div.title {
 143   margin-top: 0.0em;
 144 }
 145
 146 div.sidebarblock > div.content {
 147   background: #ffffee;
 148   border: 1px solid silver;
 149   padding: 0.5em;
 150 }
 151
 152 div.listingblock {
 153   margin-right: 0%;
 154 }
 155 div.listingblock > div.content {
 156   border: 1px solid silver;
 157   background: #f4f4f4;
 158   padding: 0.5em;
 159 }
 160
 161 div.quoteblock > div.content {
 162   padding-left: 2.0em;
 163 }
 164
 165 div.attribution {
 166   text-align: right;
 167 }
 168 div.verseblock + div.attribution {
 169   text-align: left;
 170 }
 171
 172 div.admonitionblock .icon {
 173   vertical-align: top;
 174   font-size: 1.1em;
 175   font-weight: bold;
 176   text-decoration: underline;
 177   color: #527bbd;
 178   padding-right: 0.5em;
 179 }
 180 div.admonitionblock td.content {
 181   padding-left: 0.5em;
 182   border-left: 2px solid silver;
 183 }
 184
 185 div.exampleblock > div.content {
 186   border-left: 2px solid silver;
 187   padding: 0.5em;
 188 }
 189
 190 div.verseblock div.content {
 191   white-space: pre;
 192 }
 193
 194 div.imageblock div.content { padding-left: 0; }
 195 div.imageblock img { border: 1px solid silver; }
 196 span.image img { border-style: none; }
 197
 198 dl {
 199   margin-top: 0.8em;
 200   margin-bottom: 0.8em;
 201 }
 202 dt {
 203   margin-top: 0.5em;
 204   margin-bottom: 0;
 205   font-style: italic;
 206 }
 207 dd > *:first-child {
 208   margin-top: 0;
 209 }
 210
 211 ul, ol {
 212     list-style-position: outside;
 213 }
 214 div.olist2 ol {
 215   list-style-type: lower-alpha;
 216 }
 217
 218 div.tableblock > table {
 219   border: 3px solid #527bbd;
 220 }
 221 thead {
 222   font-family: sans-serif;
 223   font-weight: bold;
 224 }
 225 tfoot {
 226   font-weight: bold;
 227 }
 228
 229 div.hlist {
 230   margin-top: 0.8em;
 231   margin-bottom: 0.8em;
 232 }
 233 div.hlist td {
 234   padding-bottom: 5px;
 235 }
 236 td.hlist1 {
 237   vertical-align: top;
 238   font-style: italic;
 239   padding-right: 0.8em;
 240 }
 241 td.hlist2 {
 242   vertical-align: top;
 243 }
 244
 245 @media print {
 246   div#footer-badges { display: none; }
 247 }
 248
 249 div#toctitle {
 250   color: #527bbd;
 251   font-family: sans-serif;
 252   font-size: 1.1em;
 253   font-weight: bold;
 254   margin-top: 1.0em;
 255   margin-bottom: 0.1em;
 256 }
 257
 258 div.toclevel1, div.toclevel2, div.toclevel3, div.toclevel4 {
 259   margin-top: 0;
 260   margin-bottom: 0;
 261 }
 262 div.toclevel2 {
 263   margin-left: 2em;
 264   font-size: 0.9em;
 265 }
 266 div.toclevel3 {
 267   margin-left: 4em;
 268   font-size: 0.9em;
 269 }
 270 div.toclevel4 {
 271   margin-left: 6em;
 272   font-size: 0.9em;
 273 }
 274 include1::./stylesheets/xhtml11-manpage.css[]
 275 /* Workarounds for IE6's broken and incomplete CSS2. */
 276
 277 div.sidebar-content {
 278   background: #ffffee;
 279   border: 1px solid silver;
 280   padding: 0.5em;
 281 }
 282 div.sidebar-title, div.image-title {
 283   font-family: sans-serif;
 284   font-weight: bold;
 285   margin-top: 0.0em;
 286   margin-bottom: 0.5em;
 287 }
 288
 289 div.listingblock div.content {
 290   border: 1px solid silver;
 291   background: #f4f4f4;
 292   padding: 0.5em;
 293 }
 294
 295 div.quoteblock-content {
 296   padding-left: 2.0em;
 297 }
 298
 299 div.exampleblock-content {
 300   border-left: 2px solid silver;
 301   padding-left: 0.5em;
 302 }
 303
 304 /* IE6 sets dynamically generated links as visited. */
 305 div#toc a:visited { color: blue; }
 306 </style>
 307 <title>git-sh-setup(1)</title>
 308 </head>
 309 <body>
 310 <div id="header">
 311 <h1>
 312 git-sh-setup(1) Manual Page
 313 </h1>
 314 <h2>NAME</h2>
 315 <div class="sectionbody">
 316 <p>git-sh-setup -
 317    Common git shell script setup code
 318 </p>
 319 </div>
 320 </div>
 321 <h2>SYNOPSIS</h2>
 322 <div class="sectionbody">
 323 <div class="para"><p><em>. "$(git --exec-path)/git-sh-setup"</em></p></div>
 324 </div>
 325 <h2 id="_description">DESCRIPTION</h2>
 326 <div class="sectionbody">
 327 <div class="para"><p>This is not a command the end user would want to run.  Ever.
 328 This documentation is meant for people who are studying the
 329 Porcelain-ish scripts and/or are writing new ones.</p></div>
 330 <div class="para"><p>The <em>git sh-setup</em> scriptlet is designed to be sourced (using
 331 <tt>.</tt>) by other shell scripts to set up some variables pointing at
 332 the normal git directories and a few helper shell functions.</p></div>
 333 <div class="para"><p>Before sourcing it, your script should set up a few variables;
 334 <tt>USAGE</tt> (and <tt>LONG_USAGE</tt>, if any) is used to define message
 335 given by <tt>usage()</tt> shell function.  <tt>SUBDIRECTORY_OK</tt> can be set
 336 if the script can run from a subdirectory of the working tree
 337 (some commands do not).</p></div>
 338 <div class="para"><p>The scriptlet sets <tt>GIT_DIR</tt> and <tt>GIT_OBJECT_DIRECTORY</tt> shell
 339 variables, but does <strong>not</strong> export them to the environment.</p></div>
 340 </div>
 341 <h2 id="_functions">FUNCTIONS</h2>
 342 <div class="sectionbody">
 343 <div class="vlist"><dl>
 344 <dt>
 345 die
 346 </dt>
 347 <dd>
 348 <p>
 349         exit after emitting the supplied error message to the
 350         standard error stream.
 351 </p>
 352 </dd>
 353 <dt>
 354 usage
 355 </dt>
 356 <dd>
 357 <p>
 358         die with the usage message.
 359 </p>
 360 </dd>
 361 <dt>
 362 set_reflog_action
 363 </dt>
 364 <dd>
 365 <p>
 366         set the message that will be recorded to describe the
 367         end-user action in the reflog, when the script updates a
 368         ref.
 369 </p>
 370 </dd>
 371 <dt>
 372 git_editor
 373 </dt>
 374 <dd>
 375 <p>
 376         runs an editor of user's choice (GIT_EDITOR, core.editor, VISUAL or
 377         EDITOR) on a given file, but error out if no editor is specified
 378         and the terminal is dumb.
 379 </p>
 380 </dd>
 381 <dt>
 382 is_bare_repository
 383 </dt>
 384 <dd>
 385 <p>
 386         outputs <tt>true</tt> or <tt>false</tt> to the standard output stream
 387         to indicate if the repository is a bare repository
 388         (i.e. without an associated working tree).
 389 </p>
 390 </dd>
 391 <dt>
 392 cd_to_toplevel
 393 </dt>
 394 <dd>
 395 <p>
 396         runs chdir to the toplevel of the working tree.
 397 </p>
 398 </dd>
 399 <dt>
 400 require_work_tree
 401 </dt>
 402 <dd>
 403 <p>
 404         checks if the repository is a bare repository, and dies
 405         if so.  Used by scripts that require working tree
 406         (e.g. <tt>checkout</tt>).
 407 </p>
 408 </dd>
 409 <dt>
 410 get_author_ident_from_commit
 411 </dt>
 412 <dd>
 413 <p>
 414         outputs code for use with eval to set the GIT_AUTHOR_NAME,
 415         GIT_AUTHOR_EMAIL and GIT_AUTHOR_DATE variables for a given commit.
 416 </p>
 417 </dd>
 418 </dl></div>
 419 </div>
 420 <h2 id="_author">Author</h2>
 421 <div class="sectionbody">
 422 <div class="para"><p>Written by Linus Torvalds &lt;torvalds@osdl.org&gt;</p></div>
 423 </div>
 424 <h2 id="_documentation">Documentation</h2>
 425 <div class="sectionbody">
 426 <div class="para"><p>Documentation by Junio C Hamano and the git-list &lt;git@vger.kernel.org&gt;.</p></div>
 427 </div>
 428 <h2 id="_git">GIT</h2>
 429 <div class="sectionbody">
 430 <div class="para"><p>Part of the <a href="git.html">git(1)</a> suite</p></div>
 431 </div>
 432 <div id="footer">
 433 <div id="footer-text">
 434 Last updated 2010-09-18 23:56:58 UTC
 435 </div>
 436 </div>
 437 </body>
 438 </html>