source: general/prog/git.xml@ f5524b6

11.0 11.1 lazarus qt5new trunk upgradedb xry111/intltool xry111/test-20220226
Last change on this file since f5524b6 was f5524b6, checked in by Douglas R. Reno <renodr@…>, 9 months ago

git: minor typo fix in dependencies

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