source: general/prog/git.xml@ 130e7e1

systemd-13485
Last change on this file since 130e7e1 was 130e7e1, checked in by Douglas R. Reno <renodr@…>, 8 years ago

(systemd) LFS79 Tags
(systemd) GCC6 tags

git-svn-id: svn://svn.linuxfromscratch.org/BLFS/branches/systemd@17405 af4574ff-66df-0310-9fd7-8a98e5e911e0

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