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