source: general/prog/git.xml@ 65fe9d8

10.0 10.1 11.0 11.1 11.2 11.3 12.0 12.1 12.2 7.10 7.4 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 gimp3 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/for-12.3 xry111/intltool xry111/llvm18 xry111/soup3 xry111/spidermonkey128 xry111/test-20220226 xry111/xf86-video-removal
Last change on this file since 65fe9d8 was 65fe9d8, checked in by Chris Staub <chris@…>, 12 years ago

asciidoc/xmlto dependency info for Git was reversed

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

  • Property mode set to 100644
File size: 13.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-download-http
8 "http://git-core.googlecode.com/files/git-&git-version;.tar.gz">
9 <!ENTITY git-download-ftp " ">
10 <!ENTITY git-md5sum "12f4d20f34ae37086d86dd3b9d037bba">
11 <!ENTITY git-size "4.0 MB">
12 <!ENTITY git-buildsize "124 MB">
13 <!ENTITY git-time "3.3 SBU (including tests)">
14]>
15
16<sect1 id="git" xreflabel="git-&git-version;">
17 <?dbhtml filename="git.html"?>
18
19 <sect1info>
20 <othername>$LastChangedBy$</othername>
21 <date>$Date$</date>
22 </sect1info>
23
24 <title>Git-&git-version;</title>
25
26 <indexterm zone="git">
27 <primary sortas="a-git">Git</primary>
28 </indexterm>
29
30 <sect2 role="package">
31 <title>Introduction to Git</title>
32
33 <para><application>Git</application> is a free and open source, distributed
34 version control system designed to handle everything from small to very
35 large projects with speed and efficiency. Every
36 <application>Git</application> clone is a full-fledged repository with
37 complete history and full revision tracking capabilities, not dependent on
38 network access or a central server. Branching and merging are fast and easy
39 to do. <application>Git</application> is used for version control of files,
40 much like tools such as <application>Mercurial</application>,
41 <application>Bazaar</application>, <xref linkend="subversion"/>,
42 <xref linkend="cvs"/>, <application>Perforce</application>, and
43 <application>Team Foundation Server</application>.</para>
44
45 &lfs72_checked;
46
47 <bridgehead renderas="sect3">Package Information</bridgehead>
48 <itemizedlist spacing="compact">
49 <listitem>
50 <para>Download (HTTP): <ulink url="&git-download-http;"/></para>
51 </listitem>
52 <listitem>
53 <para>Download (FTP): <ulink url="&git-download-ftp;"/></para>
54 </listitem>
55 <listitem>
56 <para>Download MD5 sum: &git-md5sum;</para>
57 </listitem>
58 <listitem>
59 <para>Download size: &git-size;</para>
60 </listitem>
61 <listitem>
62 <para>Estimated disk space required: &git-buildsize;</para>
63 </listitem>
64 <listitem>
65 <para>Estimated build time: &git-time;</para>
66 </listitem>
67 </itemizedlist>
68
69 <bridgehead renderas="sect3">Additional Downloads</bridgehead>
70 <itemizedlist spacing="compact">
71 <listitem>
72 <para><ulink
73 url="http://git-core.googlecode.com/files/git-manpages-&git-version;.tar.gz">
74 http://git-core.googlecode.com/files/git-manpages-&git-version;.tar.gz</ulink>
75 (only needed if you've not installed asciidoc and xmlto)</para>
76 </listitem>
77 <listitem>
78 <para><ulink
79 url="http://git-core.googlecode.com/files/git-htmldocs-&git-version;.tar.gz">
80 http://git-core.googlecode.com/files/git-htmldocs-&git-version;.tar.gz</ulink>
81 and other docs (only needed if you've not installed asciidoc).</para>
82 </listitem>
83 </itemizedlist>
84
85 <bridgehead renderas="sect3">Git Dependencies</bridgehead>
86
87 <bridgehead renderas="sect4">Recommended</bridgehead>
88 <para role="recommended">
89 <xref linkend="python2"/> and
90 <xref linkend="curl"/> (needed to use <application>Git</application> over http,
91 https, ftp or ftps)
92 </para>
93
94 <bridgehead renderas="sect4">Optional</bridgehead>
95 <para role="optional">
96 <xref linkend="pcre"/>,
97 <xref linkend="openssl"/>,
98 <xref linkend="expat"/>, and
99 <xref linkend="tk"/> (gitk, a simple <application>Git</application>
100 repository viewer, uses <application>Tk</application> at runtime)
101 </para>
102
103 <bridgehead renderas="sect4">Optional (to create the man pages and html docs)</bridgehead>
104 <para>
105 <ulink url="http://www.methods.co.nz/asciidoc/">AsciiDoc</ulink> and
106 <xref linkend="xmlto"/>
107 </para>
108
109 <para condition="html" role="usernotes">User Notes:
110 <ulink url="&blfs-wiki;/git"/></para>
111 </sect2>
112
113 <sect2 role="installation">
114 <title>Installation of Git</title>
115
116 <para>Install <application>Git</application> by running the following
117 commands:</para>
118
119<screen><userinput>./configure --prefix=/usr \
120 --libexecdir=/usr/lib \
121 --with-gitconfig=/etc/gitconfig &amp;&amp;
122make</userinput></screen>
123
124 <para>If you have installed <ulink
125 url="http://www.methods.co.nz/asciidoc/">AsciiDoc</ulink> you can create
126 the html version of the man pages and other docs:</para>
127
128<screen><userinput>make html</userinput></screen>
129
130 <para>If you have installed <ulink
131 url="http://www.methods.co.nz/asciidoc/">AsciiDoc</ulink> and
132 <xref linkend="xmlto"/> you can create the man pages:</para>
133
134<screen><userinput>make man</userinput></screen>
135
136 <para>To check the results, issue: <command>make test</command>.</para>
137
138 <para>Now, as the <systemitem class="username">root</systemitem>
139 user:</para>
140
141<screen role="root"><userinput>make install</userinput></screen>
142
143 <para>If you created the man pages, install them as the
144 <systemitem class="username">root</systemitem> user:</para>
145
146<screen role="root"><userinput>make install-man</userinput></screen>
147
148 <para>If you created the html docs, install them as the
149 <systemitem class="username">root</systemitem> user:</para>
150
151<screen role="root"><userinput>make htmldir=/usr/share/doc/git-&git-version; install-html &amp;&amp;
152mkdir -p /usr/share/doc/git-&git-version;/man-pages/{html,text} &amp;&amp;
153mv /usr/share/doc/git-&git-version;/{git*.txt,man-pages/text} &amp;&amp;
154mv /usr/share/doc/git-&git-version;/{git*.,index.,man-pages/}html &amp;&amp;
155mkdir /usr/share/doc/git-&git-version;/technical/{html,text} &amp;&amp;
156mv /usr/share/doc/git-&git-version;/technical/{*.txt,text} &amp;&amp;
157mv /usr/share/doc/git-&git-version;/technical/{*.,}html &amp;&amp;
158mkdir /usr/share/doc/git-&git-version;/howto/{html,text} &amp;&amp;
159mv /usr/share/doc/git-&git-version;/howto/{*.txt,text} &amp;&amp;
160mv /usr/share/doc/git-&git-version;/howto/{*.,}html</userinput></screen>
161
162 <para>Alternatively, If you downloaded the man pages untar them as the
163 <systemitem class="username">root</systemitem> user:</para>
164
165<screen role="root"><userinput>tar -xf ../git-manpages-&git-version;.tar.gz -C /usr/share/man --no-same-owner</userinput></screen>
166
167 <para>If you downloaded the html docs untar them as the
168 <systemitem class="username">root</systemitem> user:</para>
169
170<screen role="root"><userinput>mkdir -p /usr/share/doc/git-&git-version;/man-pages/{html,text} &amp;&amp;
171
172tar -xf ../git-htmldocs-&git-version;.tar.gz \
173 -C /usr/share/doc/git-&git-version; --no-same-owner &amp;&amp;
174
175mv /usr/share/doc/git-&git-version;/{git*.txt,man-pages/text} &amp;&amp;
176mv /usr/share/doc/git-&git-version;/{git*.,index.,man-pages/}html &amp;&amp;
177mkdir /usr/share/doc/git-&git-version;/technical/{html,text} &amp;&amp;
178mv /usr/share/doc/git-&git-version;/technical/{*.txt,text} &amp;&amp;
179mv /usr/share/doc/git-&git-version;/technical/{*.,}html &amp;&amp;
180mkdir /usr/share/doc/git-&git-version;/howto/{html,text} &amp;&amp;
181mv /usr/share/doc/git-&git-version;/howto/{*.txt,text} &amp;&amp;
182mv /usr/share/doc/git-&git-version;/howto/{*.,}html</userinput></screen>
183 </sect2>
184
185 <sect2 role="commands">
186 <title>Command Explanations</title>
187
188 <para><option>--libexecdir=/usr/lib</option>: Place git library files
189 correctly.</para>
190
191 <para><option>--with-gitconfig=/etc/gitconfig</option>: This sets
192 <filename>/etc/gitconfig</filename> as the file that stores the default,
193 system wide, <application>Git</application> settings.</para>
194
195 <para><option>--without-python</option>: Use this option if python is
196 not installed.</para>
197
198 <para><option>--with-libpcre</option>: Use this option if PCRE is
199 installed.</para>
200
201 <para><command>tar -xf ../git-manpages-&git-version;.tar.gz -C
202 /usr/share/man --no-same-owner</command>: This untars
203 <filename>git-manpages-&git-version;.tar.gz</filename>. The
204 <option>-C</option> option makes tar change directory to
205 <filename class="directory">/usr/share/man</filename> before it starts to
206 decompress the docs. The <option>--no-same-owner</option> option stops tar
207 from preserving the user and group details of the files. This is useful as
208 that user or group may not exist on your system; this could
209 (potentially) be a security risk.</para>
210
211 <para><command>mv /usr/share/doc/git-&git-version; ...</command>: These
212 commands move some of the files into subfolders to make it easier to sort
213 through the docs and find what you're looking for.</para>
214 </sect2>
215
216 <sect2 role="configuration">
217 <title>Configuring Git</title>
218
219 <sect3 id="git-config">
220 <title>Config Files</title>
221 <para><filename>~/.gitconfig</filename> and
222 <filename>/etc/gitconfig</filename></para>
223
224 <indexterm zone="git git-config">
225 <primary sortas="e-AA.gitconfig">~/.gitconfig</primary>
226 </indexterm>
227
228 <indexterm zone="git git-config">
229 <primary sortas="e-etc-gitconfig">/etc/gitconfig</primary>
230 </indexterm>
231 </sect3>
232
233 <sect3><title>Configuration Information</title>
234
235 <para>If you want to use <command>git svn</command> you will need to
236 install <xref linkend="subversion"/> and its Perl bindings.</para>
237
238 <para>To be able to use git to pull from a https source you need first
239 install the <xref linkend="cacerts"/> and then configure git to know where
240 they are. To set the default location of the SSL certificates, as the
241 <systemitem class="username">root</systemitem> user:</para>
242
243<screen role="root"><userinput>git config --system http.sslCAPath /etc/ssl/certs</userinput></screen>
244 </sect3>
245 </sect2>
246
247 <sect2 role="content">
248 <title>Contents</title>
249
250 <segmentedlist>
251 <segtitle>Installed Programs</segtitle>
252 <segtitle>Installed Directories</segtitle>
253
254 <seglistitem>
255 <seg>git, git-cvsserver, gitk, git-receive-pack, git-shell,
256 git-upload-archive and git-upload-pack.</seg>
257 <seg>/usr/libexec/git-core, /usr/share/git-&git-version;,
258 /usr/share/git-core, /usr/share/git-gui, /usr/share/gitk and
259 /usr/share/gitweb</seg>
260 </seglistitem>
261 </segmentedlist>
262
263 <variablelist>
264 <bridgehead renderas="sect3">Short Descriptions</bridgehead>
265 <?dbfo list-presentation="list"?>
266 <?dbhtml list-presentation="table"?>
267
268 <varlistentry id="git-prog">
269 <term><command>git</command></term>
270 <listitem>
271 <para>is the stupid content tracker.</para>
272 <indexterm zone="git git-prog">
273 <primary sortas="b-git">git</primary>
274 </indexterm>
275 </listitem>
276 </varlistentry>
277
278 <varlistentry id="git-cvsserver">
279 <term><command>git-cvsserver</command></term>
280 <listitem>
281 <para>is a CVS server emulator for git.</para>
282 <indexterm zone="git git-cvsserver">
283 <primary sortas="b-git-cvsserver">git-cvsserver</primary>
284 </indexterm>
285 </listitem>
286 </varlistentry>
287
288 <varlistentry id="gitk">
289 <term><command>gitk</command></term>
290 <listitem>
291 <para>is a git repository browser (needs <xref linkend="tk"/>).</para>
292 <indexterm zone="git gitk">
293 <primary sortas="b-gitk">gitk</primary>
294 </indexterm>
295 </listitem>
296 </varlistentry>
297
298 <varlistentry id="git-receive-pack">
299 <term><command>git-receive-pack</command></term>
300 <listitem>
301 <para>is invoked by <command>git send-pack</command> and updates the
302 repository with the information fed from the remote end.</para>
303 <indexterm zone="git git-receive-pack">
304 <primary sortas="b-git-receive-pack">git-receive-pack</primary>
305 </indexterm>
306 </listitem>
307 </varlistentry>
308
309 <varlistentry id="git-shell">
310 <term><command>git-shell</command></term>
311 <listitem>
312 <para>is a login shell for SSH accounts to provide restricted Git
313 access.</para>
314 <indexterm zone="git git-shell">
315 <primary sortas="b-git-shell">git-shell</primary>
316 </indexterm>
317 </listitem>
318 </varlistentry>
319
320 <varlistentry id="git-upload-archive">
321 <term><command>git-upload-archive</command></term>
322 <listitem>
323 <para>is invoked by <command>git archive --remote</command> and sends
324 a generated archive to the other end over the git protocol.</para>
325 <indexterm zone="git git-upload-archive">
326 <primary sortas="b-git-upload-archive">git-upload-archive</primary>
327 </indexterm>
328 </listitem>
329 </varlistentry>
330
331 <varlistentry id="git-upload-pack">
332 <term><command>git-upload-pack</command></term>
333 <listitem>
334 <para>is invoked by <command>git fetch-pack</command>, it discovers
335 what objects the other side is missing, and sends them after
336 packing.</para>
337 <indexterm zone="git git-upload-pack">
338 <primary sortas="b-git-upload-pack">git-upload-pack</primary>
339 </indexterm>
340 </listitem>
341 </varlistentry>
342 </variablelist>
343 </sect2>
344</sect1>
Note: See TracBrowser for help on using the repository browser.