source: general/prog/git.xml@ e3f97f9

10.0 10.1 11.0 11.1 11.2 11.3 12.0 12.1 7.10 7.6 7.7 7.8 7.9 8.0 8.1 8.2 8.3 8.4 9.0 9.1 basic bdubbs/svn elogind kea ken/TL2024 ken/inkscape-core-mods ken/tuningfonts krejzi/svn lazarus lxqt nosym perl-modules plabs/newcss plabs/python-mods python3.11 qt5new rahul/power-profiles-daemon renodr/vulkan-addition trunk upgradedb xry111/intltool xry111/llvm18 xry111/soup3 xry111/test-20220226 xry111/xf86-video-removal
Last change on this file since e3f97f9 was e3f97f9, checked in by Fernando de Oliveira <fernando@…>, 10 years ago

Git-2.0.4 test suite needs compatibility symlinks recommended in GnuPG-2.0.26.
Update to cups-filters-1.0.57.

git-svn-id: svn://svn.linuxfromscratch.org/BLFS/trunk/BOOK@13921 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 "0caa9c54bb04612062d21823163ecb13">
12 <!ENTITY git-size "3.3 MB">
13 <!ENTITY git-buildsize "269 MB (additional 13 MB for downloaded docs and man pages, or 24 MB building docs and man pages)">
14 <!ENTITY git-time "0.7 SBU (additional 5.5 SBU for tests or 2.5 SBU for docs and man build)
15">
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 on
41 network access or a central server. Branching and merging are fast and easy
42 to do. <application>Git</application> is used for version control of files,
43 much like tools such as <application>Mercurial</application>,
44 <application>Bazaar</application>, <xref linkend="subversion"/>,
45 <xref linkend="cvs"/>, <application>Perforce</application>, and
46 <application>Team Foundation Server</application>.
47 </para>
48
49 &lfs75_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>), and
119 <xref linkend="tk"/> (gitk, a simple <application>Git</application>
120 repository viewer, uses <application>Tk</application> at runtime)
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>
127 </para>
128
129 <para condition="html" role="usernotes">User Notes:
130 <ulink url="&blfs-wiki;/git"/>
131 </para>
132 </sect2>
133
134 <sect2 role="installation">
135 <title>Installation of Git</title>
136
137 <para>
138 Install <application>Git</application> by running the following
139 commands:
140 </para>
141
142<screen><userinput>./configure --prefix=/usr \
143 --with-gitconfig=/etc/gitconfig &amp;&amp;
144make</userinput></screen>
145
146 <para>
147 If you have installed <ulink
148 url="http://www.methods.co.nz/asciidoc/">AsciiDoc</ulink> you can
149 create the html version of the man pages and other docs:
150 </para>
151
152<screen><userinput>make html</userinput></screen>
153
154 <para>
155 If you have installed <ulink
156 url="http://www.methods.co.nz/asciidoc/">AsciiDoc</ulink> and
157 <xref linkend="xmlto"/> you can create the man pages:
158 </para>
159
160<screen><userinput>make man</userinput></screen>
161
162 <para>
163 The test suite can be run in parallel mode. Many tests cannot find
164 <application>GnuPG2</application>, if the compatibility symlinks,
165 recommended in <xref linkend="gnupg2"/>, are not installed. To run the
166 test suite, issue: <command>make test</command>.
167 </para>
168
169 <para>
170 Now, as the <systemitem class="username">root</systemitem>
171 user:
172 </para>
173
174<screen role="root"><userinput>make install</userinput></screen>
175
176 <para>
177 If you created the man pages, install them as the
178 <systemitem class="username">root</systemitem> user:
179 </para>
180
181<screen role="root"><userinput>make install-man</userinput></screen>
182
183 <para>
184 If you created the html docs, install them as the
185 <systemitem class="username">root</systemitem> user:
186 </para>
187
188<screen role="root"><userinput>make htmldir=/usr/share/doc/git-&git-version; install-html &amp;&amp;
189mkdir -p /usr/share/doc/git-&git-version;/man-pages/{html,text} &amp;&amp;
190mv /usr/share/doc/git-&git-version;/{git*.txt,man-pages/text} &amp;&amp;
191mv /usr/share/doc/git-&git-version;/{git*.,index.,man-pages/}html &amp;&amp;
192mkdir /usr/share/doc/git-&git-version;/technical/{html,text} &amp;&amp;
193mv /usr/share/doc/git-&git-version;/technical/{*.txt,text} &amp;&amp;
194mv /usr/share/doc/git-&git-version;/technical/{*.,}html &amp;&amp;
195mkdir /usr/share/doc/git-&git-version;/howto/{html,text} &amp;&amp;
196mv /usr/share/doc/git-&git-version;/howto/{*.txt,text} &amp;&amp;
197mv /usr/share/doc/git-&git-version;/howto/{*.,}html</userinput></screen>
198
199 <para>
200 Alternatively, If you downloaded the man pages untar them as the
201 <systemitem class="username">root</systemitem> user:
202 </para>
203
204<screen role="root"><userinput>tar -xf ../git-manpages-&git-version;.tar.xz -C /usr/share/man --no-same-owner --no-overwrite-dir</userinput></screen>
205
206 <para>
207 If you downloaded the html docs untar them as the
208 <systemitem class="username">root</systemitem> user:
209 </para>
210
211<screen role="root"><userinput>mkdir -p /usr/share/doc/git-&git-version;/man-pages/{html,text} &amp;&amp;
212
213tar -xf ../git-htmldocs-&git-version;.tar.xz \
214 -C /usr/share/doc/git-&git-version; --no-same-owner --no-overwrite-dir &amp;&amp;
215
216find /usr/share/doc/git-&git-version; -type d -exec chmod 755 {} \; &amp;&amp;
217find /usr/share/doc/git-&git-version; -type f -exec chmod 644 {} \; &amp;&amp;
218
219mv /usr/share/doc/git-&git-version;/{git*.txt,man-pages/text} &amp;&amp;
220mv /usr/share/doc/git-&git-version;/{git*.,index.,man-pages/}html &amp;&amp;
221mkdir /usr/share/doc/git-&git-version;/technical/{html,text} &amp;&amp;
222mv /usr/share/doc/git-&git-version;/technical/{*.txt,text} &amp;&amp;
223mv /usr/share/doc/git-&git-version;/technical/{*.,}html &amp;&amp;
224mkdir /usr/share/doc/git-&git-version;/howto/{html,text} &amp;&amp;
225mv /usr/share/doc/git-&git-version;/howto/{*.txt,text} &amp;&amp;
226mv /usr/share/doc/git-&git-version;/howto/{*.,}html</userinput></screen>
227
228 </sect2>
229
230 <sect2 role="commands">
231 <title>Command Explanations</title>
232
233 <para>
234 <parameter>--with-gitconfig=/etc/gitconfig</parameter>: This sets
235 <filename>/etc/gitconfig</filename> as the file that stores
236 the default, system wide, <application>Git</application>
237 settings.
238 </para>
239
240 <para>
241 <option>--without-python</option>: Use this switch if
242 <application>Python</application> is not installed.
243 </para>
244
245 <para>
246 <option>--with-libpcre</option>: Use this switch if
247 <application>PCRE</application> is installed.
248 </para>
249
250 <para>
251 <command>tar -xf ../git-manpages-&git-version;.tar.gz -C
252 /usr/share/man --no-same-owner</command>: This untars
253 <filename>git-manpages-&git-version;.tar.gz</filename>. The
254 <option>-C</option> option makes tar change directory to
255 <filename class="directory">/usr/share/man</filename> before
256 it starts to decompress the docs. The <option>--no-same-owner</option>
257 option stops tar from preserving the user and group details of the
258 files. This is useful as that user or group may not exist on your
259 system; this could (potentially) be a security risk.
260 </para>
261
262 <para>
263 <command>mv /usr/share/doc/git-&git-version; ...</command>: These
264 commands move some of the files into subfolders to make it easier to sort
265 through the docs and find what you're looking for.
266 </para>
267
268 <para>
269 <command>find ... chmod ...</command>: These commands correct the
270 permissions in the shipped documentation tar file.
271 </para>
272
273 <para><option>--libexecdir=/usr/lib</option>: This option puts the
274 <filename class="directory">git-core</filename> directory in
275 <filename class="directory">/usr/lib</filename> instead of
276 <filename class="directory">/usr/libexec</filename> in accordance
277 with the old version of the FHS used before LFS-7.5.</para>
278
279 </sect2>
280
281 <sect2 role="configuration">
282 <title>Configuring Git</title>
283
284 <sect3 id="git-config">
285 <title>Config Files</title>
286 <para>
287 <filename>~/.gitconfig</filename> and
288 <filename>/etc/gitconfig</filename>
289 </para>
290
291 <indexterm zone="git git-config">
292 <primary sortas="e-AA.gitconfig">~/.gitconfig</primary>
293 </indexterm>
294
295 <indexterm zone="git git-config">
296 <primary sortas="e-etc-gitconfig">/etc/gitconfig</primary>
297 </indexterm>
298
299 </sect3>
300
301 </sect2>
302
303 <sect2 role="content">
304 <title>Contents</title>
305
306 <segmentedlist>
307 <segtitle>Installed Programs</segtitle>
308 <segtitle>Installed Libraries</segtitle>
309 <segtitle>Installed Directories</segtitle>
310
311 <seglistitem>
312 <seg>
313 git, git-receive-pack and git-upload-archive (hardlinked to each other),
314 git-shell, git-cvsserver, git-upload-pack, and gitk
315 </seg>
316 <seg>
317 None
318 </seg>
319 <seg>
320 /usr/libexec/git-core,
321 /usr/share/doc/git-&git-version;,
322 /usr/share/git-core,
323 /usr/share/git-gui,
324 /usr/share/gitk,
325 /usr/share/gitweb,
326 /usr/lib/perl5/site_perl/&lt;5.x.y&gt;/Git and
327 /usr/lib/perl5/site_perl/&lfs-perl-version;/auto/Git
328
329 </seg>
330 </seglistitem>
331 </segmentedlist>
332
333 <variablelist>
334 <bridgehead renderas="sect3">Short Descriptions</bridgehead>
335 <?dbfo list-presentation="list"?>
336 <?dbhtml list-presentation="table"?>
337
338 <varlistentry id="git-prog">
339 <term><command>git</command></term>
340 <listitem>
341 <para>
342 is the stupid content tracker.
343 </para>
344 <indexterm zone="git git-prog">
345 <primary sortas="b-git">git</primary>
346 </indexterm>
347 </listitem>
348 </varlistentry>
349
350 <varlistentry id="git-cvsserver">
351 <term><command>git-cvsserver</command></term>
352 <listitem>
353 <para>
354 is a CVS server emulator for <application>Git</application>.
355 </para>
356 <indexterm zone="git git-cvsserver">
357 <primary sortas="b-git-cvsserver">git-cvsserver</primary>
358 </indexterm>
359 </listitem>
360 </varlistentry>
361
362 <varlistentry id="gitk">
363 <term><command>gitk</command></term>
364 <listitem>
365 <para>
366 is a graphical <application>Git</application> repository browser
367 (needs <xref linkend="tk"/>).
368 </para>
369 <indexterm zone="git gitk">
370 <primary sortas="b-gitk">gitk</primary>
371 </indexterm>
372 </listitem>
373 </varlistentry>
374
375 <varlistentry id="git-receive-pack">
376 <term><command>git-receive-pack</command></term>
377 <listitem>
378 <para>
379 is invoked by <command>git send-pack</command> and updates the
380 repository with the information fed from the remote end.
381 </para>
382 <indexterm zone="git git-receive-pack">
383 <primary sortas="b-git-receive-pack">git-receive-pack</primary>
384 </indexterm>
385 </listitem>
386 </varlistentry>
387
388 <varlistentry id="git-shell">
389 <term><command>git-shell</command></term>
390 <listitem>
391 <para>
392 is a login shell for SSH accounts to provide restricted Git
393 access.
394 </para>
395 <indexterm zone="git git-shell">
396 <primary sortas="b-git-shell">git-shell</primary>
397 </indexterm>
398 </listitem>
399 </varlistentry>
400
401 <varlistentry id="git-upload-archive">
402 <term><command>git-upload-archive</command></term>
403 <listitem>
404 <para>
405 is invoked by <command>git archive --remote</command> and sends
406 a generated archive to the other end over the git protocol.
407 </para>
408 <indexterm zone="git git-upload-archive">
409 <primary sortas="b-git-upload-archive">git-upload-archive</primary>
410 </indexterm>
411 </listitem>
412 </varlistentry>
413
414 <varlistentry id="git-upload-pack">
415 <term><command>git-upload-pack</command></term>
416 <listitem>
417 <para>
418 is invoked by <command>git fetch-pack</command>, it discovers
419 what objects the other side is missing, and sends them after
420 packing.
421 </para>
422 <indexterm zone="git git-upload-pack">
423 <primary sortas="b-git-upload-pack">git-upload-pack</primary>
424 </indexterm>
425 </listitem>
426 </varlistentry>
427
428 </variablelist>
429
430 </sect2>
431
432</sect1>
Note: See TracBrowser for help on using the repository browser.