source: general/prog/git.xml@ 37191af

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

Sync to trunk r17270. Last round for the night.

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

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