source: general/prog/git.xml@ d1c51434

10.0 10.1 11.0 7.10 7.8 7.9 8.0 8.1 8.2 8.3 8.4 9.0 9.1 basic bdubbs/svn elogind ken/refactor-virt lazarus nosym perl-modules qt5new trunk upgradedb xry111/git-date xry111/git-date-for-trunk xry111/git-date-test
Last change on this file since d1c51434 was d1c51434, checked in by Fernando de Oliveira <fernando@…>, 6 years ago
  • Update to x264-snapshot-20150908-2245.
  • Update to mplayer-SVN-r37520.
  • Remove "CVS-1.11.23" and "Running a CVS Server".
  • Update to joe-4.1.

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

  • Property mode set to 100644
File size: 14.4 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 "https://www.kernel.org/pub/software/scm/git" >
8
9 <!ENTITY git-download-http "&git-root;/git-&git-version;.tar.xz">
10 <!ENTITY git-download-ftp "ftp://ftp.kernel.org/pub/software/scm/git/git-&git-version;.tar.xz">
11 <!ENTITY git-md5sum "f108b475a0aa30e9587be4295ab0bb09">
12 <!ENTITY git-size "3.6 MB">
13 <!ENTITY git-buildsize "343 MB (357 MB, with tests and downloaded documents)">
14 <!ENTITY git-time "0.7 SBU (4.8 SBU, using -j8, with tests and downloaded documents)">
15]>
16
17<sect1 id="git" xreflabel="git-&git-version;">
18 <?dbhtml filename="git.html"?>
19
20 <sect1info>
21 <othername>$LastChangedBy$</othername>
22 <date>$Date$</date>
23 </sect1info>
24
25 <title>Git-&git-version;</title>
26
27 <indexterm zone="git">
28 <primary sortas="a-Git">Git</primary>
29 </indexterm>
30
31 <sect2 role="package">
32 <title>Introduction to Git</title>
33
34 <para>
35
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
49 </para>
50
51 &lfs77_checked; &gcc5_checked;
52
53 <bridgehead renderas="sect3">Package Information</bridgehead>
54 <itemizedlist spacing="compact">
55 <listitem>
56 <para>
57 Download (HTTP): <ulink url="&git-download-http;"/>
58 </para>
59 </listitem>
60 <listitem>
61 <para>
62 Download (FTP): <ulink url="&git-download-ftp;"/>
63 </para>
64 </listitem>
65 <listitem>
66 <para>
67 Download MD5 sum: &git-md5sum;
68 </para>
69 </listitem>
70 <listitem>
71 <para>
72 Download size: &git-size;
73 </para>
74 </listitem>
75 <listitem>
76 <para>
77 Estimated disk space required: &git-buildsize;
78 </para>
79 </listitem>
80 <listitem>
81 <para>
82 Estimated build time: &git-time;
83 </para>
84 </listitem>
85 </itemizedlist>
86
87 <bridgehead renderas="sect3">Additional Downloads</bridgehead>
88 <itemizedlist spacing="compact">
89 <listitem>
90 <para>
91 <ulink url="&git-root;/git-manpages-&git-version;.tar.xz">
92 &git-root;/git-manpages-&git-version;.tar.xz</ulink>
93 (if you prefer the original, not needed if you've installed asciidoc
94 and xmlto and prefer to build them).
95 </para>
96 </listitem>
97 <listitem>
98 <para>
99 <ulink url="&git-root;/git-htmldocs-&git-version;.tar.xz">
100 &git-root;/git-htmldocs-&git-version;.tar.xz</ulink>
101 and other docs (if you prefer the original, not needed if you've
102 installed asciidoc and prefer to build them).
103 </para>
104 </listitem>
105 </itemizedlist>
106
107 <bridgehead renderas="sect3">Git Dependencies</bridgehead>
108
109 <bridgehead renderas="sect4">Recommended</bridgehead>
110 <para role="recommended">
111 <xref linkend="curl"/> (needed to use <application>Git</application> over http,
112 https, ftp or ftps),
113 <xref linkend="openssl"/>, and
114 <xref linkend="python2"/>
115 </para>
116
117 <bridgehead renderas="sect4">Optional</bridgehead>
118 <para role="optional">
119 <xref linkend="pcre"/>,
120 <xref linkend="subversion"/> with Perl bindings (for <command>git svn</command>),
121 <xref linkend="tk"/> (gitk, a simple <application>Git</application>
122 repository viewer, uses <application>Tk</application> at runtime), and
123 <xref linkend="valgrind"/>
124 </para>
125
126 <bridgehead renderas="sect4">Optional (to create the man pages and html docs)</bridgehead>
127 <para>
128 <xref linkend="xmlto"/> and
129 <ulink url="http://www.methods.co.nz/asciidoc/">AsciiDoc</ulink> or
130 <ulink url="http://asciidoctor.org/">AsciiDoctor</ulink>
131 </para>
132
133 <para condition="html" role="usernotes">User Notes:
134 <ulink url="&blfs-wiki;/git"/>
135 </para>
136 </sect2>
137
138 <sect2 role="installation">
139 <title>Installation of Git</title>
140
141 <para>
142 Install <application>Git</application> by running the following
143 commands:
144 </para>
145
146<screen><userinput>./configure --prefix=/usr --with-gitconfig=/etc/gitconfig &amp;&amp;
147make</userinput></screen>
148
149 <para>
150 You can build the man pages and/or html docs, or
151 use downloaded ones. If you choose to build them, use next two following
152 instructions.
153 </para>
154
155 <para>
156 If you have installed <ulink
157 url="http://www.methods.co.nz/asciidoc/">AsciiDoc</ulink> you can
158 create the html version of the man pages and other docs:
159 </para>
160
161<screen><userinput>make html</userinput></screen>
162
163 <para>
164 If you have installed <ulink
165 url="http://www.methods.co.nz/asciidoc/">AsciiDoc</ulink> and
166 <xref linkend="xmlto"/> you can create the man pages:
167 </para>
168
169<screen><userinput>make man</userinput></screen>
170
171 <para>
172 The test suite can be run in parallel mode. To run the test suite, issue:
173 <command>make test</command>.
174 </para>
175
176 <para>
177 Now, as the <systemitem class="username">root</systemitem>
178 user:
179 </para>
180
181<screen role="root"><userinput>make install</userinput></screen>
182
183<!-- ==== Method 1 for docs ====== -->
184 <bridgehead renderas="sect3">If you created the man pages and/or html docs</bridgehead>
185
186 <para>
187 Install the man pages as
188 <systemitem class="username">root</systemitem> user:
189 </para>
190
191<screen role="root"><userinput>make install-man</userinput></screen>
192
193 <para>
194 Install the html docs as
195 <systemitem class="username">root</systemitem> user:
196 </para>
197
198<screen role="root"><userinput>make htmldir=/usr/share/doc/git-&git-version; install-html</userinput></screen>
199
200<!-- ==== Method 2 for docs ====== -->
201 <bridgehead renderas="sect3">If you downloaded the man pages and/or html docs</bridgehead>
202
203 <para>
204 If you downloaded the man pages untar them as the
205 <systemitem class="username">root</systemitem> user:
206 </para>
207
208<screen role="root"><userinput>tar -xf ../git-manpages-&git-version;.tar.xz \
209 -C /usr/share/man --no-same-owner --no-overwrite-dir</userinput></screen>
210
211 <para>
212 If you downloaded the html docs untar them as the
213 <systemitem class="username">root</systemitem> user:
214 </para>
215
216<screen role="root"><userinput>mkdir -vp /usr/share/doc/git-&git-version; &amp;&amp;
217tar -xf ../git-htmldocs-&git-version;.tar.xz \
218 -C /usr/share/doc/git-&git-version; --no-same-owner --no-overwrite-dir &amp;&amp;
219
220find /usr/share/doc/git-&git-version; -type d -exec chmod 755 {} \; &amp;&amp;
221find /usr/share/doc/git-&git-version; -type f -exec chmod 644 {} \;</userinput></screen>
222
223<!-- ==== Reorganize docs ====== -->
224 <bridgehead renderas="sect3">Reorganize man pages and/or html docs (both methods)</bridgehead>
225
226 <para>
227 For both methods, reorganize the files, as
228 <systemitem class="username">root</systemitem> user:
229 </para>
230
231<screen role="root"><userinput>mkdir -vp /usr/share/doc/git-&git-version;/man-pages/{html,text} &amp;&amp;
232mv /usr/share/doc/git-&git-version;/{git*.txt,man-pages/text} &amp;&amp;
233mv /usr/share/doc/git-&git-version;/{git*.,index.,man-pages/}html &amp;&amp;
234
235mkdir -vp /usr/share/doc/git-&git-version;/technical/{html,text} &amp;&amp;
236mv /usr/share/doc/git-&git-version;/technical/{*.txt,text} &amp;&amp;
237mv /usr/share/doc/git-&git-version;/technical/{*.,}html &amp;&amp;
238
239mkdir -vp /usr/share/doc/git-&git-version;/howto/{html,text} &amp;&amp;
240mv /usr/share/doc/git-&git-version;/howto/{*.txt,text} &amp;&amp;
241mv /usr/share/doc/git-&git-version;/howto/{*.,}html</userinput></screen>
242
243 </sect2>
244
245 <sect2 role="commands">
246 <title>Command Explanations</title>
247
248 <para>
249 <parameter>--with-gitconfig=/etc/gitconfig</parameter>: This sets
250 <filename>/etc/gitconfig</filename> as the file that stores
251 the default, system wide, <application>Git</application>
252 settings.
253 </para>
254
255 <para>
256 <option>--without-python</option>: Use this switch if
257 <application>Python</application> is not installed.
258 </para>
259
260 <para>
261 <option>--with-libpcre</option>: Use this switch if
262 <application>PCRE</application> is installed.
263 </para>
264
265 <para>
266 <command>tar -xf ../git-manpages-&git-version;.tar.gz -C
267 /usr/share/man --no-same-owner</command>: This untars
268 <filename>git-manpages-&git-version;.tar.gz</filename>. The
269 <option>-C</option> option makes tar change directory to
270 <filename class="directory">/usr/share/man</filename> before
271 it starts to decompress the docs. The <option>--no-same-owner</option>
272 option stops tar from preserving the user and group details of the
273 files. This is useful as that user or group may not exist on your
274 system; this could (potentially) be a security risk.
275 </para>
276
277 <para>
278 <command>mv /usr/share/doc/git-&git-version; ...</command>: These
279 commands move some of the files into subfolders to make it easier to sort
280 through the docs and find what you're looking for.
281 </para>
282
283 <para>
284 <command>find ... chmod ...</command>: These commands correct the
285 permissions in the shipped documentation tar file.
286 </para>
287
288 </sect2>
289
290 <sect2 role="configuration">
291 <title>Configuring Git</title>
292
293 <sect3 id="git-config">
294 <title>Config Files</title>
295 <para>
296 <filename>~/.gitconfig</filename> and
297 <filename>/etc/gitconfig</filename>
298 </para>
299
300 <indexterm zone="git git-config">
301 <primary sortas="e-AA.gitconfig">~/.gitconfig</primary>
302 </indexterm>
303
304 <indexterm zone="git git-config">
305 <primary sortas="e-etc-gitconfig">/etc/gitconfig</primary>
306 </indexterm>
307
308 </sect3>
309
310 </sect2>
311
312 <sect2 role="content">
313 <title>Contents</title>
314
315 <segmentedlist>
316 <segtitle>Installed Programs</segtitle>
317 <segtitle>Installed Libraries</segtitle>
318 <segtitle>Installed Directories</segtitle>
319
320 <seglistitem>
321 <seg>
322 git, git-receive-pack and git-upload-archive (hardlinked to each other),
323 git-cvsserver, git-shell, git-upload-pack, and gitk
324 </seg>
325 <seg>
326 None
327 </seg>
328 <seg>
329 /usr/lib/perl5/site_perl/&lt;5.x.y&gt;{,&lt;arch-linux&gt;/auto}/Git,
330 /usr/libexec/git-core and
331 /usr/share/{doc/git-&git-version;,git-core,git-gui,gitk,gitweb}
332 </seg>
333 </seglistitem>
334 </segmentedlist>
335
336 <variablelist>
337 <bridgehead renderas="sect3">Short Descriptions</bridgehead>
338 <?dbfo list-presentation="list"?>
339 <?dbhtml list-presentation="table"?>
340
341 <varlistentry id="git-prog">
342 <term><command>git</command></term>
343 <listitem>
344 <para>
345 is the stupid content tracker.
346 </para>
347 <indexterm zone="git git-prog">
348 <primary sortas="b-git">git</primary>
349 </indexterm>
350 </listitem>
351 </varlistentry>
352
353 <varlistentry id="git-cvsserver">
354 <term><command>git-cvsserver</command></term>
355 <listitem>
356 <para>
357 is a CVS server emulator for <application>Git</application>.
358 </para>
359 <indexterm zone="git git-cvsserver">
360 <primary sortas="b-git-cvsserver">git-cvsserver</primary>
361 </indexterm>
362 </listitem>
363 </varlistentry>
364
365 <varlistentry id="gitk">
366 <term><command>gitk</command></term>
367 <listitem>
368 <para>
369 is a graphical <application>Git</application> repository browser
370 (needs <xref linkend="tk"/>).
371 </para>
372 <indexterm zone="git gitk">
373 <primary sortas="b-gitk">gitk</primary>
374 </indexterm>
375 </listitem>
376 </varlistentry>
377
378 <varlistentry id="git-receive-pack">
379 <term><command>git-receive-pack</command></term>
380 <listitem>
381 <para>
382 is invoked by <command>git send-pack</command> and updates the
383 repository with the information fed from the remote end.
384 </para>
385 <indexterm zone="git git-receive-pack">
386 <primary sortas="b-git-receive-pack">git-receive-pack</primary>
387 </indexterm>
388 </listitem>
389 </varlistentry>
390
391 <varlistentry id="git-shell">
392 <term><command>git-shell</command></term>
393 <listitem>
394 <para>
395 is a login shell for SSH accounts to provide restricted Git
396 access.
397 </para>
398 <indexterm zone="git git-shell">
399 <primary sortas="b-git-shell">git-shell</primary>
400 </indexterm>
401 </listitem>
402 </varlistentry>
403
404 <varlistentry id="git-upload-archive">
405 <term><command>git-upload-archive</command></term>
406 <listitem>
407 <para>
408 is invoked by <command>git archive --remote</command> and sends
409 a generated archive to the other end over the git protocol.
410 </para>
411 <indexterm zone="git git-upload-archive">
412 <primary sortas="b-git-upload-archive">git-upload-archive</primary>
413 </indexterm>
414 </listitem>
415 </varlistentry>
416
417 <varlistentry id="git-upload-pack">
418 <term><command>git-upload-pack</command></term>
419 <listitem>
420 <para>
421 is invoked by <command>git fetch-pack</command>, it discovers
422 what objects the other side is missing, and sends them after
423 packing.
424 </para>
425 <indexterm zone="git git-upload-pack">
426 <primary sortas="b-git-upload-pack">git-upload-pack</primary>
427 </indexterm>
428 </listitem>
429 </varlistentry>
430
431 </variablelist>
432
433 </sect2>
434
435</sect1>
Note: See TracBrowser for help on using the repository browser.