1 | <?xml version="1.0" encoding="ISO-8859-1"?>
|
---|
2 | <!DOCTYPE sect1 PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN"
|
---|
3 | "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd" [
|
---|
4 | <!ENTITY % general-entities SYSTEM "../../general.ent">
|
---|
5 | %general-entities;
|
---|
6 |
|
---|
7 | <!ENTITY git-root "&kernel-dl;/software/scm/git" >
|
---|
8 |
|
---|
9 | <!ENTITY git-download-http "&git-root;/git-&git-version;.tar.xz">
|
---|
10 | <!ENTITY git-download-ftp " ">
|
---|
11 | <!ENTITY git-md5sum "7a668403aa7807d0db37e8573299d471">
|
---|
12 | <!ENTITY git-size "4.9 MB">
|
---|
13 | <!-- using gcc-8.1 the build and install are much bigger than with gcc-7.3 -->
|
---|
14 | <!ENTITY git-buildsize "291 MB (with downloaded documentation)">
|
---|
15 | <!ENTITY git-time "0.3 SBU (with parallelism=4; add 4.4 SBU for tests)">
|
---|
16 | ]>
|
---|
17 |
|
---|
18 | <sect1 id="git" xreflabel="git-&git-version;">
|
---|
19 | <?dbhtml filename="git.html"?>
|
---|
20 |
|
---|
21 | <sect1info>
|
---|
22 | <othername>$LastChangedBy$</othername>
|
---|
23 | <date>$Date$</date>
|
---|
24 | </sect1info>
|
---|
25 |
|
---|
26 | <title>Git-&git-version;</title>
|
---|
27 |
|
---|
28 | <indexterm zone="git">
|
---|
29 | <primary sortas="a-Git">Git</primary>
|
---|
30 | </indexterm>
|
---|
31 |
|
---|
32 | <sect2 role="package">
|
---|
33 | <title>Introduction to Git</title>
|
---|
34 |
|
---|
35 | <para>
|
---|
36 | <application>Git</application> is a free and open source, distributed
|
---|
37 | version control system designed to handle everything from small to very
|
---|
38 | large projects with speed and efficiency. Every
|
---|
39 | <application>Git</application> clone is a full-fledged repository with
|
---|
40 | complete history and full revision tracking capabilities, not dependent
|
---|
41 | on network access or a central server. Branching and merging are fast and
|
---|
42 | easy to do. <application>Git</application> is used for version control of
|
---|
43 | files, much like tools such as <xref linkend="mercurial"/>,
|
---|
44 | <application>Bazaar</application>, <xref linkend="subversion"/>,
|
---|
45 | <ulink url="http://www.nongnu.org/cvs/">CVS</ulink>,
|
---|
46 | <application>Perforce</application>, and
|
---|
47 | <application>Team Foundation Server</application>.
|
---|
48 | </para>
|
---|
49 |
|
---|
50 | &lfs83_checked;
|
---|
51 |
|
---|
52 | <bridgehead renderas="sect3">Package Information</bridgehead>
|
---|
53 | <itemizedlist spacing="compact">
|
---|
54 | <listitem>
|
---|
55 | <para>
|
---|
56 | Download (HTTP): <ulink url="&git-download-http;"/>
|
---|
57 | </para>
|
---|
58 | </listitem>
|
---|
59 | <listitem>
|
---|
60 | <para>
|
---|
61 | Download (FTP): <ulink url="&git-download-ftp;"/>
|
---|
62 | </para>
|
---|
63 | </listitem>
|
---|
64 | <listitem>
|
---|
65 | <para>
|
---|
66 | Download MD5 sum: &git-md5sum;
|
---|
67 | </para>
|
---|
68 | </listitem>
|
---|
69 | <listitem>
|
---|
70 | <para>
|
---|
71 | Download size: &git-size;
|
---|
72 | </para>
|
---|
73 | </listitem>
|
---|
74 | <listitem>
|
---|
75 | <para>
|
---|
76 | Estimated disk space required: &git-buildsize;
|
---|
77 | </para>
|
---|
78 | </listitem>
|
---|
79 | <listitem>
|
---|
80 | <para>
|
---|
81 | Estimated build time: &git-time;
|
---|
82 | </para>
|
---|
83 | </listitem>
|
---|
84 | </itemizedlist>
|
---|
85 |
|
---|
86 | <bridgehead renderas="sect3">Additional Downloads</bridgehead>
|
---|
87 | <itemizedlist spacing="compact">
|
---|
88 | <listitem>
|
---|
89 | <para>
|
---|
90 | <ulink url="&git-root;/git-manpages-&git-version;.tar.xz">
|
---|
91 | &git-root;/git-manpages-&git-version;.tar.xz</ulink>
|
---|
92 | (not needed if you've installed <xref linkend="asciidoc"/>,
|
---|
93 | <xref linkend="xmlto"/>, and prefer to rebuild them)
|
---|
94 | </para>
|
---|
95 | </listitem>
|
---|
96 | <listitem>
|
---|
97 | <para>
|
---|
98 | <ulink url="&git-root;/git-htmldocs-&git-version;.tar.xz">
|
---|
99 | &git-root;/git-htmldocs-&git-version;.tar.xz</ulink>
|
---|
100 | and other docs (not needed if you've installed
|
---|
101 | <xref linkend="asciidoc"/> and want to rebuild the documentation).
|
---|
102 | </para>
|
---|
103 | </listitem>
|
---|
104 | </itemizedlist>
|
---|
105 |
|
---|
106 | <bridgehead renderas="sect3">Git Dependencies</bridgehead>
|
---|
107 |
|
---|
108 | <bridgehead renderas="sect4">Recommended</bridgehead>
|
---|
109 | <para role="recommended">
|
---|
110 | <xref linkend="curl"/> (needed to use <application>Git</application> over http,
|
---|
111 | https, ftp or ftps),
|
---|
112 | <xref linkend="perl-error"/>, and
|
---|
113 | <xref linkend="python2"/>
|
---|
114 | </para>
|
---|
115 |
|
---|
116 | <bridgehead renderas="sect4">Optional</bridgehead>
|
---|
117 | <para role="optional">
|
---|
118 | <xref linkend="pcre2"/> (<emphasis>or</emphasis> the deprecated <xref
|
---|
119 | linkend="pcre"/>), in either case configured with
|
---|
120 | <literal>--enable-jit</literal>,
|
---|
121 | <xref linkend="subversion"/> with Perl bindings (for <command>git svn</command>),
|
---|
122 | <xref role="runtime" linkend="tk"/>
|
---|
123 | (gitk, a simple <application>Git</application>
|
---|
124 | repository viewer, uses <application>Tk</application> at runtime), and
|
---|
125 | <xref linkend="valgrind"/>
|
---|
126 | </para>
|
---|
127 |
|
---|
128 | <bridgehead renderas="sect4">Optional (to create the man pages, html docs
|
---|
129 | and other docs)</bridgehead>
|
---|
130 | <para role="optional">
|
---|
131 | <xref linkend="xmlto"/> and
|
---|
132 | <xref linkend="asciidoc"/> or
|
---|
133 | <ulink url="http://asciidoctor.org/">AsciiDoctor</ulink>, and also
|
---|
134 | <ulink url="http://dblatex.sourceforge.net/">dblatex</ulink>
|
---|
135 | (for the PDF version of the user manual), and
|
---|
136 | <ulink url="http://docbook2x.sourceforge.net/">docbook2x</ulink> to
|
---|
137 | create info pages
|
---|
138 | </para>
|
---|
139 |
|
---|
140 | <para condition="html" role="usernotes">User Notes:
|
---|
141 | <ulink url="&blfs-wiki;/git"/>
|
---|
142 | </para>
|
---|
143 | </sect2>
|
---|
144 |
|
---|
145 | <sect2 role="installation">
|
---|
146 | <title>Installation of Git</title>
|
---|
147 |
|
---|
148 | <para>
|
---|
149 | Install <application>Git</application> by running the following
|
---|
150 | commands:
|
---|
151 | </para>
|
---|
152 |
|
---|
153 | <screen><userinput>./configure --prefix=/usr --with-gitconfig=/etc/gitconfig &&
|
---|
154 | make</userinput></screen>
|
---|
155 |
|
---|
156 | <para>
|
---|
157 | You can build the man pages and/or html docs, or
|
---|
158 | use downloaded ones. If you choose to build them, use next two following
|
---|
159 | instructions.
|
---|
160 | </para>
|
---|
161 |
|
---|
162 | <para>
|
---|
163 | If you have installed <xref linkend="asciidoc"/> you can
|
---|
164 | create the html version of the man pages and other docs:
|
---|
165 | </para>
|
---|
166 |
|
---|
167 | <screen><userinput>make html</userinput></screen>
|
---|
168 |
|
---|
169 | <para>
|
---|
170 | If you have installed <xref linkend="asciidoc"/> and
|
---|
171 | <xref linkend="xmlto"/> you can create the man pages:
|
---|
172 | </para>
|
---|
173 |
|
---|
174 | <screen><userinput>make man</userinput></screen>
|
---|
175 |
|
---|
176 | <para>
|
---|
177 | The test suite can be run in parallel mode. To run the test suite, issue:
|
---|
178 | <command>make test</command>. If run as a normal user, 0 tests should be
|
---|
179 | reported as failed in the final summary.
|
---|
180 | </para>
|
---|
181 |
|
---|
182 | <para>
|
---|
183 | Now, as the <systemitem class="username">root</systemitem>
|
---|
184 | user:
|
---|
185 | </para>
|
---|
186 |
|
---|
187 | <screen role="root"><userinput>make install</userinput></screen>
|
---|
188 |
|
---|
189 | <!-- ==== Method 1 for docs ====== -->
|
---|
190 | <bridgehead renderas="sect3">If you created the man pages and/or html docs</bridgehead>
|
---|
191 |
|
---|
192 | <para>
|
---|
193 | Install the man pages as
|
---|
194 | <systemitem class="username">root</systemitem> user:
|
---|
195 | </para>
|
---|
196 |
|
---|
197 | <screen role="root"><userinput>make install-man</userinput></screen>
|
---|
198 |
|
---|
199 | <para>
|
---|
200 | Install the html docs as
|
---|
201 | <systemitem class="username">root</systemitem> user:
|
---|
202 | </para>
|
---|
203 |
|
---|
204 | <screen role="root"><userinput>make htmldir=/usr/share/doc/git-&git-version; install-html</userinput></screen>
|
---|
205 |
|
---|
206 | <!-- ==== Method 2 for docs ====== -->
|
---|
207 | <bridgehead renderas="sect3">If you downloaded the man pages and/or html docs</bridgehead>
|
---|
208 |
|
---|
209 | <para>
|
---|
210 | If you downloaded the man pages untar them as the
|
---|
211 | <systemitem class="username">root</systemitem> user:
|
---|
212 | </para>
|
---|
213 |
|
---|
214 | <screen role="root"><userinput>tar -xf ../git-manpages-&git-version;.tar.xz \
|
---|
215 | -C /usr/share/man --no-same-owner --no-overwrite-dir</userinput></screen>
|
---|
216 |
|
---|
217 | <para>
|
---|
218 | If you downloaded the html docs untar them as the
|
---|
219 | <systemitem class="username">root</systemitem> user:
|
---|
220 | </para>
|
---|
221 |
|
---|
222 | <screen role="root"><userinput>mkdir -vp /usr/share/doc/git-&git-version; &&
|
---|
223 | tar -xf ../git-htmldocs-&git-version;.tar.xz \
|
---|
224 | -C /usr/share/doc/git-&git-version; --no-same-owner --no-overwrite-dir &&
|
---|
225 |
|
---|
226 | find /usr/share/doc/git-&git-version; -type d -exec chmod 755 {} \; &&
|
---|
227 | find /usr/share/doc/git-&git-version; -type f -exec chmod 644 {} \;</userinput></screen>
|
---|
228 |
|
---|
229 | <!-- ==== Reorganize docs ====== -->
|
---|
230 | <bridgehead renderas="sect3">Reorganize text and html in the html-docs (both methods)</bridgehead>
|
---|
231 |
|
---|
232 | <para>
|
---|
233 | For both methods, the html-docs include a lot of plain text files.
|
---|
234 | Reorganize the files as the
|
---|
235 | <systemitem class="username">root</systemitem> user:
|
---|
236 | </para>
|
---|
237 |
|
---|
238 | <screen role="root"><userinput>mkdir -vp /usr/share/doc/git-&git-version;/man-pages/{html,text} &&
|
---|
239 | mv /usr/share/doc/git-&git-version;/{git*.txt,man-pages/text} &&
|
---|
240 | mv /usr/share/doc/git-&git-version;/{git*.,index.,man-pages/}html &&
|
---|
241 |
|
---|
242 | mkdir -vp /usr/share/doc/git-&git-version;/technical/{html,text} &&
|
---|
243 | mv /usr/share/doc/git-&git-version;/technical/{*.txt,text} &&
|
---|
244 | mv /usr/share/doc/git-&git-version;/technical/{*.,}html &&
|
---|
245 |
|
---|
246 | mkdir -vp /usr/share/doc/git-&git-version;/howto/{html,text} &&
|
---|
247 | mv /usr/share/doc/git-&git-version;/howto/{*.txt,text} &&
|
---|
248 | mv /usr/share/doc/git-&git-version;/howto/{*.,}html &&
|
---|
249 |
|
---|
250 | sed -i '/^<a href=/s|howto/|&html/|' /usr/share/doc/git-&git-version;/howto-index.html &&
|
---|
251 | sed -i '/^\* link:/s|howto/|&html/|' /usr/share/doc/git-&git-version;/howto-index.txt</userinput></screen>
|
---|
252 |
|
---|
253 | </sect2>
|
---|
254 |
|
---|
255 | <sect2 role="commands">
|
---|
256 | <title>Command Explanations</title>
|
---|
257 |
|
---|
258 | <para>
|
---|
259 | <parameter>--with-gitconfig=/etc/gitconfig</parameter>: This sets
|
---|
260 | <filename>/etc/gitconfig</filename> as the file that stores
|
---|
261 | the default, system wide, <application>Git</application>
|
---|
262 | settings.
|
---|
263 | </para>
|
---|
264 |
|
---|
265 | <para>
|
---|
266 | <option>--without-python</option>: Use this switch if
|
---|
267 | <application>Python</application> is not installed.
|
---|
268 | </para>
|
---|
269 |
|
---|
270 | <para>
|
---|
271 | <option>--with-libpcre2</option>: Use this switch if
|
---|
272 | <application>PCRE2</application> is installed and has been built with
|
---|
273 | the non-default JIT enabled.
|
---|
274 | </para>
|
---|
275 |
|
---|
276 | <para>
|
---|
277 | <option>--with-libpcre</option>: As an alternative to PCRE2, use this
|
---|
278 | switch if the deprecated <application>PCRE</application> is installed
|
---|
279 | and has been built with the non-default JIT enabled.
|
---|
280 | </para>
|
---|
281 |
|
---|
282 | <para>
|
---|
283 | <command>tar -xf ../git-manpages-&git-version;.tar.gz -C
|
---|
284 | /usr/share/man --no-same-owner</command>: This untars
|
---|
285 | <filename>git-manpages-&git-version;.tar.gz</filename>. The
|
---|
286 | <option>-C</option> option makes tar change directory to
|
---|
287 | <filename class="directory">/usr/share/man</filename> before
|
---|
288 | it starts to decompress the docs. The <option>--no-same-owner</option>
|
---|
289 | option stops tar from preserving the user and group details of the
|
---|
290 | files. This is useful as that user or group may not exist on your
|
---|
291 | system; this could (potentially) be a security risk.
|
---|
292 | </para>
|
---|
293 |
|
---|
294 | <para>
|
---|
295 | <command>mv /usr/share/doc/git-&git-version; ...</command>: These
|
---|
296 | commands move some of the files into subfolders to make it easier to sort
|
---|
297 | through the docs and find what you're looking for.
|
---|
298 | </para>
|
---|
299 |
|
---|
300 | <para>
|
---|
301 | <command>find ... chmod ...</command>: These commands correct the
|
---|
302 | permissions in the shipped documentation tar file.
|
---|
303 | </para>
|
---|
304 |
|
---|
305 | </sect2>
|
---|
306 |
|
---|
307 | <sect2 role="configuration">
|
---|
308 | <title>Configuring Git</title>
|
---|
309 |
|
---|
310 | <sect3 id="git-config">
|
---|
311 | <title>Config Files</title>
|
---|
312 | <para>
|
---|
313 | <filename>~/.gitconfig</filename> and
|
---|
314 | <filename>/etc/gitconfig</filename>
|
---|
315 | </para>
|
---|
316 |
|
---|
317 | <indexterm zone="git git-config">
|
---|
318 | <primary sortas="e-AA.gitconfig">~/.gitconfig</primary>
|
---|
319 | </indexterm>
|
---|
320 |
|
---|
321 | <indexterm zone="git git-config">
|
---|
322 | <primary sortas="e-etc-gitconfig">/etc/gitconfig</primary>
|
---|
323 | </indexterm>
|
---|
324 |
|
---|
325 | </sect3>
|
---|
326 |
|
---|
327 | </sect2>
|
---|
328 |
|
---|
329 | <sect2 role="content">
|
---|
330 | <title>Contents</title>
|
---|
331 |
|
---|
332 | <segmentedlist>
|
---|
333 | <segtitle>Installed Programs</segtitle>
|
---|
334 | <segtitle>Installed Libraries</segtitle>
|
---|
335 | <segtitle>Installed Directories</segtitle>
|
---|
336 |
|
---|
337 | <seglistitem>
|
---|
338 | <seg>
|
---|
339 | git, git-receive-pack and git-upload-archive (hardlinked to each
|
---|
340 | other), git-cvsserver, git-shell, git-upload-pack, and gitk
|
---|
341 | </seg>
|
---|
342 | <seg>
|
---|
343 | None
|
---|
344 | </seg>
|
---|
345 | <seg>
|
---|
346 | /usr/lib/perl5/site_perl/<5.x.y>{,<arch>-linux/auto}/Git,
|
---|
347 | /usr/libexec/git-core and
|
---|
348 | /usr/share/{doc/git-&git-version;,git-core,git-gui,gitk,gitweb}
|
---|
349 | </seg>
|
---|
350 | </seglistitem>
|
---|
351 | </segmentedlist>
|
---|
352 |
|
---|
353 | <variablelist>
|
---|
354 | <bridgehead renderas="sect3">Short Descriptions</bridgehead>
|
---|
355 | <?dbfo list-presentation="list"?>
|
---|
356 | <?dbhtml list-presentation="table"?>
|
---|
357 |
|
---|
358 | <varlistentry id="git-prog">
|
---|
359 | <term><command>git</command></term>
|
---|
360 | <listitem>
|
---|
361 | <para>
|
---|
362 | is the stupid content tracker.
|
---|
363 | </para>
|
---|
364 | <indexterm zone="git git-prog">
|
---|
365 | <primary sortas="b-git">git</primary>
|
---|
366 | </indexterm>
|
---|
367 | </listitem>
|
---|
368 | </varlistentry>
|
---|
369 |
|
---|
370 | <varlistentry id="git-cvsserver">
|
---|
371 | <term><command>git-cvsserver</command></term>
|
---|
372 | <listitem>
|
---|
373 | <para>
|
---|
374 | is a CVS server emulator for <application>Git</application>.
|
---|
375 | </para>
|
---|
376 | <indexterm zone="git git-cvsserver">
|
---|
377 | <primary sortas="b-git-cvsserver">git-cvsserver</primary>
|
---|
378 | </indexterm>
|
---|
379 | </listitem>
|
---|
380 | </varlistentry>
|
---|
381 |
|
---|
382 | <varlistentry id="gitk">
|
---|
383 | <term><command>gitk</command></term>
|
---|
384 | <listitem>
|
---|
385 | <para>
|
---|
386 | is a graphical <application>Git</application> repository browser
|
---|
387 | (needs <xref linkend="tk"/>).
|
---|
388 | </para>
|
---|
389 | <indexterm zone="git gitk">
|
---|
390 | <primary sortas="b-gitk">gitk</primary>
|
---|
391 | </indexterm>
|
---|
392 | </listitem>
|
---|
393 | </varlistentry>
|
---|
394 |
|
---|
395 | <varlistentry id="git-receive-pack">
|
---|
396 | <term><command>git-receive-pack</command></term>
|
---|
397 | <listitem>
|
---|
398 | <para>
|
---|
399 | is invoked by <command>git send-pack</command> and updates the
|
---|
400 | repository with the information fed from the remote end.
|
---|
401 | </para>
|
---|
402 | <indexterm zone="git git-receive-pack">
|
---|
403 | <primary sortas="b-git-receive-pack">git-receive-pack</primary>
|
---|
404 | </indexterm>
|
---|
405 | </listitem>
|
---|
406 | </varlistentry>
|
---|
407 |
|
---|
408 | <varlistentry id="git-shell">
|
---|
409 | <term><command>git-shell</command></term>
|
---|
410 | <listitem>
|
---|
411 | <para>
|
---|
412 | is a login shell for SSH accounts to provide restricted Git
|
---|
413 | access.
|
---|
414 | </para>
|
---|
415 | <indexterm zone="git git-shell">
|
---|
416 | <primary sortas="b-git-shell">git-shell</primary>
|
---|
417 | </indexterm>
|
---|
418 | </listitem>
|
---|
419 | </varlistentry>
|
---|
420 |
|
---|
421 | <varlistentry id="git-upload-archive">
|
---|
422 | <term><command>git-upload-archive</command></term>
|
---|
423 | <listitem>
|
---|
424 | <para>
|
---|
425 | is invoked by <command>git archive --remote</command> and sends
|
---|
426 | a generated archive to the other end over the git protocol.
|
---|
427 | </para>
|
---|
428 | <indexterm zone="git git-upload-archive">
|
---|
429 | <primary sortas="b-git-upload-archive">git-upload-archive</primary>
|
---|
430 | </indexterm>
|
---|
431 | </listitem>
|
---|
432 | </varlistentry>
|
---|
433 |
|
---|
434 | <varlistentry id="git-upload-pack">
|
---|
435 | <term><command>git-upload-pack</command></term>
|
---|
436 | <listitem>
|
---|
437 | <para>
|
---|
438 | is invoked by <command>git fetch-pack</command>, it discovers
|
---|
439 | what objects the other side is missing, and sends them after
|
---|
440 | packing.
|
---|
441 | </para>
|
---|
442 | <indexterm zone="git git-upload-pack">
|
---|
443 | <primary sortas="b-git-upload-pack">git-upload-pack</primary>
|
---|
444 | </indexterm>
|
---|
445 | </listitem>
|
---|
446 | </varlistentry>
|
---|
447 |
|
---|
448 | </variablelist>
|
---|
449 |
|
---|
450 | </sect2>
|
---|
451 |
|
---|
452 | </sect1>
|
---|