source: general/prog/git.xml@ e0376ce

12.1 ken/TL2024 lazarus rahul/power-profiles-daemon trunk xry111/llvm18
Last change on this file since e0376ce was 98480534, checked in by Pierre Labastie <pierre.labastie@…>, 4 months ago

Fix rendering for sysv

  • Property mode set to 100644
File size: 17.6 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 "66a036a0442b8d159b0eff5a0fe0dc94">
12
13 <!ENTITY git-size "7.0 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 "255 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 <phrase revision='systemd'>One test named <literal>start and stop
199 Linux/systemd maintenance</literal> is known to fail if the current
200 login session is not started after rebuilding
201 <xref linkend='systemd'/> with <xref linkend='linux-pam'/>
202 support, or it's a SSH session but the SSH server is not configured
203 with <option>UsePAM</option> enabled.</phrase>
204 </para>
205
206 <para>
207 Now, as the <systemitem class="username">root</systemitem>
208 user:
209 </para>
210
211<screen role="root"><userinput>make perllibdir=/usr/lib/perl5/&lfs-perl-version;/site_perl install</userinput></screen>
212
213<!-- ==== Method 1 for docs ====== -->
214 <bridgehead renderas="sect3">If you created the man pages and/or html docs</bridgehead>
215
216 <para>
217 Install the man pages as the
218 <systemitem class="username">root</systemitem> user:
219 </para>
220
221<screen role="root"
222 remap="doc"><userinput>make install-man</userinput></screen>
223
224 <para>
225 Install the html docs as the
226 <systemitem class="username">root</systemitem> user:
227 </para>
228
229<screen role="root"
230 remap="doc"><userinput>make htmldir=/usr/share/doc/git-&git-version; install-html</userinput></screen>
231
232<!-- ==== Method 2 for docs ====== -->
233 <bridgehead renderas="sect3">If you downloaded the man pages and/or html docs</bridgehead>
234
235 <para>
236 If you downloaded the man pages untar them as the
237 <systemitem class="username">root</systemitem> user:
238 </para>
239
240<screen role="root"><userinput>tar -xf ../git-manpages-&git-version;.tar.xz \
241 -C /usr/share/man --no-same-owner --no-overwrite-dir</userinput></screen>
242
243 <para>
244 If you downloaded the html docs untar them as the
245 <systemitem class="username">root</systemitem> user:
246 </para>
247
248<screen role="root"><userinput>mkdir -vp /usr/share/doc/git-&git-version; &amp;&amp;
249tar -xf ../git-htmldocs-&git-version;.tar.xz \
250 -C /usr/share/doc/git-&git-version; --no-same-owner --no-overwrite-dir &amp;&amp;
251
252find /usr/share/doc/git-&git-version; -type d -exec chmod 755 {} \; &amp;&amp;
253find /usr/share/doc/git-&git-version; -type f -exec chmod 644 {} \;</userinput></screen>
254
255<!-- ==== Reorganize docs ====== -->
256 <bridgehead renderas="sect3">Reorganize text and html in the html-docs (both methods)</bridgehead>
257
258 <para>
259 For both methods, the html-docs include a lot of plain text files.
260 Reorganize the files as the
261 <systemitem class="username">root</systemitem> user:
262 </para>
263
264<screen role="root"><userinput>mkdir -vp /usr/share/doc/git-&git-version;/man-pages/{html,text} &amp;&amp;
265mv /usr/share/doc/git-&git-version;/{git*.txt,man-pages/text} &amp;&amp;
266mv /usr/share/doc/git-&git-version;/{git*.,index.,man-pages/}html &amp;&amp;
267
268mkdir -vp /usr/share/doc/git-&git-version;/technical/{html,text} &amp;&amp;
269mv /usr/share/doc/git-&git-version;/technical/{*.txt,text} &amp;&amp;
270mv /usr/share/doc/git-&git-version;/technical/{*.,}html &amp;&amp;
271
272mkdir -vp /usr/share/doc/git-&git-version;/howto/{html,text} &amp;&amp;
273mv /usr/share/doc/git-&git-version;/howto/{*.txt,text} &amp;&amp;
274mv /usr/share/doc/git-&git-version;/howto/{*.,}html &amp;&amp;
275
276sed -i '/^&lt;a href=/s|howto/|&amp;html/|' /usr/share/doc/git-&git-version;/howto-index.html &amp;&amp;
277sed -i '/^\* link:/s|howto/|&amp;html/|' /usr/share/doc/git-&git-version;/howto-index.txt</userinput></screen>
278
279 </sect2>
280
281 <sect2 role="commands">
282 <title>Command Explanations</title>
283
284 <para>
285 <parameter>--with-gitconfig=/etc/gitconfig</parameter>: This sets
286 <filename>/etc/gitconfig</filename> as the file that stores
287 the default, system wide, <application>Git</application>
288 settings.
289 </para>
290
291 <para>
292 <parameter>--with-python=python3</parameter>: Use this switch to use
293 <application>Python 3</application>, instead of the EOL'ed
294 <application>Python 2</application>. Python is used for the
295 <command>git p4</command> interface to Perforce repositories,
296 and also used in some tests.
297 </para>
298
299 <para>
300 <option>--with-libpcre2</option>: Use this switch if
301 <application>PCRE2</application> is installed and has been built with
302 the non-default JIT enabled.
303 </para>
304
305 <para>
306 <option>--with-libpcre1</option>: As an alternative to PCRE2, use this
307 switch if the deprecated <application>PCRE</application> is installed
308 and has been built with the non-default JIT enabled.
309 </para>
310
311 <para>
312 <command>tar -xf ../git-manpages-&git-version;.tar.gz -C
313 /usr/share/man --no-same-owner</command>: This untars
314 <filename>git-manpages-&git-version;.tar.gz</filename>. The
315 <option>-C</option> option makes tar change directory to
316 <filename class="directory">/usr/share/man</filename> before
317 it starts to decompress the docs. The <option>--no-same-owner</option>
318 option stops tar from preserving the user and group details of the
319 files. This is useful as that user or group may not exist on your
320 system; this could (potentially) be a security risk.
321 </para>
322
323 <para>
324 <command>mv /usr/share/doc/git-&git-version; ...</command>: These
325 commands move some of the files into subfolders to make it easier to sort
326 through the docs and find what you're looking for.
327 </para>
328
329 <para>
330 <command>find ... chmod ...</command>: These commands correct the
331 permissions in the shipped documentation tar file.
332 </para>
333
334 </sect2>
335
336 <sect2 role="configuration">
337 <title>Configuring Git</title>
338
339 <sect3 id="git-config">
340 <title>Config Files</title>
341 <para>
342 <filename>~/.gitconfig</filename> and
343 <filename>/etc/gitconfig</filename>
344 </para>
345
346 <indexterm zone="git git-config">
347 <primary sortas="e-AA.gitconfig">~/.gitconfig</primary>
348 </indexterm>
349
350 <indexterm zone="git git-config">
351 <primary sortas="e-etc-gitconfig">/etc/gitconfig</primary>
352 </indexterm>
353
354 </sect3>
355
356 </sect2>
357
358 <sect2 role="content">
359 <title>Contents</title>
360
361 <segmentedlist>
362 <segtitle>Installed Programs</segtitle>
363 <segtitle>Installed Libraries</segtitle>
364 <segtitle>Installed Directories</segtitle>
365
366 <seglistitem>
367 <seg>
368 git, git-receive-pack, git-upload-archive, and
369 git-upload-pack (hardlinked to each
370 other), git-cvsserver, git-shell, gitk, and scalar
371 </seg>
372 <seg>
373 None
374 </seg>
375 <seg>
376 /usr/libexec/git-core,
377 /usr/lib/perl5/&lfs-perl-version;/site_perl/Git, and
378 /usr/share/{doc/git-&git-version;,git-core,git-gui,gitk,gitweb}
379 </seg>
380 </seglistitem>
381 </segmentedlist>
382
383 <variablelist>
384 <bridgehead renderas="sect3">Short Descriptions</bridgehead>
385 <?dbfo list-presentation="list"?>
386 <?dbhtml list-presentation="table"?>
387
388 <varlistentry id="git-prog">
389 <term><command>git</command></term>
390 <listitem>
391 <para>
392 is the stupid content tracker
393 </para>
394 <indexterm zone="git git-prog">
395 <primary sortas="b-git">git</primary>
396 </indexterm>
397 </listitem>
398 </varlistentry>
399
400 <varlistentry id="git-cvsserver">
401 <term><command>git-cvsserver</command></term>
402 <listitem>
403 <para>
404 is a CVS server emulator for <application>Git</application>
405 </para>
406 <indexterm zone="git git-cvsserver">
407 <primary sortas="b-git-cvsserver">git-cvsserver</primary>
408 </indexterm>
409 </listitem>
410 </varlistentry>
411
412 <varlistentry id="gitk">
413 <term><command>gitk</command></term>
414 <listitem>
415 <para>
416 is a graphical <application>Git</application> repository browser
417 (needs <xref linkend="tk"/>)
418 </para>
419 <indexterm zone="git gitk">
420 <primary sortas="b-gitk">gitk</primary>
421 </indexterm>
422 </listitem>
423 </varlistentry>
424
425 <varlistentry id="git-receive-pack">
426 <term><command>git-receive-pack</command></term>
427 <listitem>
428 <para>
429 is invoked by <command>git send-pack</command> and updates the
430 repository with the information fed from the remote end
431 </para>
432 <indexterm zone="git git-receive-pack">
433 <primary sortas="b-git-receive-pack">git-receive-pack</primary>
434 </indexterm>
435 </listitem>
436 </varlistentry>
437
438 <varlistentry id="git-shell">
439 <term><command>git-shell</command></term>
440 <listitem>
441 <para>
442 is a login shell for SSH accounts to provide restricted Git
443 access
444 </para>
445 <indexterm zone="git git-shell">
446 <primary sortas="b-git-shell">git-shell</primary>
447 </indexterm>
448 </listitem>
449 </varlistentry>
450
451 <varlistentry id="git-upload-archive">
452 <term><command>git-upload-archive</command></term>
453 <listitem>
454 <para>
455 is invoked by <command>git archive --remote</command> and sends
456 a generated archive to the other end over the git protocol
457 </para>
458 <indexterm zone="git git-upload-archive">
459 <primary sortas="b-git-upload-archive">git-upload-archive</primary>
460 </indexterm>
461 </listitem>
462 </varlistentry>
463
464 <varlistentry id="git-upload-pack">
465 <term><command>git-upload-pack</command></term>
466 <listitem>
467 <para>
468 is invoked by <command>git fetch-pack</command>, it discovers
469 what objects the other side is missing, and sends them after
470 packing
471 </para>
472 <indexterm zone="git git-upload-pack">
473 <primary sortas="b-git-upload-pack">git-upload-pack</primary>
474 </indexterm>
475 </listitem>
476 </varlistentry>
477
478 <varlistentry id="scalar">
479 <term><command>scalar</command></term>
480 <listitem>
481 <para>
482 is a repository management tool that optimizes Git for use in
483 large repositories
484 </para>
485 <indexterm zone="git scalar">
486 <primary sortas="b-scalar">scalar</primary>
487 </indexterm>
488 </listitem>
489 </varlistentry>
490 </variablelist>
491
492 </sect2>
493
494</sect1>
Note: See TracBrowser for help on using the repository browser.