source: general/prog/git.xml@ e9e0e8a1

7.6-blfs 7.6-systemd kde5-14269 kde5-14686 systemd-13485
Last change on this file since e9e0e8a1 was e9e0e8a1, checked in by Krejzi <krejzi@…>, 10 years ago

Merged trunk.

git-svn-id: svn://svn.linuxfromscratch.org/BLFS/branches/systemd@13932 af4574ff-66df-0310-9fd7-8a98e5e911e0

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