source: general/prog/git.xml@ 35400a4

elogind
Last change on this file since 35400a4 was 35400a4, checked in by DJ Lucas <dj@…>, 2 years ago

Merge to HEAD 21680.

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

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