source: general/prog/git.xml@ 45ab6c7

11.0 ken/refactor-virt lazarus qt5new trunk
Last change on this file since 45ab6c7 was 45ab6c7, checked in by Xi Ruoyao <xry111@…>, 6 months ago

more SVN prop clean up

Remove "$LastChanged$" everywhere, and also some unused $Date$

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