source: general/prog/git.xml@ ac38e9dc

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

Import back into SVN from Github

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

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