Google Git
Sign in
chromium / external / gitster / git-htmldocs / 6a3c82713a6d40b17cafd5a3eb312fe7b25d277e / . / git-sh-setup.html
blob: 7d5a1c909afa4c46a81e78b4425078c2e1a59b84 [file] [log] [blame]
Junio C Hamano1a4e8412005-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 Hamanoba4b9282008-07-06 05:20:31[diff] [blame]6<meta name="generator" content="AsciiDoc 8.2.5" />
Junio C Hamano1a4e8412005-12-27 08:17:23[diff] [blame]7<style type="text/css">
8/* Debug borders */
9p, li, dt, dd, div, pre, h1, h2, h3, h4, h5, h6 {
10/*
11 border: 1px solid red;
12*/
13}
14
15body {
16 margin: 1em 5% 1em 5%;
17}
18
Junio C Hamanoba4b9282008-07-06 05:20:31[diff] [blame]19a {
20 color: blue;
21 text-decoration: underline;
22}
23a:visited {
24 color: fuchsia;
25}
Junio C Hamano1a4e8412005-12-27 08:17:23[diff] [blame]26
27em {
28 font-style: italic;
29}
30
31strong {
32 font-weight: bold;
33}
34
35tt {
36 color: navy;
37}
38
39h1, 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
Junio C Hamanoba4b9282008-07-06 05:20:31[diff] [blame]47h1, h2, h3 {
Junio C Hamano1a4e8412005-12-27 08:17:23[diff] [blame]48 border-bottom: 2px solid silver;
49}
50h2 {
Junio C Hamano1a4e8412005-12-27 08:17:23[diff] [blame]51 padding-top: 0.5em;
52}
Junio C Hamanoba4b9282008-07-06 05:20:31[diff] [blame]53h3 {
54 float: left;
55}
56h3 + * {
57 clear: left;
58}
Junio C Hamano1a4e8412005-12-27 08:17:23[diff] [blame]59
60div.sectionbody {
61 font-family: serif;
62 margin-left: 0;
63}
64
65hr {
66 border: 1px solid silver;
67}
68
69p {
70 margin-top: 0.5em;
71 margin-bottom: 0.5em;
72}
73
74pre {
75 padding: 0;
76 margin: 0;
77}
78
79span#author {
80 color: #527bbd;
81 font-family: sans-serif;
82 font-weight: bold;
Junio C Hamanoba4b9282008-07-06 05:20:31[diff] [blame]83 font-size: 1.1em;
Junio C Hamano1a4e8412005-12-27 08:17:23[diff] [blame]84}
85span#email {
86}
87span#revision {
88 font-family: sans-serif;
89}
90
91div#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}
98div#footer-text {
99 float: left;
100 padding-bottom: 0.5em;
101}
102div#footer-badges {
103 float: right;
104 padding-bottom: 0.5em;
105}
106
107div#preamble,
108div.tableblock, div.imageblock, div.exampleblock, div.verseblock,
109div.quoteblock, div.literalblock, div.listingblock, div.sidebarblock,
110div.admonitionblock {
111 margin-right: 10%;
112 margin-top: 1.5em;
113 margin-bottom: 1.5em;
114}
115div.admonitionblock {
116 margin-top: 2.5em;
117 margin-bottom: 2.5em;
118}
119
120div.content { /* Block element content. */
121 padding: 0;
122}
123
124/* Block element titles. */
125div.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}
132div.title + * {
133 margin-top: 0;
134}
135
136td div.title:first-child {
137 margin-top: 0.0em;
138}
139div.content div.title:first-child {
140 margin-top: 0.0em;
141}
142div.content + div.title {
143 margin-top: 0.0em;
144}
145
146div.sidebarblock > div.content {
147 background: #ffffee;
148 border: 1px solid silver;
149 padding: 0.5em;
150}
151
Junio C Hamanoba4b9282008-07-06 05:20:31[diff] [blame]152div.listingblock {
153 margin-right: 0%;
154}
Junio C Hamano1a4e8412005-12-27 08:17:23[diff] [blame]155div.listingblock > div.content {
156 border: 1px solid silver;
157 background: #f4f4f4;
158 padding: 0.5em;
159}
160
161div.quoteblock > div.content {
162 padding-left: 2.0em;
163}
Junio C Hamanoba4b9282008-07-06 05:20:31[diff] [blame]164
165div.attribution {
Junio C Hamano1a4e8412005-12-27 08:17:23[diff] [blame]166 text-align: right;
167}
Junio C Hamanoba4b9282008-07-06 05:20:31[diff] [blame]168div.verseblock + div.attribution {
169 text-align: left;
170}
Junio C Hamano1a4e8412005-12-27 08:17:23[diff] [blame]171
172div.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}
180div.admonitionblock td.content {
181 padding-left: 0.5em;
182 border-left: 2px solid silver;
183}
184
185div.exampleblock > div.content {
186 border-left: 2px solid silver;
187 padding: 0.5em;
188}
189
190div.verseblock div.content {
191 white-space: pre;
192}
193
194div.imageblock div.content { padding-left: 0; }
195div.imageblock img { border: 1px solid silver; }
196span.image img { border-style: none; }
197
198dl {
199 margin-top: 0.8em;
200 margin-bottom: 0.8em;
201}
202dt {
203 margin-top: 0.5em;
204 margin-bottom: 0;
205 font-style: italic;
206}
207dd > *:first-child {
208 margin-top: 0;
209}
210
211ul, ol {
212 list-style-position: outside;
213}
Junio C Hamanoba4b9282008-07-06 05:20:31[diff] [blame]214div.olist2 ol {
Junio C Hamano1a4e8412005-12-27 08:17:23[diff] [blame]215 list-style-type: lower-alpha;
216}
217
218div.tableblock > table {
Junio C Hamanoba4b9282008-07-06 05:20:31[diff] [blame]219 border: 3px solid #527bbd;
Junio C Hamano1a4e8412005-12-27 08:17:23[diff] [blame]220}
221thead {
222 font-family: sans-serif;
223 font-weight: bold;
224}
225tfoot {
226 font-weight: bold;
227}
228
229div.hlist {
230 margin-top: 0.8em;
231 margin-bottom: 0.8em;
232}
Junio C Hamanoba4b9282008-07-06 05:20:31[diff] [blame]233div.hlist td {
234 padding-bottom: 5px;
235}
Junio C Hamano1a4e8412005-12-27 08:17:23[diff] [blame]236td.hlist1 {
237 vertical-align: top;
238 font-style: italic;
239 padding-right: 0.8em;
240}
241td.hlist2 {
242 vertical-align: top;
243}
244
245@media print {
246 div#footer-badges { display: none; }
247}
Junio C Hamanoba4b9282008-07-06 05:20:31[diff] [blame]248
249div#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
258div.toclevel1, div.toclevel2, div.toclevel3, div.toclevel4 {
259 margin-top: 0;
260 margin-bottom: 0;
261}
262div.toclevel2 {
263 margin-left: 2em;
264 font-size: 0.9em;
265}
266div.toclevel3 {
267 margin-left: 4em;
268 font-size: 0.9em;
269}
270div.toclevel4 {
271 margin-left: 6em;
272 font-size: 0.9em;
273}
274include1::./stylesheets/xhtml11-manpage.css[]
Junio C Hamano1a4e8412005-12-27 08:17:23[diff] [blame]275/* Workarounds for IE6's broken and incomplete CSS2. */
276
277div.sidebar-content {
278 background: #ffffee;
279 border: 1px solid silver;
280 padding: 0.5em;
281}
282div.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
289div.listingblock div.content {
290 border: 1px solid silver;
291 background: #f4f4f4;
292 padding: 0.5em;
293}
294
295div.quoteblock-content {
296 padding-left: 2.0em;
297}
298
299div.exampleblock-content {
300 border-left: 2px solid silver;
301 padding-left: 0.5em;
302}
Junio C Hamanoba4b9282008-07-06 05:20:31[diff] [blame]303
304/* IE6 sets dynamically generated links as visited. */
305div#toc a:visited { color: blue; }
Junio C Hamano1a4e8412005-12-27 08:17:23[diff] [blame]306</style>
307<title>git-sh-setup(1)</title>
308</head>
309<body>
310<div id="header">
311<h1>
312git-sh-setup(1) Manual Page
313</h1>
314<h2>NAME</h2>
315<div class="sectionbody">
316<p>git-sh-setup -
Junio C Hamano01078922006-03-10 00:31:47[diff] [blame]317 Common git shell script setup code
Junio C Hamano1a4e8412005-12-27 08:17:23[diff] [blame]318</p>
319</div>
320</div>
321<h2>SYNOPSIS</h2>
322<div class="sectionbody">
Junio C Hamanoba4b9282008-07-06 05:20:31[diff] [blame]323<div class="para"><p><em>. "$(git --exec-path)/git-sh-setup"</em></p></div>
Junio C Hamano1a4e8412005-12-27 08:17:23[diff] [blame]324</div>
Junio C Hamanoba4b9282008-07-06 05:20:31[diff] [blame]325<h2 id="_description">DESCRIPTION</h2>
Junio C Hamano1a4e8412005-12-27 08:17:23[diff] [blame]326<div class="sectionbody">
Junio C Hamanoba4b9282008-07-06 05:20:31[diff] [blame]327<div class="para"><p>This is not a command the end user would want to run. Ever.
Junio C Hamanof9771f62007-01-17 17:42:30[diff] [blame]328This documentation is meant for people who are studying the
Junio C Hamanoba4b9282008-07-06 05:20:31[diff] [blame]329Porcelain-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
Junio C Hamanof9771f62007-01-17 17:42:30[diff] [blame]331<tt>.</tt>) by other shell scripts to set up some variables pointing at
Junio C Hamanoba4b9282008-07-06 05:20:31[diff] [blame]332the 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;
Junio C Hamanof9771f62007-01-17 17:42:30[diff] [blame]334<tt>USAGE</tt> (and <tt>LONG_USAGE</tt>, if any) is used to define message
335given by <tt>usage()</tt> shell function. <tt>SUBDIRECTORY_OK</tt> can be set
336if the script can run from a subdirectory of the working tree
Junio C Hamanoba4b9282008-07-06 05:20:31[diff] [blame]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
339variables, but does <strong>not</strong> export them to the environment.</p></div>
Junio C Hamanof9771f62007-01-17 17:42:30[diff] [blame]340</div>
Junio C Hamanoba4b9282008-07-06 05:20:31[diff] [blame]341<h2 id="_functions">FUNCTIONS</h2>
Junio C Hamanof9771f62007-01-17 17:42:30[diff] [blame]342<div class="sectionbody">
Junio C Hamanoba4b9282008-07-06 05:20:31[diff] [blame]343<div class="vlist"><dl>
Junio C Hamanof9771f62007-01-17 17:42:30[diff] [blame]344<dt>
345die
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>
354usage
355</dt>
356<dd>
357<p>
358 die with the usage message.
359</p>
360</dd>
361<dt>
362set_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>
Junio C Hamano91baf102007-12-31 09:44:26[diff] [blame]372git_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>
Junio C Hamanof9771f62007-01-17 17:42:30[diff] [blame]382is_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>
392cd_to_toplevel
393</dt>
394<dd>
395<p>
396 runs chdir to the toplevel of the working tree.
397</p>
398</dd>
399<dt>
400require_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>
Junio C Hamano91baf102007-12-31 09:44:26[diff] [blame]409<dt>
410get_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>
Junio C Hamanoba4b9282008-07-06 05:20:31[diff] [blame]418</dl></div>
Junio C Hamano1a4e8412005-12-27 08:17:23[diff] [blame]419</div>
Junio C Hamanoba4b9282008-07-06 05:20:31[diff] [blame]420<h2 id="_author">Author</h2>
Junio C Hamano1a4e8412005-12-27 08:17:23[diff] [blame]421<div class="sectionbody">
Junio C Hamanoba4b9282008-07-06 05:20:31[diff] [blame]422<div class="para"><p>Written by Linus Torvalds &lt;torvalds@osdl.org&gt;</p></div>
Junio C Hamano1a4e8412005-12-27 08:17:23[diff] [blame]423</div>
Junio C Hamanoba4b9282008-07-06 05:20:31[diff] [blame]424<h2 id="_documentation">Documentation</h2>
Junio C Hamano1a4e8412005-12-27 08:17:23[diff] [blame]425<div class="sectionbody">
Junio C Hamanoba4b9282008-07-06 05:20:31[diff] [blame]426<div class="para"><p>Documentation by Junio C Hamano and the git-list &lt;git@vger.kernel.org&gt;.</p></div>
Junio C Hamano1a4e8412005-12-27 08:17:23[diff] [blame]427</div>
Junio C Hamanoba4b9282008-07-06 05:20:31[diff] [blame]428<h2 id="_git">GIT</h2>
Junio C Hamano1a4e8412005-12-27 08:17:23[diff] [blame]429<div class="sectionbody">
Junio C Hamanoba4b9282008-07-06 05:20:31[diff] [blame]430<div class="para"><p>Part of the <a href="git.html">git(1)</a> suite</p></div>
Junio C Hamano1a4e8412005-12-27 08:17:23[diff] [blame]431</div>
432<div id="footer">
433<div id="footer-text">
Junio C Hamanoec87f522008-12-10 08:35:25[diff] [blame]434Last updated 2008-12-10 08:33:27 UTC
Junio C Hamano1a4e8412005-12-27 08:17:23[diff] [blame]435</div>
436</div>
437</body>
438</html>