glfs/general/prog/git.xml

490 lines
17 KiB
XML

<?xml version="1.0" encoding="ISO-8859-1"?>
<!DOCTYPE sect1 PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN"
"http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd" [
<!ENTITY % general-entities SYSTEM "../../general.ent">
%general-entities;
<!ENTITY git-root "&kernel-dl;/software/scm/git" >
<!ENTITY git-download-http "&git-root;/git-&git-version;.tar.xz">
<!ENTITY git-download-ftp " ">
<!ENTITY git-md5sum "c1f58a12b891ad73927b8e4a3aa29c7b">
<!ENTITY git-size "11 MB">
<!-- but people keep forgetting that an install not only needs the net build
space, it also needs the install space (or DESTDIR) -->
<!ENTITY git-buildsize "252 MB (with downloaded documentation">
<!-- With 2.23.0, there was a large increase in time for tests. Possibly disk related? -->
<!-- Confirmed that it is disk related.-->
<!ENTITY git-time "0.3 SBU (with parallelism=4; add up to 1.6 SBU (disk speed dependent) for tests, both with parallelism=4)">
]>
<sect1 id="git" xreflabel="git-&git-version;">
<?dbhtml filename="git.html"?>
<title>Git-&git-version;</title>
<indexterm zone="git">
<primary sortas="a-Git">Git</primary>
</indexterm>
<sect2 role="package">
<title>Introduction to Git</title>
<para>
<application>Git</application> is a free and open source, distributed
version control system designed to handle everything from small to very
large projects with speed and efficiency. Every
<application>Git</application> clone is a full-fledged repository with
complete history and full revision tracking capabilities, not dependent
on network access or a central server. Branching and merging are fast and
easy to do. <application>Git</application> is used for version control of
files, much like tools such as <xref linkend="mercurial"/>,
<application>Bazaar</application>, <xref linkend="subversion"/>,
<ulink url="https://www.nongnu.org/cvs/">CVS</ulink>,
<application>Perforce</application>, and
<application>Team Foundation Server</application>.
</para>
&lfs113_checked;
<bridgehead renderas="sect3">Package Information</bridgehead>
<itemizedlist spacing="compact">
<listitem>
<para>
Download (HTTP): <ulink url="&git-download-http;"/>
</para>
</listitem>
<listitem>
<para>
Download (FTP): <ulink url="&git-download-ftp;"/>
</para>
</listitem>
<listitem>
<para>
Download MD5 sum: &git-md5sum;
</para>
</listitem>
<listitem>
<para>
Download size: &git-size;
</para>
</listitem>
<listitem>
<para>
Estimated disk space required: &git-buildsize;
</para>
</listitem>
<listitem>
<para>
Estimated build time: &git-time;
</para>
</listitem>
</itemizedlist>
<bridgehead renderas="sect3">Additional Downloads</bridgehead>
<itemizedlist spacing="compact">
<listitem>
<para>
<ulink url="&git-root;/git-manpages-&git-version;.tar.xz">
&git-root;/git-manpages-&git-version;.tar.xz</ulink>
(not needed if you've installed <xref linkend="asciidoc"/>,
<xref linkend="xmlto"/>, and prefer to rebuild them)
</para>
</listitem>
<listitem>
<para>
<ulink url="&git-root;/git-htmldocs-&git-version;.tar.xz">
&git-root;/git-htmldocs-&git-version;.tar.xz</ulink>
and other docs (not needed if you've installed
<xref linkend="asciidoc"/> and want to rebuild the documentation).
</para>
</listitem>
</itemizedlist>
<bridgehead renderas="sect3">Git Dependencies</bridgehead>
<bridgehead renderas="sect4">Recommended</bridgehead>
<para role="recommended">
<xref linkend="curl"/> (needed to use <application>Git</application> over
http, https, ftp or ftps)
</para>
<bridgehead renderas="sect4">Optional</bridgehead>
<para role="optional">
<xref linkend="apache"/> (for some tests),
<xref role="runtime" linkend="gnupg2"/> (runtime, may be used to sign
<application>Git</application> commits or tags, or verify the signatures
of them),
<xref role="runtime" linkend="openssh"/> (runtime, needed to use
<application>Git</application> over ssh),
<xref linkend="pcre2"/> (<emphasis>or</emphasis> the deprecated <xref
role="nodep" linkend="pcre"/>), in either case configured with
<literal>--enable-jit</literal>,
<xref role="runtime" linkend="subversion"/> with Perl bindings
(runtime, for <command>git svn</command>),
<xref role="runtime" linkend="tk"/>
(gitk, a simple <application>Git</application>
repository viewer, uses <application>Tk</application> at runtime),
<xref linkend="valgrind"/>,
<ulink url="https://metacpan.org/pod/Authen::SASL">Authen::SASL</ulink> and
<ulink url="https://metacpan.org/pod/MIME::Base64">MIME::Base64</ulink>
(both runtime, for <command>git send-email</command>),
and <xref linkend='perl-io-socket-ssl'/> (runtime, for
<command>git send-email</command> to connect to a SMTP server with
SSL encryption)
</para>
<bridgehead renderas="sect4">Optional (to create the man pages, html docs
and other docs)</bridgehead>
<para role="optional">
<xref linkend="xmlto"/> and
<xref linkend="asciidoc"/>
<!-- or xref linkend="asciidoctor", doesn't work now because it needs docbook-xsl-ns -->,
and also
<ulink url="https://dblatex.sourceforge.net/">dblatex</ulink>
(for the PDF version of the user manual), and
<ulink url="https://docbook2x.sourceforge.net/">docbook2x</ulink> to
create info pages
</para>
</sect2>
<sect2 role="installation">
<title>Installation of Git</title>
<para>
Install <application>Git</application> by running the following
commands:
</para>
<screen><userinput>./configure --prefix=/usr \
--with-gitconfig=/etc/gitconfig \
--with-python=python3 &amp;&amp;
make</userinput></screen>
<para>
You can build the man pages and/or html docs, or
use downloaded ones. If you choose to build them, use the next two
instructions.
</para>
<para>
If you have installed <xref linkend="asciidoc"/> you can
create the html version of the man pages and other docs:
</para>
<screen remap="doc"><userinput>make html</userinput></screen>
<para>
If you have installed <xref linkend="asciidoc"/> and
<xref linkend="xmlto"/> you can create the man pages:
</para>
<screen remap="doc"><userinput>make man</userinput></screen>
<para>
The test suite can be run in parallel mode. To run the test suite, issue:
<command>make -k test</command>. <!--If run as a normal user, 0 tests
should be reported as failed in the final summary.-->
If <xref linkend="apache"/> is installed,
three tests in <filename>t5559-http-fetch-smart-http2.sh</filename> are
known to fail due to cURL-8.1.x.
</para>
<!-- The tests in question are "GIT_TRACE_CURL redirects auth details",
"GIT_CURL_VERBOSE redacts auth details", and "cookies are redacted by
default". I sent upstream a bug report:
https://lore.kernel.org/git/3843d97f-0073-e2d4-b98d-5a38c33b25f3@linuxfromscratch.org/T/#u
and hopefully will hear back soon. -renodr -->
<para>
Now, as the <systemitem class="username">root</systemitem>
user:
</para>
<screen role="root"><userinput>make perllibdir=/usr/lib/perl5/&lfs-perl-version;/site_perl install</userinput></screen>
<!-- ==== Method 1 for docs ====== -->
<bridgehead renderas="sect3">If you created the man pages and/or html docs</bridgehead>
<para>
Install the man pages as the
<systemitem class="username">root</systemitem> user:
</para>
<screen role="root"
remap="doc"><userinput>make install-man</userinput></screen>
<para>
Install the html docs as the
<systemitem class="username">root</systemitem> user:
</para>
<screen role="root"
remap="doc"><userinput>make htmldir=/usr/share/doc/git-&git-version; install-html</userinput></screen>
<!-- ==== Method 2 for docs ====== -->
<bridgehead renderas="sect3">If you downloaded the man pages and/or html docs</bridgehead>
<para>
If you downloaded the man pages untar them as the
<systemitem class="username">root</systemitem> user:
</para>
<screen role="root"><userinput>tar -xf ../git-manpages-&git-version;.tar.xz \
-C /usr/share/man --no-same-owner --no-overwrite-dir</userinput></screen>
<para>
If you downloaded the html docs untar them as the
<systemitem class="username">root</systemitem> user:
</para>
<screen role="root"><userinput>mkdir -vp /usr/share/doc/git-&git-version; &amp;&amp;
tar -xf ../git-htmldocs-&git-version;.tar.xz \
-C /usr/share/doc/git-&git-version; --no-same-owner --no-overwrite-dir &amp;&amp;
find /usr/share/doc/git-&git-version; -type d -exec chmod 755 {} \; &amp;&amp;
find /usr/share/doc/git-&git-version; -type f -exec chmod 644 {} \;</userinput></screen>
<!-- ==== Reorganize docs ====== -->
<bridgehead renderas="sect3">Reorganize text and html in the html-docs (both methods)</bridgehead>
<para>
For both methods, the html-docs include a lot of plain text files.
Reorganize the files as the
<systemitem class="username">root</systemitem> user:
</para>
<screen role="root"><userinput>mkdir -vp /usr/share/doc/git-&git-version;/man-pages/{html,text} &amp;&amp;
mv /usr/share/doc/git-&git-version;/{git*.txt,man-pages/text} &amp;&amp;
mv /usr/share/doc/git-&git-version;/{git*.,index.,man-pages/}html &amp;&amp;
mkdir -vp /usr/share/doc/git-&git-version;/technical/{html,text} &amp;&amp;
mv /usr/share/doc/git-&git-version;/technical/{*.txt,text} &amp;&amp;
mv /usr/share/doc/git-&git-version;/technical/{*.,}html &amp;&amp;
mkdir -vp /usr/share/doc/git-&git-version;/howto/{html,text} &amp;&amp;
mv /usr/share/doc/git-&git-version;/howto/{*.txt,text} &amp;&amp;
mv /usr/share/doc/git-&git-version;/howto/{*.,}html &amp;&amp;
sed -i '/^&lt;a href=/s|howto/|&amp;html/|' /usr/share/doc/git-&git-version;/howto-index.html &amp;&amp;
sed -i '/^\* link:/s|howto/|&amp;html/|' /usr/share/doc/git-&git-version;/howto-index.txt</userinput></screen>
</sect2>
<sect2 role="commands">
<title>Command Explanations</title>
<para>
<parameter>--with-gitconfig=/etc/gitconfig</parameter>: This sets
<filename>/etc/gitconfig</filename> as the file that stores
the default, system wide, <application>Git</application>
settings.
</para>
<para>
<parameter>--with-python=python3</parameter>: Use this switch to use
<application>Python 3</application>, instead of the EOL'ed
<application>Python 2</application>. Python is used for the
<command>git p4</command> interface to Perforce repositories,
and also used in some tests.
</para>
<para>
<option>--with-libpcre2</option>: Use this switch if
<application>PCRE2</application> is installed and has been built with
the non-default JIT enabled.
</para>
<para>
<option>--with-libpcre1</option>: As an alternative to PCRE2, use this
switch if the deprecated <application>PCRE</application> is installed
and has been built with the non-default JIT enabled.
</para>
<para>
<command>tar -xf ../git-manpages-&git-version;.tar.gz -C
/usr/share/man --no-same-owner</command>: This untars
<filename>git-manpages-&git-version;.tar.gz</filename>. The
<option>-C</option> option makes tar change directory to
<filename class="directory">/usr/share/man</filename> before
it starts to decompress the docs. The <option>--no-same-owner</option>
option stops tar from preserving the user and group details of the
files. This is useful as that user or group may not exist on your
system; this could (potentially) be a security risk.
</para>
<para>
<command>mv /usr/share/doc/git-&git-version; ...</command>: These
commands move some of the files into subfolders to make it easier to sort
through the docs and find what you're looking for.
</para>
<para>
<command>find ... chmod ...</command>: These commands correct the
permissions in the shipped documentation tar file.
</para>
</sect2>
<sect2 role="configuration">
<title>Configuring Git</title>
<sect3 id="git-config">
<title>Config Files</title>
<para>
<filename>~/.gitconfig</filename> and
<filename>/etc/gitconfig</filename>
</para>
<indexterm zone="git git-config">
<primary sortas="e-AA.gitconfig">~/.gitconfig</primary>
</indexterm>
<indexterm zone="git git-config">
<primary sortas="e-etc-gitconfig">/etc/gitconfig</primary>
</indexterm>
</sect3>
</sect2>
<sect2 role="content">
<title>Contents</title>
<segmentedlist>
<segtitle>Installed Programs</segtitle>
<segtitle>Installed Libraries</segtitle>
<segtitle>Installed Directories</segtitle>
<seglistitem>
<seg>
git, git-receive-pack, git-upload-archive, and
git-upload-pack (hardlinked to each
other), git-cvsserver, git-shell, gitk, and scalar
</seg>
<seg>
None
</seg>
<seg>
/usr/libexec/git-core, and
/usr/share/{doc/git-&git-version;,git-core,git-gui,gitk,gitweb}
</seg>
</seglistitem>
</segmentedlist>
<variablelist>
<bridgehead renderas="sect3">Short Descriptions</bridgehead>
<?dbfo list-presentation="list"?>
<?dbhtml list-presentation="table"?>
<varlistentry id="git-prog">
<term><command>git</command></term>
<listitem>
<para>
is the stupid content tracker
</para>
<indexterm zone="git git-prog">
<primary sortas="b-git">git</primary>
</indexterm>
</listitem>
</varlistentry>
<varlistentry id="git-cvsserver">
<term><command>git-cvsserver</command></term>
<listitem>
<para>
is a CVS server emulator for <application>Git</application>
</para>
<indexterm zone="git git-cvsserver">
<primary sortas="b-git-cvsserver">git-cvsserver</primary>
</indexterm>
</listitem>
</varlistentry>
<varlistentry id="gitk">
<term><command>gitk</command></term>
<listitem>
<para>
is a graphical <application>Git</application> repository browser
(needs <xref linkend="tk"/>)
</para>
<indexterm zone="git gitk">
<primary sortas="b-gitk">gitk</primary>
</indexterm>
</listitem>
</varlistentry>
<varlistentry id="git-receive-pack">
<term><command>git-receive-pack</command></term>
<listitem>
<para>
is invoked by <command>git send-pack</command> and updates the
repository with the information fed from the remote end
</para>
<indexterm zone="git git-receive-pack">
<primary sortas="b-git-receive-pack">git-receive-pack</primary>
</indexterm>
</listitem>
</varlistentry>
<varlistentry id="git-shell">
<term><command>git-shell</command></term>
<listitem>
<para>
is a login shell for SSH accounts to provide restricted Git
access
</para>
<indexterm zone="git git-shell">
<primary sortas="b-git-shell">git-shell</primary>
</indexterm>
</listitem>
</varlistentry>
<varlistentry id="git-upload-archive">
<term><command>git-upload-archive</command></term>
<listitem>
<para>
is invoked by <command>git archive --remote</command> and sends
a generated archive to the other end over the git protocol
</para>
<indexterm zone="git git-upload-archive">
<primary sortas="b-git-upload-archive">git-upload-archive</primary>
</indexterm>
</listitem>
</varlistentry>
<varlistentry id="git-upload-pack">
<term><command>git-upload-pack</command></term>
<listitem>
<para>
is invoked by <command>git fetch-pack</command>, it discovers
what objects the other side is missing, and sends them after
packing
</para>
<indexterm zone="git git-upload-pack">
<primary sortas="b-git-upload-pack">git-upload-pack</primary>
</indexterm>
</listitem>
</varlistentry>
<varlistentry id="scalar">
<term><command>scalar</command></term>
<listitem>
<para>
is a repository management tool that optimizes Git for use in
large repositories
</para>
<indexterm zone="git scalar">
<primary sortas="b-scalar">scalar</primary>
</indexterm>
</listitem>
</varlistentry>
</variablelist>
</sect2>
</sect1>