source: general/prog/git.xml@ 06908bf6

10.0 10.1 11.0 9.0 9.1 ken/refactor-virt lazarus qt5new trunk xry111/git-date xry111/git-date-for-trunk xry111/git-date-test
Last change on this file since 06908bf6 was 06908bf6, checked in by Pierre Labastie <pieere@…>, 2 years ago

Add remap="doc", remap="test", or just realign them

git-svn-id: svn://svn.linuxfromscratch.org/BLFS/trunk/BOOK@21946 af4574ff-66df-0310-9fd7-8a98e5e911e0

  • Property mode set to 100644
File size: 15.5 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 "fcaf01506175c56fe88d887f1ff02ce8">
12 <!ENTITY git-size "5.4 MB">
13 <!-- using gcc-8.1 the build and install are much bigger than with gcc-7.3 -->
14 <!ENTITY git-buildsize "479 MB (with downloaded documentation)">
15 <!ENTITY git-time "0.4 SBU (with parallelism=4; add 8.0 SBU for tests)">
16]>
17
18<sect1 id="git" xreflabel="git-&git-version;">
19 <?dbhtml filename="git.html"?>
20
21 <sect1info>
22 <othername>$LastChangedBy$</othername>
23 <date>$Date$</date>
24 </sect1info>
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="http://www.nongnu.org/cvs/">CVS</ulink>,
46 <application>Perforce</application>, and
47 <application>Team Foundation Server</application>.
48 </para>
49
50 &lfs84_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="pcre2"/> (<emphasis>or</emphasis> the deprecated <xref
117 linkend="pcre"/>), in either case configured with
118 <literal>--enable-jit</literal>,
119 <xref linkend="python2"/>,
120 <xref linkend="subversion"/> with Perl bindings (for <command>git
121 svn</command>),
122 <xref role="runtime" linkend="tk"/>
123 (gitk, a simple <application>Git</application>
124 repository viewer, uses <application>Tk</application> at runtime), and
125 <xref linkend="valgrind"/>
126 </para>
127
128 <bridgehead renderas="sect4">Optional (to create the man pages, html docs
129 and other docs)</bridgehead>
130 <para role="optional">
131 <xref linkend="xmlto"/> and
132 <xref linkend="asciidoc"/> or
133 <ulink url="http://asciidoctor.org/">AsciiDoctor</ulink>, and also
134 <ulink url="http://dblatex.sourceforge.net/">dblatex</ulink>
135 (for the PDF version of the user manual), and
136 <ulink url="http://docbook2x.sourceforge.net/">docbook2x</ulink> to
137 create info pages
138 </para>
139
140 <para condition="html" role="usernotes">User Notes:
141 <ulink url="&blfs-wiki;/git"/>
142 </para>
143 </sect2>
144
145 <sect2 role="installation">
146 <title>Installation of Git</title>
147
148 <para>
149 Install <application>Git</application> by running the following
150 commands:
151 </para>
152
153<screen><userinput>./configure --prefix=/usr --with-gitconfig=/etc/gitconfig &amp;&amp;
154make</userinput></screen>
155
156 <para>
157 You can build the man pages and/or html docs, or
158 use downloaded ones. If you choose to build them, use next two following
159 instructions.
160 </para>
161
162 <para>
163 If you have installed <xref linkend="asciidoc"/> you can
164 create the html version of the man pages and other docs:
165 </para>
166
167<screen remap="doc"><userinput>make html</userinput></screen>
168
169 <para>
170 If you have installed <xref linkend="asciidoc"/> and
171 <xref linkend="xmlto"/> you can create the man pages:
172 </para>
173
174<screen remap="doc"><userinput>make man</userinput></screen>
175
176 <para>
177 The test suite can be run in parallel mode. To run the test suite, issue:
178 <command>make test</command>. If run as a normal user, 0 tests should be
179 reported as failed in the final summary.
180 </para>
181
182 <para>
183 Now, as the <systemitem class="username">root</systemitem>
184 user:
185 </para>
186
187<screen role="root"><userinput>make install</userinput></screen>
188
189<!-- ==== Method 1 for docs ====== -->
190 <bridgehead renderas="sect3">If you created the man pages and/or html docs</bridgehead>
191
192 <para>
193 Install the man pages as
194 <systemitem class="username">root</systemitem> user:
195 </para>
196
197<screen role="root"
198 remap="doc"><userinput>make install-man</userinput></screen>
199
200 <para>
201 Install the html docs as
202 <systemitem class="username">root</systemitem> user:
203 </para>
204
205<screen role="root"
206 remap="doc"><userinput>make htmldir=/usr/share/doc/git-&git-version; install-html</userinput></screen>
207
208<!-- ==== Method 2 for docs ====== -->
209 <bridgehead renderas="sect3">If you downloaded the man pages and/or html docs</bridgehead>
210
211 <para>
212 If you downloaded the man pages untar them as the
213 <systemitem class="username">root</systemitem> user:
214 </para>
215
216<screen role="root"><userinput>tar -xf ../git-manpages-&git-version;.tar.xz \
217 -C /usr/share/man --no-same-owner --no-overwrite-dir</userinput></screen>
218
219 <para>
220 If you downloaded the html docs untar them as the
221 <systemitem class="username">root</systemitem> user:
222 </para>
223
224<screen role="root"><userinput>mkdir -vp /usr/share/doc/git-&git-version; &amp;&amp;
225tar -xf ../git-htmldocs-&git-version;.tar.xz \
226 -C /usr/share/doc/git-&git-version; --no-same-owner --no-overwrite-dir &amp;&amp;
227
228find /usr/share/doc/git-&git-version; -type d -exec chmod 755 {} \; &amp;&amp;
229find /usr/share/doc/git-&git-version; -type f -exec chmod 644 {} \;</userinput></screen>
230
231<!-- ==== Reorganize docs ====== -->
232 <bridgehead renderas="sect3">Reorganize text and html in the html-docs (both methods)</bridgehead>
233
234 <para>
235 For both methods, the html-docs include a lot of plain text files.
236 Reorganize the files as the
237 <systemitem class="username">root</systemitem> user:
238 </para>
239
240<screen role="root"><userinput>mkdir -vp /usr/share/doc/git-&git-version;/man-pages/{html,text} &amp;&amp;
241mv /usr/share/doc/git-&git-version;/{git*.txt,man-pages/text} &amp;&amp;
242mv /usr/share/doc/git-&git-version;/{git*.,index.,man-pages/}html &amp;&amp;
243
244mkdir -vp /usr/share/doc/git-&git-version;/technical/{html,text} &amp;&amp;
245mv /usr/share/doc/git-&git-version;/technical/{*.txt,text} &amp;&amp;
246mv /usr/share/doc/git-&git-version;/technical/{*.,}html &amp;&amp;
247
248mkdir -vp /usr/share/doc/git-&git-version;/howto/{html,text} &amp;&amp;
249mv /usr/share/doc/git-&git-version;/howto/{*.txt,text} &amp;&amp;
250mv /usr/share/doc/git-&git-version;/howto/{*.,}html &amp;&amp;
251
252sed -i '/^&lt;a href=/s|howto/|&amp;html/|' /usr/share/doc/git-&git-version;/howto-index.html &amp;&amp;
253sed -i '/^\* link:/s|howto/|&amp;html/|' /usr/share/doc/git-&git-version;/howto-index.txt</userinput></screen>
254
255 </sect2>
256
257 <sect2 role="commands">
258 <title>Command Explanations</title>
259
260 <para>
261 <parameter>--with-gitconfig=/etc/gitconfig</parameter>: This sets
262 <filename>/etc/gitconfig</filename> as the file that stores
263 the default, system wide, <application>Git</application>
264 settings.
265 </para>
266
267 <para>
268 <option>--with-python=python3</option>: Use this switch to allow using
269 <application>Python 3</application>. <application>Python</application> is
270 only used for the <command>git p4</command> interface to Perforce
271 repositories.
272 </para>
273
274 <para>
275 <option>--with-libpcre2</option>: Use this switch if
276 <application>PCRE2</application> is installed and has been built with
277 the non-default JIT enabled.
278 </para>
279
280 <para>
281 <option>--with-libpcre</option>: As an alternative to PCRE2, use this
282 switch if the deprecated <application>PCRE</application> is installed
283 and has been built with the non-default JIT enabled.
284 </para>
285
286 <para>
287 <command>tar -xf ../git-manpages-&git-version;.tar.gz -C
288 /usr/share/man --no-same-owner</command>: This untars
289 <filename>git-manpages-&git-version;.tar.gz</filename>. The
290 <option>-C</option> option makes tar change directory to
291 <filename class="directory">/usr/share/man</filename> before
292 it starts to decompress the docs. The <option>--no-same-owner</option>
293 option stops tar from preserving the user and group details of the
294 files. This is useful as that user or group may not exist on your
295 system; this could (potentially) be a security risk.
296 </para>
297
298 <para>
299 <command>mv /usr/share/doc/git-&git-version; ...</command>: These
300 commands move some of the files into subfolders to make it easier to sort
301 through the docs and find what you're looking for.
302 </para>
303
304 <para>
305 <command>find ... chmod ...</command>: These commands correct the
306 permissions in the shipped documentation tar file.
307 </para>
308
309 </sect2>
310
311 <sect2 role="configuration">
312 <title>Configuring Git</title>
313
314 <sect3 id="git-config">
315 <title>Config Files</title>
316 <para>
317 <filename>~/.gitconfig</filename> and
318 <filename>/etc/gitconfig</filename>
319 </para>
320
321 <indexterm zone="git git-config">
322 <primary sortas="e-AA.gitconfig">~/.gitconfig</primary>
323 </indexterm>
324
325 <indexterm zone="git git-config">
326 <primary sortas="e-etc-gitconfig">/etc/gitconfig</primary>
327 </indexterm>
328
329 </sect3>
330
331 </sect2>
332
333 <sect2 role="content">
334 <title>Contents</title>
335
336 <segmentedlist>
337 <segtitle>Installed Programs</segtitle>
338 <segtitle>Installed Libraries</segtitle>
339 <segtitle>Installed Directories</segtitle>
340
341 <seglistitem>
342 <seg>
343 git, git-receive-pack and git-upload-archive (hardlinked to each
344 other), git-cvsserver, git-shell, git-upload-pack, and gitk
345 </seg>
346 <seg>
347 None
348 </seg>
349 <seg>
350 /usr/share/perl5/Git,
351 <!-- I do NOT think this is in our %INC search path. -->
352 /usr/libexec/git-core and
353 /usr/share/{doc/git-&git-version;,git-core,git-gui,gitk,gitweb}
354 </seg>
355 </seglistitem>
356 </segmentedlist>
357
358 <variablelist>
359 <bridgehead renderas="sect3">Short Descriptions</bridgehead>
360 <?dbfo list-presentation="list"?>
361 <?dbhtml list-presentation="table"?>
362
363 <varlistentry id="git-prog">
364 <term><command>git</command></term>
365 <listitem>
366 <para>
367 is the stupid content tracker.
368 </para>
369 <indexterm zone="git git-prog">
370 <primary sortas="b-git">git</primary>
371 </indexterm>
372 </listitem>
373 </varlistentry>
374
375 <varlistentry id="git-cvsserver">
376 <term><command>git-cvsserver</command></term>
377 <listitem>
378 <para>
379 is a CVS server emulator for <application>Git</application>.
380 </para>
381 <indexterm zone="git git-cvsserver">
382 <primary sortas="b-git-cvsserver">git-cvsserver</primary>
383 </indexterm>
384 </listitem>
385 </varlistentry>
386
387 <varlistentry id="gitk">
388 <term><command>gitk</command></term>
389 <listitem>
390 <para>
391 is a graphical <application>Git</application> repository browser
392 (needs <xref linkend="tk"/>).
393 </para>
394 <indexterm zone="git gitk">
395 <primary sortas="b-gitk">gitk</primary>
396 </indexterm>
397 </listitem>
398 </varlistentry>
399
400 <varlistentry id="git-receive-pack">
401 <term><command>git-receive-pack</command></term>
402 <listitem>
403 <para>
404 is invoked by <command>git send-pack</command> and updates the
405 repository with the information fed from the remote end.
406 </para>
407 <indexterm zone="git git-receive-pack">
408 <primary sortas="b-git-receive-pack">git-receive-pack</primary>
409 </indexterm>
410 </listitem>
411 </varlistentry>
412
413 <varlistentry id="git-shell">
414 <term><command>git-shell</command></term>
415 <listitem>
416 <para>
417 is a login shell for SSH accounts to provide restricted Git
418 access.
419 </para>
420 <indexterm zone="git git-shell">
421 <primary sortas="b-git-shell">git-shell</primary>
422 </indexterm>
423 </listitem>
424 </varlistentry>
425
426 <varlistentry id="git-upload-archive">
427 <term><command>git-upload-archive</command></term>
428 <listitem>
429 <para>
430 is invoked by <command>git archive --remote</command> and sends
431 a generated archive to the other end over the git protocol.
432 </para>
433 <indexterm zone="git git-upload-archive">
434 <primary sortas="b-git-upload-archive">git-upload-archive</primary>
435 </indexterm>
436 </listitem>
437 </varlistentry>
438
439 <varlistentry id="git-upload-pack">
440 <term><command>git-upload-pack</command></term>
441 <listitem>
442 <para>
443 is invoked by <command>git fetch-pack</command>, it discovers
444 what objects the other side is missing, and sends them after
445 packing.
446 </para>
447 <indexterm zone="git git-upload-pack">
448 <primary sortas="b-git-upload-pack">git-upload-pack</primary>
449 </indexterm>
450 </listitem>
451 </varlistentry>
452
453 </variablelist>
454
455 </sect2>
456
457</sect1>
Note: See TracBrowser for help on using the repository browser.