source: general/prog/git.xml@ bd790c97

10.0 10.1 11.0 11.1 11.2 11.3 12.0 12.1 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 lazarus lxqt 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 bd790c97 was bd790c97, checked in by Pierre Labastie <pieere@…>, 7 years ago

Add perl module "Error", since it is a recommended dependency of git

git-svn-id: svn://svn.linuxfromscratch.org/BLFS/trunk/BOOK@18922 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 " ">
11 <!ENTITY git-md5sum "73d9bf372391a1e02989d0610295b779">
12 <!ENTITY git-size "4.5 MB">
13 <!ENTITY git-buildsize "549 MB (with optional dependencies and documentation)">
14 <!ENTITY git-time "0.8 SBU (add 2.1 SBU for building documentation, add 4.2 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 &lfs80_checked;
50 &gcc7_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="openssl"/>,
113 <xref linkend="perl-error"/>, and
114 <xref linkend="python2"/>
115 </para>
116
117 <bridgehead renderas="sect4">Optional</bridgehead>
118 <para role="optional">
119 <xref linkend="pcre"/>,
120 <xref linkend="subversion"/> with Perl bindings (for <command>git svn</command>),
121 <xref linkend="tk"/> (gitk, a simple <application>Git</application>
122 repository viewer, uses <application>Tk</application> at runtime), and
123 <xref linkend="valgrind"/>
124 </para>
125
126 <bridgehead renderas="sect4">Optional (to create the man pages, html docs
127 and other docs)</bridgehead>
128 <para role="optional">
129 <xref linkend="xmlto"/> and
130 <xref linkend="asciidoc"/> or
131 <ulink url="http://asciidoctor.org/">AsciiDoctor</ulink>, and also
132 <ulink url="http://dblatex.sourceforge.net/">dblatex</ulink>
133 (for the PDF version of the user manual), and
134 <ulink url="http://docbook2x.sourceforge.net/">docbook2x</ulink> to
135 create info pages
136 </para>
137
138 <para condition="html" role="usernotes">User Notes:
139 <ulink url="&blfs-wiki;/git"/>
140 </para>
141 </sect2>
142
143 <sect2 role="installation">
144 <title>Installation of Git</title>
145
146 <para>
147 Install <application>Git</application> by running the following
148 commands:
149 </para>
150
151<screen><userinput>./configure --prefix=/usr --with-gitconfig=/etc/gitconfig &amp;&amp;
152make</userinput></screen>
153
154 <para>
155 You can build the man pages and/or html docs, or
156 use downloaded ones. If you choose to build them, use next two following
157 instructions.
158 </para>
159
160 <para>
161 If you have installed <xref linkend="asciidoc"/> you can
162 create the html version of the man pages and other docs:
163 </para>
164
165<screen><userinput>make html</userinput></screen>
166
167 <para>
168 If you have installed <xref linkend="asciidoc"/> and
169 <xref linkend="xmlto"/> you can create the man pages:
170 </para>
171
172<screen><userinput>make man</userinput></screen>
173
174 <para>
175 The test suite can be run in parallel mode. To run the test suite, issue:
176 <command>make test</command>. If run as a normal user, 0 tests should be
177 reported as failed in the final summary.
178 </para>
179
180 <para>
181 Now, as the <systemitem class="username">root</systemitem>
182 user:
183 </para>
184
185<screen role="root"><userinput>make install</userinput></screen>
186
187<!-- ==== Method 1 for docs ====== -->
188 <bridgehead renderas="sect3">If you created the man pages and/or html docs</bridgehead>
189
190 <para>
191 Install the man pages as
192 <systemitem class="username">root</systemitem> user:
193 </para>
194
195<screen role="root"><userinput>make install-man</userinput></screen>
196
197 <para>
198 Install the html docs as
199 <systemitem class="username">root</systemitem> user:
200 </para>
201
202<screen role="root"><userinput>make htmldir=/usr/share/doc/git-&git-version; install-html</userinput></screen>
203
204<!-- ==== Method 2 for docs ====== -->
205 <bridgehead renderas="sect3">If you downloaded the man pages and/or html docs</bridgehead>
206
207 <para>
208 If you downloaded the man pages untar them as the
209 <systemitem class="username">root</systemitem> user:
210 </para>
211
212<screen role="root"><userinput>tar -xf ../git-manpages-&git-version;.tar.xz \
213 -C /usr/share/man --no-same-owner --no-overwrite-dir</userinput></screen>
214
215 <para>
216 If you downloaded the html docs untar them as the
217 <systemitem class="username">root</systemitem> user:
218 </para>
219
220<screen role="root"><userinput>mkdir -vp /usr/share/doc/git-&git-version; &amp;&amp;
221tar -xf ../git-htmldocs-&git-version;.tar.xz \
222 -C /usr/share/doc/git-&git-version; --no-same-owner --no-overwrite-dir &amp;&amp;
223
224find /usr/share/doc/git-&git-version; -type d -exec chmod 755 {} \; &amp;&amp;
225find /usr/share/doc/git-&git-version; -type f -exec chmod 644 {} \;</userinput></screen>
226
227<!-- ==== Reorganize docs ====== -->
228 <bridgehead renderas="sect3">Reorganize text and html in the html-docs (both methods)</bridgehead>
229
230 <para>
231 For both methods, the html-docs include a lot of plain text files.
232 Reorganize the files as the
233 <systemitem class="username">root</systemitem> user:
234 </para>
235
236<screen role="root"><userinput>mkdir -vp /usr/share/doc/git-&git-version;/man-pages/{html,text} &amp;&amp;
237mv /usr/share/doc/git-&git-version;/{git*.txt,man-pages/text} &amp;&amp;
238mv /usr/share/doc/git-&git-version;/{git*.,index.,man-pages/}html &amp;&amp;
239
240mkdir -vp /usr/share/doc/git-&git-version;/technical/{html,text} &amp;&amp;
241mv /usr/share/doc/git-&git-version;/technical/{*.txt,text} &amp;&amp;
242mv /usr/share/doc/git-&git-version;/technical/{*.,}html &amp;&amp;
243
244mkdir -vp /usr/share/doc/git-&git-version;/howto/{html,text} &amp;&amp;
245mv /usr/share/doc/git-&git-version;/howto/{*.txt,text} &amp;&amp;
246mv /usr/share/doc/git-&git-version;/howto/{*.,}html &amp;&amp;
247
248sed -i '/^&lt;a href=/s|howto/|&amp;html/|' /usr/share/doc/git-2.13.1/howto-index.html &amp;&amp;
249sed -i '/^\* link:/s|howto/|&amp;html/|' /usr/share/doc/git-2.13.1/howto-index.txt</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
331 other), 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.