source: general/prog/git.xml@ bfe73de

10.0 10.1 11.0 11.1 11.2 11.3 12.0 12.1 7.10 7.5 7.6 7.6-blfs 7.6-systemd 7.7 7.8 7.9 8.0 8.1 8.2 8.3 8.4 9.0 9.1 basic bdubbs/svn elogind gnome kde5-13430 kde5-14269 kde5-14686 kea ken/TL2024 ken/inkscape-core-mods ken/tuningfonts krejzi/svn lazarus lxqt nosym perl-modules plabs/newcss plabs/python-mods python3.11 qt5new rahul/power-profiles-daemon renodr/vulkan-addition systemd-11177 systemd-13485 trunk upgradedb xry111/intltool xry111/llvm18 xry111/soup3 xry111/test-20220226 xry111/xf86-video-removal
Last change on this file since bfe73de was 1b83b0e0, checked in by Ken Moffat <ken@…>, 10 years ago

Remove some libexecdirs I overlooked earlier.

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

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