source: general/prog/git.xml@ 82541b1

11.2 11.3 12.0 12.1 kea ken/TL2024 ken/inkscape-core-mods ken/tuningfonts lazarus lxqt plabs/newcss plabs/python-mods python3.11 qt5new rahul/power-profiles-daemon renodr/vulkan-addition trunk xry111/llvm18 xry111/soup3 xry111/xf86-video-removal
Last change on this file since 82541b1 was 82541b1, checked in by Tim Tassonis <stuff@…>, 22 months ago

Update to curl-7.84.0.
Update to git-2.37.0.
  • Property mode set to 100644
File size: 16.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 "9716e2b4be3f9e1105f23aa1f80a37e4">
12
13 <!ENTITY git-size "6.7 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 "351 MB (with downloaded documentation, add 17 MB to build 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.4 SBU (with parallelism=4; add 0.4 SBU for building documentation and 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 <sect1info>
26 <date>$Date$</date>
27 </sect1info>
28
29 <title>Git-&git-version;</title>
30
31 <indexterm zone="git">
32 <primary sortas="a-Git">Git</primary>
33 </indexterm>
34
35 <sect2 role="package">
36 <title>Introduction to Git</title>
37
38 <para>
39 <application>Git</application> is a free and open source, distributed
40 version control system designed to handle everything from small to very
41 large projects with speed and efficiency. Every
42 <application>Git</application> clone is a full-fledged repository with
43 complete history and full revision tracking capabilities, not dependent
44 on network access or a central server. Branching and merging are fast and
45 easy to do. <application>Git</application> is used for version control of
46 files, much like tools such as <xref linkend="mercurial"/>,
47 <application>Bazaar</application>, <xref linkend="subversion"/>,
48 <ulink url="http://www.nongnu.org/cvs/">CVS</ulink>,
49 <application>Perforce</application>, and
50 <application>Team Foundation Server</application>.
51 </para>
52
53 &lfs111_checked;
54
55 <bridgehead renderas="sect3">Package Information</bridgehead>
56 <itemizedlist spacing="compact">
57 <listitem>
58 <para>
59 Download (HTTP): <ulink url="&git-download-http;"/>
60 </para>
61 </listitem>
62 <listitem>
63 <para>
64 Download (FTP): <ulink url="&git-download-ftp;"/>
65 </para>
66 </listitem>
67 <listitem>
68 <para>
69 Download MD5 sum: &git-md5sum;
70 </para>
71 </listitem>
72 <listitem>
73 <para>
74 Download size: &git-size;
75 </para>
76 </listitem>
77 <listitem>
78 <para>
79 Estimated disk space required: &git-buildsize;
80 </para>
81 </listitem>
82 <listitem>
83 <para>
84 Estimated build time: &git-time;
85 </para>
86 </listitem>
87 </itemizedlist>
88
89 <bridgehead renderas="sect3">Additional Downloads</bridgehead>
90 <itemizedlist spacing="compact">
91 <listitem>
92 <para>
93 <ulink url="&git-root;/git-manpages-&git-version;.tar.xz">
94 &git-root;/git-manpages-&git-version;.tar.xz</ulink>
95 (not needed if you've installed <xref linkend="asciidoc"/>,
96 <xref linkend="xmlto"/>, and prefer to rebuild them)
97 </para>
98 </listitem>
99 <listitem>
100 <para>
101 <ulink url="&git-root;/git-htmldocs-&git-version;.tar.xz">
102 &git-root;/git-htmldocs-&git-version;.tar.xz</ulink>
103 and other docs (not needed if you've installed
104 <xref linkend="asciidoc"/> and want to rebuild the documentation).
105 </para>
106 </listitem>
107 </itemizedlist>
108
109 <bridgehead renderas="sect3">Git Dependencies</bridgehead>
110
111 <bridgehead renderas="sect4">Recommended</bridgehead>
112 <para role="recommended">
113 <xref linkend="curl"/> (needed to use <application>Git</application> over
114 http, https, ftp or ftps)
115 </para>
116
117 <bridgehead renderas="sect4">Optional</bridgehead>
118 <para role="optional">
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 </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="http://dblatex.sourceforge.net/">dblatex</ulink>
146 (for the PDF version of the user manual), and
147 <ulink url="http://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 test</command>. If run as a normal user, 0 tests should be
192 reported as failed in the final summary.
193 </para>
194
195 <para>
196 Now, as the <systemitem class="username">root</systemitem>
197 user:
198 </para>
199
200<screen role="root"><userinput>make perllibdir=/usr/lib/perl5/&lfs-perl-version;/site_perl install</userinput></screen>
201
202<!-- ==== Method 1 for docs ====== -->
203 <bridgehead renderas="sect3">If you created the man pages and/or html docs</bridgehead>
204
205 <para>
206 Install the man pages as the
207 <systemitem class="username">root</systemitem> user:
208 </para>
209
210<screen role="root"
211 remap="doc"><userinput>make install-man</userinput></screen>
212
213 <para>
214 Install the html docs as the
215 <systemitem class="username">root</systemitem> user:
216 </para>
217
218<screen role="root"
219 remap="doc"><userinput>make htmldir=/usr/share/doc/git-&git-version; install-html</userinput></screen>
220
221<!-- ==== Method 2 for docs ====== -->
222 <bridgehead renderas="sect3">If you downloaded the man pages and/or html docs</bridgehead>
223
224 <para>
225 If you downloaded the man pages untar them as the
226 <systemitem class="username">root</systemitem> user:
227 </para>
228
229<screen role="root"><userinput>tar -xf ../git-manpages-&git-version;.tar.xz \
230 -C /usr/share/man --no-same-owner --no-overwrite-dir</userinput></screen>
231
232 <para>
233 If you downloaded the html docs untar them as the
234 <systemitem class="username">root</systemitem> user:
235 </para>
236
237<screen role="root"><userinput>mkdir -vp /usr/share/doc/git-&git-version; &amp;&amp;
238tar -xf ../git-htmldocs-&git-version;.tar.xz \
239 -C /usr/share/doc/git-&git-version; --no-same-owner --no-overwrite-dir &amp;&amp;
240
241find /usr/share/doc/git-&git-version; -type d -exec chmod 755 {} \; &amp;&amp;
242find /usr/share/doc/git-&git-version; -type f -exec chmod 644 {} \;</userinput></screen>
243
244<!-- ==== Reorganize docs ====== -->
245 <bridgehead renderas="sect3">Reorganize text and html in the html-docs (both methods)</bridgehead>
246
247 <para>
248 For both methods, the html-docs include a lot of plain text files.
249 Reorganize the files as the
250 <systemitem class="username">root</systemitem> user:
251 </para>
252
253<screen role="root"><userinput>mkdir -vp /usr/share/doc/git-&git-version;/man-pages/{html,text} &amp;&amp;
254mv /usr/share/doc/git-&git-version;/{git*.txt,man-pages/text} &amp;&amp;
255mv /usr/share/doc/git-&git-version;/{git*.,index.,man-pages/}html &amp;&amp;
256
257mkdir -vp /usr/share/doc/git-&git-version;/technical/{html,text} &amp;&amp;
258mv /usr/share/doc/git-&git-version;/technical/{*.txt,text} &amp;&amp;
259mv /usr/share/doc/git-&git-version;/technical/{*.,}html &amp;&amp;
260
261mkdir -vp /usr/share/doc/git-&git-version;/howto/{html,text} &amp;&amp;
262mv /usr/share/doc/git-&git-version;/howto/{*.txt,text} &amp;&amp;
263mv /usr/share/doc/git-&git-version;/howto/{*.,}html &amp;&amp;
264
265sed -i '/^&lt;a href=/s|howto/|&amp;html/|' /usr/share/doc/git-&git-version;/howto-index.html &amp;&amp;
266sed -i '/^\* link:/s|howto/|&amp;html/|' /usr/share/doc/git-&git-version;/howto-index.txt</userinput></screen>
267
268 </sect2>
269
270 <sect2 role="commands">
271 <title>Command Explanations</title>
272
273 <para>
274 <parameter>--with-gitconfig=/etc/gitconfig</parameter>: This sets
275 <filename>/etc/gitconfig</filename> as the file that stores
276 the default, system wide, <application>Git</application>
277 settings.
278 </para>
279
280 <para>
281 <parameter>--with-python=python3</parameter>: Use this switch to use
282 <application>Python 3</application>, instead of the EOL'ed
283 <application>Python 2</application>. Python is used for the
284 <command>git p4</command> interface to Perforce repositories,
285 and also used in some tests.
286 </para>
287
288 <para>
289 <option>--with-libpcre2</option>: Use this switch if
290 <application>PCRE2</application> is installed and has been built with
291 the non-default JIT enabled.
292 </para>
293
294 <para>
295 <option>--with-libpcre</option>: As an alternative to PCRE2, use this
296 switch if the deprecated <application>PCRE</application> is installed
297 and has been built with the non-default JIT enabled.
298 </para>
299
300 <para>
301 <command>tar -xf ../git-manpages-&git-version;.tar.gz -C
302 /usr/share/man --no-same-owner</command>: This untars
303 <filename>git-manpages-&git-version;.tar.gz</filename>. The
304 <option>-C</option> option makes tar change directory to
305 <filename class="directory">/usr/share/man</filename> before
306 it starts to decompress the docs. The <option>--no-same-owner</option>
307 option stops tar from preserving the user and group details of the
308 files. This is useful as that user or group may not exist on your
309 system; this could (potentially) be a security risk.
310 </para>
311
312 <para>
313 <command>mv /usr/share/doc/git-&git-version; ...</command>: These
314 commands move some of the files into subfolders to make it easier to sort
315 through the docs and find what you're looking for.
316 </para>
317
318 <para>
319 <command>find ... chmod ...</command>: These commands correct the
320 permissions in the shipped documentation tar file.
321 </para>
322
323 </sect2>
324
325 <sect2 role="configuration">
326 <title>Configuring Git</title>
327
328 <sect3 id="git-config">
329 <title>Config Files</title>
330 <para>
331 <filename>~/.gitconfig</filename> and
332 <filename>/etc/gitconfig</filename>
333 </para>
334
335 <indexterm zone="git git-config">
336 <primary sortas="e-AA.gitconfig">~/.gitconfig</primary>
337 </indexterm>
338
339 <indexterm zone="git git-config">
340 <primary sortas="e-etc-gitconfig">/etc/gitconfig</primary>
341 </indexterm>
342
343 </sect3>
344
345 </sect2>
346
347 <sect2 role="content">
348 <title>Contents</title>
349
350 <segmentedlist>
351 <segtitle>Installed Programs</segtitle>
352 <segtitle>Installed Libraries</segtitle>
353 <segtitle>Installed Directories</segtitle>
354
355 <seglistitem>
356 <seg>
357 git, git-receive-pack, git-upload-archive, and
358 git-upload-pack (hardlinked to each
359 other), git-cvsserver, git-shell, and gitk
360 </seg>
361 <seg>
362 None
363 </seg>
364 <seg>
365 /usr/libexec/git-core, and
366 /usr/share/{doc/git-&git-version;,git-core,git-gui,gitk,gitweb}
367 </seg>
368 </seglistitem>
369 </segmentedlist>
370
371 <variablelist>
372 <bridgehead renderas="sect3">Short Descriptions</bridgehead>
373 <?dbfo list-presentation="list"?>
374 <?dbhtml list-presentation="table"?>
375
376 <varlistentry id="git-prog">
377 <term><command>git</command></term>
378 <listitem>
379 <para>
380 is the stupid content tracker
381 </para>
382 <indexterm zone="git git-prog">
383 <primary sortas="b-git">git</primary>
384 </indexterm>
385 </listitem>
386 </varlistentry>
387
388 <varlistentry id="git-cvsserver">
389 <term><command>git-cvsserver</command></term>
390 <listitem>
391 <para>
392 is a CVS server emulator for <application>Git</application>
393 </para>
394 <indexterm zone="git git-cvsserver">
395 <primary sortas="b-git-cvsserver">git-cvsserver</primary>
396 </indexterm>
397 </listitem>
398 </varlistentry>
399
400 <varlistentry id="gitk">
401 <term><command>gitk</command></term>
402 <listitem>
403 <para>
404 is a graphical <application>Git</application> repository browser
405 (needs <xref linkend="tk"/>)
406 </para>
407 <indexterm zone="git gitk">
408 <primary sortas="b-gitk">gitk</primary>
409 </indexterm>
410 </listitem>
411 </varlistentry>
412
413 <varlistentry id="git-receive-pack">
414 <term><command>git-receive-pack</command></term>
415 <listitem>
416 <para>
417 is invoked by <command>git send-pack</command> and updates the
418 repository with the information fed from the remote end
419 </para>
420 <indexterm zone="git git-receive-pack">
421 <primary sortas="b-git-receive-pack">git-receive-pack</primary>
422 </indexterm>
423 </listitem>
424 </varlistentry>
425
426 <varlistentry id="git-shell">
427 <term><command>git-shell</command></term>
428 <listitem>
429 <para>
430 is a login shell for SSH accounts to provide restricted Git
431 access
432 </para>
433 <indexterm zone="git git-shell">
434 <primary sortas="b-git-shell">git-shell</primary>
435 </indexterm>
436 </listitem>
437 </varlistentry>
438
439 <varlistentry id="git-upload-archive">
440 <term><command>git-upload-archive</command></term>
441 <listitem>
442 <para>
443 is invoked by <command>git archive --remote</command> and sends
444 a generated archive to the other end over the git protocol
445 </para>
446 <indexterm zone="git git-upload-archive">
447 <primary sortas="b-git-upload-archive">git-upload-archive</primary>
448 </indexterm>
449 </listitem>
450 </varlistentry>
451
452 <varlistentry id="git-upload-pack">
453 <term><command>git-upload-pack</command></term>
454 <listitem>
455 <para>
456 is invoked by <command>git fetch-pack</command>, it discovers
457 what objects the other side is missing, and sends them after
458 packing
459 </para>
460 <indexterm zone="git git-upload-pack">
461 <primary sortas="b-git-upload-pack">git-upload-pack</primary>
462 </indexterm>
463 </listitem>
464 </varlistentry>
465
466 </variablelist>
467
468 </sect2>
469
470</sect1>
Note: See TracBrowser for help on using the repository browser.