source: general/prog/git.xml@ 597d3c9b

10.0 10.1 11.0 ken/refactor-virt lazarus qt5new trunk xry111/git-date xry111/git-date-for-trunk xry111/git-date-test
Last change on this file since 597d3c9b was 597d3c9b, checked in by Bruce Dubbs <bdubbs@…>, 17 months ago

Update to librsvg-2.48.6.
Update to git-2.27.0.
Update to audacious-4.0.4.

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

  • Property mode set to 100644
File size: 15.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 "&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 "3f43de267dee995550ff0c46691aefc0">
12 <!ENTITY git-size "5.8 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 "318 MB (with downloaded documentation, 196 MB installed)">
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.4 SBU (with parallelism=4; add 2.7 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="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 \
157 --with-gitconfig=/etc/gitconfig \
158 --with-python=python3 &amp;&amp;
159make</userinput></screen>
160
161 <para>
162 You can build the man pages and/or html docs, or
163 use downloaded ones. If you choose to build them, use next two following
164 instructions.
165 </para>
166
167 <para>
168 If you have installed <xref linkend="asciidoc"/> you can
169 create the html version of the man pages and other docs:
170 </para>
171
172<screen remap="doc"><userinput>make html</userinput></screen>
173
174 <para>
175 If you have installed <xref linkend="asciidoc"/> and
176 <xref linkend="xmlto"/> you can create the man pages:
177 </para>
178
179<screen remap="doc"><userinput>make man</userinput></screen>
180
181 <para>
182 The test suite can be run in parallel mode. To run the test suite, issue:
183 <command>make test</command>. If run as a normal user, 0 tests should be
184 reported as failed in the final summary.
185 </para>
186
187 <para>
188 Now, as the <systemitem class="username">root</systemitem>
189 user:
190 </para>
191
192<screen role="root"><userinput>make install</userinput></screen>
193
194<!-- ==== Method 1 for docs ====== -->
195 <bridgehead renderas="sect3">If you created the man pages and/or html docs</bridgehead>
196
197 <para>
198 Install the man pages as
199 <systemitem class="username">root</systemitem> user:
200 </para>
201
202<screen role="root"
203 remap="doc"><userinput>make install-man</userinput></screen>
204
205 <para>
206 Install the html docs as
207 <systemitem class="username">root</systemitem> user:
208 </para>
209
210<screen role="root"
211 remap="doc"><userinput>make htmldir=/usr/share/doc/git-&git-version; install-html</userinput></screen>
212
213<!-- ==== Method 2 for docs ====== -->
214 <bridgehead renderas="sect3">If you downloaded the man pages and/or html docs</bridgehead>
215
216 <para>
217 If you downloaded the man pages untar them as the
218 <systemitem class="username">root</systemitem> user:
219 </para>
220
221<screen role="root"><userinput>tar -xf ../git-manpages-&git-version;.tar.xz \
222 -C /usr/share/man --no-same-owner --no-overwrite-dir</userinput></screen>
223
224 <para>
225 If you downloaded the html docs untar them as the
226 <systemitem class="username">root</systemitem> user:
227 </para>
228
229<screen role="root"><userinput>mkdir -vp /usr/share/doc/git-&git-version; &amp;&amp;
230tar -xf ../git-htmldocs-&git-version;.tar.xz \
231 -C /usr/share/doc/git-&git-version; --no-same-owner --no-overwrite-dir &amp;&amp;
232
233find /usr/share/doc/git-&git-version; -type d -exec chmod 755 {} \; &amp;&amp;
234find /usr/share/doc/git-&git-version; -type f -exec chmod 644 {} \;</userinput></screen>
235
236<!-- ==== Reorganize docs ====== -->
237 <bridgehead renderas="sect3">Reorganize text and html in the html-docs (both methods)</bridgehead>
238
239 <para>
240 For both methods, the html-docs include a lot of plain text files.
241 Reorganize the files as the
242 <systemitem class="username">root</systemitem> user:
243 </para>
244
245<screen role="root"><userinput>mkdir -vp /usr/share/doc/git-&git-version;/man-pages/{html,text} &amp;&amp;
246mv /usr/share/doc/git-&git-version;/{git*.txt,man-pages/text} &amp;&amp;
247mv /usr/share/doc/git-&git-version;/{git*.,index.,man-pages/}html &amp;&amp;
248
249mkdir -vp /usr/share/doc/git-&git-version;/technical/{html,text} &amp;&amp;
250mv /usr/share/doc/git-&git-version;/technical/{*.txt,text} &amp;&amp;
251mv /usr/share/doc/git-&git-version;/technical/{*.,}html &amp;&amp;
252
253mkdir -vp /usr/share/doc/git-&git-version;/howto/{html,text} &amp;&amp;
254mv /usr/share/doc/git-&git-version;/howto/{*.txt,text} &amp;&amp;
255mv /usr/share/doc/git-&git-version;/howto/{*.,}html &amp;&amp;
256
257sed -i '/^&lt;a href=/s|howto/|&amp;html/|' /usr/share/doc/git-&git-version;/howto-index.html &amp;&amp;
258sed -i '/^\* link:/s|howto/|&amp;html/|' /usr/share/doc/git-&git-version;/howto-index.txt</userinput></screen>
259
260 </sect2>
261
262 <sect2 role="commands">
263 <title>Command Explanations</title>
264
265 <para>
266 <parameter>--with-gitconfig=/etc/gitconfig</parameter>: This sets
267 <filename>/etc/gitconfig</filename> as the file that stores
268 the default, system wide, <application>Git</application>
269 settings.
270 </para>
271
272 <para>
273 <option>--with-python=python3</option>: Use this switch to use
274 <application>Python 3</application>, instead of the EOL'ed
275 <application>Python 2</application>. Python is used for the
276 <command>git p4</command> interface to Perforce repositories,
277 and also used in some tests.
278 </para>
279
280 <para>
281 <option>--with-libpcre2</option>: Use this switch if
282 <application>PCRE2</application> is installed and has been built with
283 the non-default JIT enabled.
284 </para>
285
286 <para>
287 <option>--with-libpcre</option>: As an alternative to PCRE2, use this
288 switch if the deprecated <application>PCRE</application> is installed
289 and has been built with the non-default JIT enabled.
290 </para>
291
292 <para>
293 <command>tar -xf ../git-manpages-&git-version;.tar.gz -C
294 /usr/share/man --no-same-owner</command>: This untars
295 <filename>git-manpages-&git-version;.tar.gz</filename>. The
296 <option>-C</option> option makes tar change directory to
297 <filename class="directory">/usr/share/man</filename> before
298 it starts to decompress the docs. The <option>--no-same-owner</option>
299 option stops tar from preserving the user and group details of the
300 files. This is useful as that user or group may not exist on your
301 system; this could (potentially) be a security risk.
302 </para>
303
304 <para>
305 <command>mv /usr/share/doc/git-&git-version; ...</command>: These
306 commands move some of the files into subfolders to make it easier to sort
307 through the docs and find what you're looking for.
308 </para>
309
310 <para>
311 <command>find ... chmod ...</command>: These commands correct the
312 permissions in the shipped documentation tar file.
313 </para>
314
315 </sect2>
316
317 <sect2 role="configuration">
318 <title>Configuring Git</title>
319
320 <sect3 id="git-config">
321 <title>Config Files</title>
322 <para>
323 <filename>~/.gitconfig</filename> and
324 <filename>/etc/gitconfig</filename>
325 </para>
326
327 <indexterm zone="git git-config">
328 <primary sortas="e-AA.gitconfig">~/.gitconfig</primary>
329 </indexterm>
330
331 <indexterm zone="git git-config">
332 <primary sortas="e-etc-gitconfig">/etc/gitconfig</primary>
333 </indexterm>
334
335 </sect3>
336
337 </sect2>
338
339 <sect2 role="content">
340 <title>Contents</title>
341
342 <segmentedlist>
343 <segtitle>Installed Programs</segtitle>
344 <segtitle>Installed Libraries</segtitle>
345 <segtitle>Installed Directories</segtitle>
346
347 <seglistitem>
348 <seg>
349 git, git-receive-pack and git-upload-archive (hardlinked to each
350 other), git-cvsserver, git-shell, git-upload-pack, and gitk
351 </seg>
352 <seg>
353 None
354 </seg>
355 <seg>
356 /usr/share/perl5/Git,
357 <!-- I do NOT think this is in our %INC search path. -->
358 /usr/libexec/git-core and
359 /usr/share/{doc/git-&git-version;,git-core,git-gui,gitk,gitweb}
360 </seg>
361 </seglistitem>
362 </segmentedlist>
363
364 <variablelist>
365 <bridgehead renderas="sect3">Short Descriptions</bridgehead>
366 <?dbfo list-presentation="list"?>
367 <?dbhtml list-presentation="table"?>
368
369 <varlistentry id="git-prog">
370 <term><command>git</command></term>
371 <listitem>
372 <para>
373 is the stupid content tracker.
374 </para>
375 <indexterm zone="git git-prog">
376 <primary sortas="b-git">git</primary>
377 </indexterm>
378 </listitem>
379 </varlistentry>
380
381 <varlistentry id="git-cvsserver">
382 <term><command>git-cvsserver</command></term>
383 <listitem>
384 <para>
385 is a CVS server emulator for <application>Git</application>.
386 </para>
387 <indexterm zone="git git-cvsserver">
388 <primary sortas="b-git-cvsserver">git-cvsserver</primary>
389 </indexterm>
390 </listitem>
391 </varlistentry>
392
393 <varlistentry id="gitk">
394 <term><command>gitk</command></term>
395 <listitem>
396 <para>
397 is a graphical <application>Git</application> repository browser
398 (needs <xref linkend="tk"/>).
399 </para>
400 <indexterm zone="git gitk">
401 <primary sortas="b-gitk">gitk</primary>
402 </indexterm>
403 </listitem>
404 </varlistentry>
405
406 <varlistentry id="git-receive-pack">
407 <term><command>git-receive-pack</command></term>
408 <listitem>
409 <para>
410 is invoked by <command>git send-pack</command> and updates the
411 repository with the information fed from the remote end.
412 </para>
413 <indexterm zone="git git-receive-pack">
414 <primary sortas="b-git-receive-pack">git-receive-pack</primary>
415 </indexterm>
416 </listitem>
417 </varlistentry>
418
419 <varlistentry id="git-shell">
420 <term><command>git-shell</command></term>
421 <listitem>
422 <para>
423 is a login shell for SSH accounts to provide restricted Git
424 access.
425 </para>
426 <indexterm zone="git git-shell">
427 <primary sortas="b-git-shell">git-shell</primary>
428 </indexterm>
429 </listitem>
430 </varlistentry>
431
432 <varlistentry id="git-upload-archive">
433 <term><command>git-upload-archive</command></term>
434 <listitem>
435 <para>
436 is invoked by <command>git archive --remote</command> and sends
437 a generated archive to the other end over the git protocol.
438 </para>
439 <indexterm zone="git git-upload-archive">
440 <primary sortas="b-git-upload-archive">git-upload-archive</primary>
441 </indexterm>
442 </listitem>
443 </varlistentry>
444
445 <varlistentry id="git-upload-pack">
446 <term><command>git-upload-pack</command></term>
447 <listitem>
448 <para>
449 is invoked by <command>git fetch-pack</command>, it discovers
450 what objects the other side is missing, and sends them after
451 packing.
452 </para>
453 <indexterm zone="git git-upload-pack">
454 <primary sortas="b-git-upload-pack">git-upload-pack</primary>
455 </indexterm>
456 </listitem>
457 </varlistentry>
458
459 </variablelist>
460
461 </sect2>
462
463</sect1>
Note: See TracBrowser for help on using the repository browser.