source: general/prog/git.xml@ 34fe2633

10.0 10.1 11.0 11.1 11.2 11.3 12.0 12.1 9.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 34fe2633 was 34fe2633, checked in by Bruce Dubbs <bdubbs@…>, 4 years ago

Update to libmypaint-1.5.0.
Update to ModemManager-1.12.6.

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

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