source: general/prog/git.xml@ 6f482bd

10.0 10.1 11.0 11.1 11.2 11.3 12.0 12.1 8.1 8.2 8.3 8.4 9.0 9.1 basic bdubbs/svn elogind kea ken/TL2024 ken/inkscape-core-mods ken/tuningfonts lazarus lxqt perl-modules plabs/newcss plabs/python-mods python3.11 qt5new rahul/power-profiles-daemon renodr/vulkan-addition trunk upgradedb xry111/intltool xry111/llvm18 xry111/soup3 xry111/test-20220226 xry111/xf86-video-removal
Last change on this file since 6f482bd was 6f482bd, checked in by Bruce Dubbs <bdubbs@…>, 7 years ago

Update to mesa-17.1.2.
Update to nspr-4.15.
Update to git-2.13.1.
Update to nano-2.8.4.

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