source: general/prog/git.xml@ 948ffd7b

12.1 ken/TL2024 lazarus plabs/newcss rahul/power-profiles-daemon trunk xry111/llvm18
Last change on this file since 948ffd7b was 01b92cda, checked in by Bruce Dubbs <bdubbs@…>, 6 months ago

Update to git-2.43.0.

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