source: general/prog/git.xml@ b3156ddf

12.1 ken/TL2024 lazarus trunk xry111/llvm18
Last change on this file since b3156ddf was d9142ec4, checked in by Xi Ruoyao <xry111@…>, 3 months ago

systemd: Fix a bug breaking systemd-verify an instantiated unit

Sync with LFS.

This bug is breaking Git test suite (and maybe other things).

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