source: general/prog/git.xml@ 6c7614f7

12.0 12.1 12.2 gimp3 kea ken/TL2024 ken/tuningfonts lazarus lxqt plabs/newcss python3.11 rahul/power-profiles-daemon renodr/vulkan-addition trunk xry111/for-12.3 xry111/llvm18 xry111/spidermonkey128 xry111/xf86-video-removal
Last change on this file since 6c7614f7 was 6c7614f7, checked in by Douglas R. Reno <renodr@…>, 16 months ago

Git: Document test suite failures with curl-8.1.x

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