OSDN Git Service

Add Git official document to help
[tortoisegit/TortoiseGitJp.git] / doc / source / en / TortoiseGit / git_doc / git-sh-setup.html.xml
1 <?xml version="1.0" encoding="UTF-8"?>\r
2 <!DOCTYPE article PUBLIC "-//OASIS//DTD DocBook XML V4.2//EN" "http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd">\r
3 \r
4 <article lang="en" id="git-sh-setup(1)">\r
5 <articleinfo>\r
6     <title>git-sh-setup(1)</title>\r
7         <indexterm>\r
8                 <primary>git-sh-setup(1)</primary>\r
9         </indexterm>\r
10 </articleinfo>\r
11 <simplesect id="_name">\r
12 <title>NAME</title>\r
13 <simpara>git-sh-setup - Common git shell script setup code</simpara>\r
14 </simplesect>\r
15 <simplesect id="_synopsis">\r
16 <title>SYNOPSIS</title>\r
17 <simpara><emphasis>. "$(git --exec-path)/git-sh-setup"</emphasis></simpara>\r
18 </simplesect>\r
19 <simplesect id="_description">\r
20 <title>DESCRIPTION</title>\r
21 <simpara>This is not a command the end user would want to run.  Ever.\r
22 This documentation is meant for people who are studying the\r
23 Porcelain-ish scripts and/or are writing new ones.</simpara>\r
24 <simpara>The <emphasis>git-sh-setup</emphasis> scriptlet is designed to be sourced (using\r
25 <literal>.</literal>) by other shell scripts to set up some variables pointing at\r
26 the normal git directories and a few helper shell functions.</simpara>\r
27 <simpara>Before sourcing it, your script should set up a few variables;\r
28 <literal>USAGE</literal> (and <literal>LONG_USAGE</literal>, if any) is used to define message\r
29 given by <literal>usage()</literal> shell function.  <literal>SUBDIRECTORY_OK</literal> can be set\r
30 if the script can run from a subdirectory of the working tree\r
31 (some commands do not).</simpara>\r
32 <simpara>The scriptlet sets <literal>GIT_DIR</literal> and <literal>GIT_OBJECT_DIRECTORY</literal> shell\r
33 variables, but does <emphasis role="strong">not</emphasis> export them to the environment.</simpara>\r
34 </simplesect>\r
35 <simplesect id="_functions">\r
36 <title>FUNCTIONS</title>\r
37 <variablelist>\r
38 <varlistentry>\r
39 <term>\r
40 die\r
41 </term>\r
42 <listitem>\r
43 <simpara>\r
44         exit after emitting the supplied error message to the\r
45         standard error stream.\r
46 </simpara>\r
47 </listitem>\r
48 </varlistentry>\r
49 <varlistentry>\r
50 <term>\r
51 usage\r
52 </term>\r
53 <listitem>\r
54 <simpara>\r
55         die with the usage message.\r
56 </simpara>\r
57 </listitem>\r
58 </varlistentry>\r
59 <varlistentry>\r
60 <term>\r
61 set_reflog_action\r
62 </term>\r
63 <listitem>\r
64 <simpara>\r
65         set the message that will be recorded to describe the\r
66         end-user action in the reflog, when the script updates a\r
67         ref.\r
68 </simpara>\r
69 </listitem>\r
70 </varlistentry>\r
71 <varlistentry>\r
72 <term>\r
73 git_editor\r
74 </term>\r
75 <listitem>\r
76 <simpara>\r
77         runs an editor of user&#8217;s choice (GIT_EDITOR, core.editor, VISUAL or\r
78         EDITOR) on a given file, but error out if no editor is specified\r
79         and the terminal is dumb.\r
80 </simpara>\r
81 </listitem>\r
82 </varlistentry>\r
83 <varlistentry>\r
84 <term>\r
85 is_bare_repository\r
86 </term>\r
87 <listitem>\r
88 <simpara>\r
89         outputs <literal>true</literal> or <literal>false</literal> to the standard output stream\r
90         to indicate if the repository is a bare repository\r
91         (i.e. without an associated working tree).\r
92 </simpara>\r
93 </listitem>\r
94 </varlistentry>\r
95 <varlistentry>\r
96 <term>\r
97 cd_to_toplevel\r
98 </term>\r
99 <listitem>\r
100 <simpara>\r
101         runs chdir to the toplevel of the working tree.\r
102 </simpara>\r
103 </listitem>\r
104 </varlistentry>\r
105 <varlistentry>\r
106 <term>\r
107 require_work_tree\r
108 </term>\r
109 <listitem>\r
110 <simpara>\r
111         checks if the repository is a bare repository, and dies\r
112         if so.  Used by scripts that require working tree\r
113         (e.g. <literal>checkout</literal>).\r
114 </simpara>\r
115 </listitem>\r
116 </varlistentry>\r
117 <varlistentry>\r
118 <term>\r
119 get_author_ident_from_commit\r
120 </term>\r
121 <listitem>\r
122 <simpara>\r
123         outputs code for use with eval to set the GIT_AUTHOR_NAME,\r
124         GIT_AUTHOR_EMAIL and GIT_AUTHOR_DATE variables for a given commit.\r
125 </simpara>\r
126 </listitem>\r
127 </varlistentry>\r
128 </variablelist>\r
129 </simplesect>\r
130 <simplesect id="_author">\r
131 <title>Author</title>\r
132 <simpara>Written by Linus Torvalds &lt;<ulink url="mailto:torvalds@osdl.org">torvalds@osdl.org</ulink>&gt;</simpara>\r
133 </simplesect>\r
134 <simplesect id="_documentation">\r
135 <title>Documentation</title>\r
136 <simpara>Documentation by Junio C Hamano and the git-list &lt;<ulink url="mailto:git@vger.kernel.org">git@vger.kernel.org</ulink>&gt;.</simpara>\r
137 </simplesect>\r
138 <simplesect id="_git">\r
139 <title>GIT</title>\r
140 <simpara>Part of the <xref linkend="git(1)"/> suite</simpara>\r
141 </simplesect>\r
142 </article>\r