source: general/prog/git.xml@ b4dbcb0

10.0 10.1 11.0 11.1 11.2 11.3 12.0 12.1 kea ken/TL2024 ken/inkscape-core-mods ken/tuningfonts lazarus lxqt 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 b4dbcb0 was 25ff6d5, checked in by Douglas R. Reno <renodr@…>, 4 years ago

Update to libqmi-1.24.4
Update to libgdata-0.17.12
Update to libmypaint-1.5.1
Update to avahi-0.8
Update to ibus-1.5.22
Update to git-2.25.1

git-svn-id: svn://svn.linuxfromscratch.org/BLFS/trunk/BOOK@22780 af4574ff-66df-0310-9fd7-8a98e5e911e0

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