source: general/prog/git.xml@ 9fd586e9

12.0 12.1 kea ken/TL2024 ken/tuningfonts lazarus lxqt plabs/newcss python3.11 rahul/power-profiles-daemon renodr/vulkan-addition trunk xry111/llvm18 xry111/xf86-video-removal
Last change on this file since 9fd586e9 was d98ca85, checked in by Xi Ruoyao <xry111@…>, 13 months ago

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