source: general/prog/git.xml@ 64135787

kde5-14269
Last change on this file since 64135787 was 64135787, checked in by Xi Ruoyao <xry111@…>, 3 years ago

Begin manually (while modifying stuff) merging trunk and systemd branches since revision 14087.

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

  • Property mode set to 100644
File size: 14.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 "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 &lfs76_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 First, silence a lot of compiler warnings by running the following
138 command:
139 </para>
140
141<screen><userinput>sed -i "/BSD_SOURCE/d" git-compat-util.h</userinput></screen>
142
143 <para>
144 Install <application>Git</application> by running the following
145 commands:
146 </para>
147
148<screen><userinput>./configure --prefix=/usr --with-gitconfig=/etc/gitconfig &amp;&amp;
149make</userinput></screen>
150
151 <para>
152 You can build the man pages and/or html docs, or
153 use downloaded ones. If you choose to build them, use next two following
154 instructions.
155 </para>
156
157 <para>
158 If you have installed <ulink
159 url="http://www.methods.co.nz/asciidoc/">AsciiDoc</ulink> you can
160 create the html version of the man pages and other docs:
161 </para>
162
163<screen><userinput>make html</userinput></screen>
164
165 <para>
166 If you have installed <ulink
167 url="http://www.methods.co.nz/asciidoc/">AsciiDoc</ulink> and
168 <xref linkend="xmlto"/> you can create the man pages:
169 </para>
170
171<screen><userinput>make man</userinput></screen>
172
173 <para>
174 To check the results, issue: <command>make test</command>.
175 </para>
176
177 <para>
178 Now, as the <systemitem class="username">root</systemitem>
179 user:
180 </para>
181
182<screen role="root"><userinput>make install</userinput></screen>
183
184<!-- ==== Method 1 for docs ====== -->
185 <bridgehead renderas="sect3">If you created the man pages and/or html docs</bridgehead>
186
187 <para>
188 Install the man pages as
189 <systemitem class="username">root</systemitem> user:
190 </para>
191
192<screen role="root"><userinput>make install-man</userinput></screen>
193
194 <para>
195 Install the html docs as
196 <systemitem class="username">root</systemitem> user:
197 </para>
198
199<screen role="root"><userinput>make htmldir=/usr/share/doc/git-&git-version; install-html</userinput></screen>
200
201<!-- ==== Method 2 for docs ====== -->
202 <bridgehead renderas="sect3">If you downloaded the man pages and/or html docs</bridgehead>
203
204 <para>
205 If you downloaded the man pages untar them as the
206 <systemitem class="username">root</systemitem> user:
207 </para>
208
209<screen role="root"><userinput>tar -xf ../git-manpages-&git-version;.tar.xz \
210 -C /usr/share/man --no-same-owner --no-overwrite-dir</userinput></screen>
211
212 <para>
213 If you downloaded the html docs untar them as the
214 <systemitem class="username">root</systemitem> user:
215 </para>
216
217<screen role="root"><userinput>tar -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 -p /usr/share/doc/git-&git-version;/man-pages/{html,text} &amp;&amp;
232
233mv /usr/share/doc/git-&git-version;/{git*.txt,man-pages/text} &amp;&amp;
234mv /usr/share/doc/git-&git-version;/{git*.,index.,man-pages/}html &amp;&amp;
235mkdir /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;
238mkdir /usr/share/doc/git-&git-version;/howto/{html,text} &amp;&amp;
239mv /usr/share/doc/git-&git-version;/howto/{*.txt,text} &amp;&amp;
240mv /usr/share/doc/git-&git-version;/howto/{*.,}html</userinput></screen>
241
242 </sect2>
243
244 <sect2 role="commands">
245 <title>Command Explanations</title>
246
247 <para>
248 <parameter>--with-gitconfig=/etc/gitconfig</parameter>: This sets
249 <filename>/etc/gitconfig</filename> as the file that stores
250 the default, system wide, <application>Git</application>
251 settings.
252 </para>
253
254 <para>
255 <option>--without-python</option>: Use this switch if
256 <application>Python</application> is not installed.
257 </para>
258
259 <para>
260 <option>--with-libpcre</option>: Use this switch if
261 <application>PCRE</application> is installed.
262 </para>
263
264 <para>
265 <command>tar -xf ../git-manpages-&git-version;.tar.gz -C
266 /usr/share/man --no-same-owner</command>: This untars
267 <filename>git-manpages-&git-version;.tar.gz</filename>. The
268 <option>-C</option> option makes tar change directory to
269 <filename class="directory">/usr/share/man</filename> before
270 it starts to decompress the docs. The <option>--no-same-owner</option>
271 option stops tar from preserving the user and group details of the
272 files. This is useful as that user or group may not exist on your
273 system; this could (potentially) be a security risk.
274 </para>
275
276 <para>
277 <command>mv /usr/share/doc/git-&git-version; ...</command>: These
278 commands move some of the files into subfolders to make it easier to sort
279 through the docs and find what you're looking for.
280 </para>
281
282 <para>
283 <command>find ... chmod ...</command>: These commands correct the
284 permissions in the shipped documentation tar file.
285 </para>
286
287 </sect2>
288
289 <sect2 role="configuration">
290 <title>Configuring Git</title>
291
292 <sect3 id="git-config">
293 <title>Config Files</title>
294 <para>
295 <filename>~/.gitconfig</filename> and
296 <filename>/etc/gitconfig</filename>
297 </para>
298
299 <indexterm zone="git git-config">
300 <primary sortas="e-AA.gitconfig">~/.gitconfig</primary>
301 </indexterm>
302
303 <indexterm zone="git git-config">
304 <primary sortas="e-etc-gitconfig">/etc/gitconfig</primary>
305 </indexterm>
306
307 </sect3>
308
309 </sect2>
310
311 <sect2 role="content">
312 <title>Contents</title>
313
314 <segmentedlist>
315 <segtitle>Installed Programs</segtitle>
316 <segtitle>Installed Libraries</segtitle>
317 <segtitle>Installed Directories</segtitle>
318
319 <seglistitem>
320 <seg>
321 git, git-receive-pack and git-upload-archive (hardlinked to each other),
322 git-shell, git-cvsserver, git-upload-pack, and gitk
323 </seg>
324 <seg>
325 None
326 </seg>
327 <seg>
328 /usr/libexec/git-core,
329 /usr/share/doc/git-&git-version;,
330 /usr/share/git-core,
331 /usr/share/git-gui,
332 /usr/share/gitk,
333 /usr/share/gitweb,
334 /usr/lib/perl5/site_perl/&lt;5.x.y&gt;/Git and
335 /usr/lib/perl5/site_perl/&lfs-perl-version;/auto/Git
336
337 </seg>
338 </seglistitem>
339 </segmentedlist>
340
341 <variablelist>
342 <bridgehead renderas="sect3">Short Descriptions</bridgehead>
343 <?dbfo list-presentation="list"?>
344 <?dbhtml list-presentation="table"?>
345
346 <varlistentry id="git-prog">
347 <term><command>git</command></term>
348 <listitem>
349 <para>
350 is the stupid content tracker.
351 </para>
352 <indexterm zone="git git-prog">
353 <primary sortas="b-git">git</primary>
354 </indexterm>
355 </listitem>
356 </varlistentry>
357
358 <varlistentry id="git-cvsserver">
359 <term><command>git-cvsserver</command></term>
360 <listitem>
361 <para>
362 is a CVS server emulator for <application>Git</application>.
363 </para>
364 <indexterm zone="git git-cvsserver">
365 <primary sortas="b-git-cvsserver">git-cvsserver</primary>
366 </indexterm>
367 </listitem>
368 </varlistentry>
369
370 <varlistentry id="gitk">
371 <term><command>gitk</command></term>
372 <listitem>
373 <para>
374 is a graphical <application>Git</application> repository browser
375 (needs <xref linkend="tk"/>).
376 </para>
377 <indexterm zone="git gitk">
378 <primary sortas="b-gitk">gitk</primary>
379 </indexterm>
380 </listitem>
381 </varlistentry>
382
383 <varlistentry id="git-receive-pack">
384 <term><command>git-receive-pack</command></term>
385 <listitem>
386 <para>
387 is invoked by <command>git send-pack</command> and updates the
388 repository with the information fed from the remote end.
389 </para>
390 <indexterm zone="git git-receive-pack">
391 <primary sortas="b-git-receive-pack">git-receive-pack</primary>
392 </indexterm>
393 </listitem>
394 </varlistentry>
395
396 <varlistentry id="git-shell">
397 <term><command>git-shell</command></term>
398 <listitem>
399 <para>
400 is a login shell for SSH accounts to provide restricted Git
401 access.
402 </para>
403 <indexterm zone="git git-shell">
404 <primary sortas="b-git-shell">git-shell</primary>
405 </indexterm>
406 </listitem>
407 </varlistentry>
408
409 <varlistentry id="git-upload-archive">
410 <term><command>git-upload-archive</command></term>
411 <listitem>
412 <para>
413 is invoked by <command>git archive --remote</command> and sends
414 a generated archive to the other end over the git protocol.
415 </para>
416 <indexterm zone="git git-upload-archive">
417 <primary sortas="b-git-upload-archive">git-upload-archive</primary>
418 </indexterm>
419 </listitem>
420 </varlistentry>
421
422 <varlistentry id="git-upload-pack">
423 <term><command>git-upload-pack</command></term>
424 <listitem>
425 <para>
426 is invoked by <command>git fetch-pack</command>, it discovers
427 what objects the other side is missing, and sends them after
428 packing.
429 </para>
430 <indexterm zone="git git-upload-pack">
431 <primary sortas="b-git-upload-pack">git-upload-pack</primary>
432 </indexterm>
433 </listitem>
434 </varlistentry>
435
436 </variablelist>
437
438 </sect2>
439
440</sect1>
Note: See TracBrowser for help on using the repository browser.