source: basicnet/netprogs/subversion.xml@ 9cff4372

<?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 subversion-download-http "http://subversion.tigris.org/downloads/subversion-&subversion-version;.tar.bz2">
  <!ENTITY subversion-download-ftp  " ">
  <!ENTITY subversion-md5sum        "9c30a47b1d48664e7afef68bb4834c53">
  <!ENTITY subversion-size          "5.4 MB">

  <!ENTITY subversion-buildsize     "170 MB (additional 43 MB to install all bindings and 740 MB to run all test suites)">
  <!ENTITY subversion-time          "2.8 SBU (add 2.3 SBU for bindings and 6.0 SBU to run test suites)">

  <!ENTITY svn-neon-version         "0.28.3">
  <!ENTITY svn-swig-version         "1.3.36">
]>

<sect1 id="subversion" xreflabel="Subversion-&subversion-version;">
  <?dbhtml filename="subversion.html"?>

  <sect1info>
    <othername>$LastChangedBy$</othername>
    <date>$Date$</date>
  </sect1info>

  <title>Subversion-&subversion-version;</title>

  <indexterm zone="subversion">
    <primary sortas="a-Subversion">Subversion</primary>
  </indexterm>

  <sect2 role="package">
    <title>Introduction to Subversion</title>

    <para><application>Subversion</application> is a version control
    system that is designed to be a compelling replacement for
    <application>CVS</application> in the open source community. It
    extends and enhances <application>CVS</application>' feature set,
    while maintaining a similar interface for those already familiar with
    <application>CVS</application>. These instructions install the client
    and server software used to manipulate a
    <application>Subversion</application> repository. Creation of a repository
    is covered at <xref linkend="svnserver"/>.</para>

    <bridgehead renderas="sect3">Package Information</bridgehead>
    <itemizedlist spacing="compact">
      <listitem>
        <para>Download (HTTP): <ulink url="&subversion-download-http;"/></para>
      </listitem>
      <listitem>
        <para>Download (FTP): <ulink url="&subversion-download-ftp;"/></para>
      </listitem>
      <listitem>
        <para>Download MD5 sum: &subversion-md5sum;</para>
      </listitem>
      <listitem>
        <para>Download size: &subversion-size;</para>
      </listitem>
      <listitem>
        <para>Estimated disk space required: &subversion-buildsize;</para>
      </listitem>
      <listitem>
        <para>Estimated build time: &subversion-time;</para>
      </listitem>
    </itemizedlist>

    <!--
    <bridgehead renderas="sect3">Additional Downloads</bridgehead>
    <itemizedlist spacing="compact">
      <listitem>
        <para>Required patch if using
        <application>Swig</application>-1.3.25 and you wish
        to build the <application>Perl</application> bindings: <ulink
        url="&patch-root;/patches/subversion-&subversion-version;-swig_1.3.25-1.patch"/></para>
      </listitem>
    </itemizedlist>
    -->

    <bridgehead renderas="sect3">Subversion Dependencies</bridgehead>

    <bridgehead renderas="sect4">Required</bridgehead>
    <para role="required"><xref linkend="sqlite"/>, and
    <xref linkend="apache"/> (for the
    <application>APR</application> only) or
    <ulink url="http://apr.apache.org/">Apache Portable Runtime</ulink></para>

    <para>Note that you can use the <ulink
    url="http://subversion.tigris.org/servlets/ProjectDocumentList?folderID=260&amp;expandFolder=74">
    Subversion dependencies package</ulink> as a substitute for
    <application>SQLite</application> and the APR requirements (see the
    <filename>INSTALL</filename> file for information on how to utilize this
    package)</para>

    <para>If you require the <application>Berkeley DB</application> back-end
    hooks in <application>Subversion</application> to build or support BDB
    based repositories, you must have <application>Berkeley DB</application>
    linked into the <application>APR-util</application> library. There is
    information in the <xref linkend="apache"/> instructions that shows the
    required parameters to pass to the <command>configure</command> script when
    building any of the <application>APR-util</application> packages.</para>

    <bridgehead renderas="sect4">Optional</bridgehead>
    <para role="optional"><xref linkend="python"/> (required to run the test suite),
    <xref linkend="db"/>,
    <xref linkend="sqlite"/>,
    <xref linkend="cyrus-sasl"/>,
    <xref linkend="openssl"/>,
    <xref linkend="dbus-glib"/>,
    <xref linkend="gnome-keyring"/>,
    <xref linkend="kdelibs"/>,
    <xref linkend="apache"/> (if you have <application>Apache Portable
    Runtime</application> installed), and
    <ulink url="http://www.webdav.org/neon/">neon</ulink> or
    <ulink url="http://code.google.com/p/serf/">serf</ulink></para>

    <!-- <para>* The <command>configure</command> script will warn that the
    installed <application>neon</application> version is not supported if the
    version is greater than &svn-neon-version;. You can circumvent this
    warning by passing <option>-disable-neon-version-check</option> to the
    <command>configure</command> command. Note that this may or may not work,
    depending on the version of <application>neon</application> you have
    installed, but <application>neon</application>-0.26.3 is known to
    work.</para> -->

    <bridgehead renderas="sect4">Optional to Build the Java Bindings</bridgehead>
    <para role="optional"><xref linkend="jdk"/> or
    <ulink url="http://www.inet.no/dante/">Dante</ulink> or
    <ulink url="http://oss.software.ibm.com/developerworks/opensource/jikes/">Jikes</ulink>,
    and <xref linkend="junit"/> (to test the Java bindings)</para>

    <bridgehead renderas="sect4">Optional to Build the SWIG Bindings</bridgehead>
    <para role="optional"><ulink url="http://www.swig.org">SWIG</ulink>**,
    <xref linkend="python"/>, and
    <xref linkend="ruby"/></para>

    <para>** The <command>configure</command> script will issue warnings if
    the installed version of <application>SWIG</application> is greater than
    &svn-swig-version;, but will attempt to use it anyway if you build the
    <application>SWIG</application> bindings. Versions of
    <application>SWIG</application> up to 1.3.40 are known to work.</para>

    <!-- <para>Note that the <application>Python</application>,
    <application>Perl</application> and <application>Ruby</application>
    bindings will not compile properly with the current version of
    <application>SWIG</application>. To build the bindings, you must have
    <application>SWIG</application>-1.3.{24,25} installed. Complete
    instructions for building the <application>SWIG</application> bindings
    can be found in the <application>Subversion</application> source tree
    file <filename>./subversion/bindings/swig/INSTALL</filename>.</para> -->

    <para condition="html" role="usernotes">User Notes:
    <ulink url="&blfs-wiki;/subversion"/></para>

  </sect2>

  <sect2 role="installation">
    <title>Installation of Subversion</title>

    <!-- <caution>
      <para>For reasons that are not yet fully understood,
      <application>Subversion</application> repositories based on some versions
      of <application>Berkeley DB</application> (notably 4.4.x) may not perform
      reliably. Though there have been no reports of corrupted databases caused
      by this issue, the <application>Subversion</application> test suite may
      report a failure in one of the tests due to problems opening a repository
      based on <application>Berkeley DB</application>. This issue only affects
      BDB-based repositories on a local installation and does not affect access
      to a BDB-based repository on a remote system built with older versions of
      <application>Subversion</application> or
      <application>Berkeley DB</application>.</para>

      <para>For these reasons, the <application>Berkeley DB</application>
      back-end is disabled, and any local BDB-based repositories you may have
      will be unavailable after installing <application>Subversion</application>
      using the following instructions. Please reference the information at
      <ulink
      url="http://svnbook.red-bean.com/en/1.1/ch05s03.html#svn-ch-5-sect-3.5"/>
      if you need to migrate your repositores.</para>
    </caution> -->

    <para>Install <application>Subversion</application> by running the
    following commands:</para>

<screen><userinput>./configure --prefix=/usr &amp;&amp;
make</userinput></screen>

    <para>If you have <xref linkend="doxygen"/> installed and you wish to
    build the API documentation, issue:
    <command>doxygen doc/doxygen.conf</command>.</para>

    <!-- <note>
      <para>If you have <application>Apache</application> installed, pass
      the <option>-with-apr=/usr</option> and
      <option>-with-apr-util=/usr</option> switches to the
      <command>configure</command> script. Otherwise,
      <application>Subversion</application> will overwrite APR and APR-utils
      from the <application>Apache</application> installation with the source
      distribution files. You may also need to pass
      <option>-with-apxs=/usr/sbin/apxs</option> as <command>apxs</command>
      might not be in an unprivileged user's <envar>PATH</envar> and won't be
      properly discovered. Additionally if you have
      <application>Apache</application> installed, you may safely remove the
      <parameter>-with-installbuilddir=/usr/lib/apr-0</parameter> parameter
      as it will have no effect.</para>
    </note> -->

    <para>If you passed the <option>--enable-javahl</option> parameter to
    <command>configure</command> and wish to build the Java bindings, issue
    the following command:</para>

<screen><userinput>make javahl</userinput></screen>

    <para>If you have the necessary dependencies installed and you wish to
    build the <application>Perl</application>,
    <application>Python</application> and/or
    <application>Ruby</application> bindings, issue any or all of the following
    commands:</para>

<screen><userinput>make swig-pl &amp;&amp;
make swig-py &amp;&amp;
make swig-rb</userinput></screen>

    <para>To test the results, issue: <command>make check</command>.</para>

    <para>To test the results of the Java bindings build, issue
    <command>make check-javahl</command>. Note you must have the
    <application>JUnit</application> testing framework installed.</para>

    <para>To test the results of any or all of the
    <application>SWIG</application> bindings, you can use the following
    commands:</para>

<screen><userinput>make check-swig-pl &amp;&amp;
make check-swig-py &amp;&amp;
make check-swig-rb</userinput></screen>

    <para>Now, as the <systemitem class="username">root</systemitem> user:</para>

<screen role='root'><userinput>make install &amp;&amp;
install -v -m755 -d /usr/share/doc/subversion-&subversion-version; &amp;&amp;
cp      -v -R       doc/* \
                    /usr/share/doc/subversion-&subversion-version;</userinput></screen>

    <para>If you built the Java bindings, issue the following command
    as the <systemitem class="username">root</systemitem> user to install
    them:</para>

<screen role='root'><userinput>make install-javahl</userinput></screen>

    <para>If you built any of the <application>SWIG</application> bindings,
    issue any or all of the following commands as the
    <systemitem class="username">root</systemitem> user to install them:</para>

<screen role='root'><userinput>make install-swig-pl &amp;&amp;
make install-swig-py &amp;&amp;
make install-swig-rb</userinput></screen>

    <para>In order for <application>Python</application> to automatically
    discover the bindings, add
    <filename class='directory'>/usr/lib/svn-python</filename> to the
    <envar>PYTHONPATH</envar> environment variable to the system or
    personal profiles.</para>

  </sect2>

  <sect2 role="commands">
    <title>Command Explanations</title>

    <para><command>sed -i '...' .../Makefile.PL.in</command>: This command
    is used to fix a problem with compiling the <application>Perl</application>
    bindings. It can be omitted if you're not building the bindings.</para>

    <para><option>--with-neon=<replaceable>&lt;prefix&gt;</replaceable></option>:
    This option should be used if you wish to use a system-installed version
    of <application>neon</application>.</para>

    <para><option>--with-apr=<replaceable>&lt;prefix&gt;</replaceable>
    --with-apr-util=<replaceable>&lt;prefix&gt;</replaceable></option>:
    These options should be used if you wish to use the system-installed
    version of the <application>APR</application>. Ensure you identify the
    correct installation prefix.</para>

    <para><option>--with-apxs=/usr/sbin/apxs</option>: This option should be
    used to identify the system-installed version of the
    <command>apxs</command> command installed during the
    <application>Apache HTTPD</application> installation as
    <command>apxs</command> might not be in an unprivileged user's
    <envar>PATH</envar> and won't be properly discovered.</para>

    <!-- <para><parameter>-with-installbuilddir=/usr/lib/apr-0</parameter>:
    This parameter is used (and only has an effect if you used the
    <application>Subversion dependencies</application> package) to force the
    installation of some APR-related support programs to
    <filename class="directory">/usr/lib/apr-0</filename> instead of
    <filename class="directory">/usr/build</filename>.</para> -->

  </sect2>

  <sect2 role="configuration">
    <title>Configuring Subversion</title>

    <sect3 id="subversion-config">
      <title>Config Files</title>

      <para><filename>~/.subversion/config</filename> and
      <filename>/etc/subversion/config</filename></para>

      <indexterm zone="subversion subversion-config">
        <primary sortas="e-AA.subversion/config">~/.subversion/config</primary>
      </indexterm>

      <indexterm zone="subversion subversion-config">
        <primary sortas="e-etc-subversion-config">/etc/subversion/config</primary>
      </indexterm>

    </sect3>

    <sect3>
      <title>Configuration Information</title>

      <para><filename>/etc/subversion/config</filename> is the
      <application>Subversion</application> system-wide configuration file.
      This file is used to specify defaults for different
      <command>svn</command> commands.</para>

      <para><filename>~/.subversion/config</filename> is the user's personal
      configuration file. It is used to override the system-wide defaults
      set in <filename>/etc/subversion/config</filename>.</para>

    </sect3>

  </sect2>

  <sect2 role="content">
    <title>Contents</title>

    <segmentedlist>
      <segtitle>Installed Programs</segtitle>
      <segtitle>Installed Libraries</segtitle>
      <segtitle>Installed Directories</segtitle>

      <seglistitem>
        <seg>svn, svnadmin, svndumpfilter, svnlook, svnserve, svnsync and
        svnversion</seg>
        <seg>libsvn*.{so,a} and optionally, a Java library, the mod_dav_svn.so,
        and mod_authz_svn.so <application>Apache HTTP</application>
        DSO modules and various <application>Perl</application>,
        <application>Python</application> and <application>Ruby</application>
        modules</seg>
        <seg>/usr/include/subversion-1,
        /usr/lib/perl5/site_perl/&lfs-perl-version;/i686-linux/auto/SVN (optional),
        /usr/lib/perl5/site_perl/&lfs-perl-version;/i686-linux/SVN (optional),
        /usr/lib/ruby/site_ruby/x.x/i686-linux/svn,
        /usr/lib/svn-javahl (optional),
        /usr/lib/svn-python (optional) and
        /usr/share/doc/subversion-&subversion-version;</seg>
      </seglistitem>
    </segmentedlist>

    <variablelist>
      <bridgehead renderas="sect3">Short Descriptions</bridgehead>
      <?dbfo list-presentation="list"?>
      <?dbhtml list-presentation="table"?>

      <varlistentry id="svn">
        <term><command>svn</command></term>
        <listitem>
          <para>is a command-line client program used to access
          <application>Subversion</application> repositories.</para>
          <indexterm zone="subversion svn">
            <primary sortas="b-svn">svn</primary>
          </indexterm>
        </listitem>
      </varlistentry>

      <varlistentry id="svnadmin">
        <term><command>svnadmin</command></term>
        <listitem>
          <para>is a tool for creating, tweaking or repairing a
          <application>Subversion</application> repository.</para>
          <indexterm zone="subversion svnadmin">
            <primary sortas="b-svnadmin">svnadmin</primary>
          </indexterm>
        </listitem>
      </varlistentry>

      <varlistentry id="svndumpfilter">
        <term><command>svndumpfilter</command></term>
        <listitem>
          <para>is a program for filtering <application>Subversion</application>
          repository dumpfile format streams.</para>
          <indexterm zone="subversion svndumpfilter">
            <primary sortas="b-svndumpfilter">svndumpfilter</primary>
          </indexterm>
        </listitem>
      </varlistentry>

      <varlistentry id="svnlook">
        <term><command>svnlook</command></term>
        <listitem>
          <para>is a tool for inspecting a
          <application>Subversion</application> repository.</para>
          <indexterm zone="subversion svnlook">
            <primary sortas="b-svnlook">svnlook</primary>
          </indexterm>
        </listitem>
      </varlistentry>

      <varlistentry id="svnserve">
        <term><command>svnserve</command></term>
        <listitem>
          <para>is a custom standalone server program, able to run as a
          daemon process or invoked by SSH.</para>
          <indexterm zone="subversion svnserve">
           <primary sortas="b-svnserve">svnserve</primary>
          </indexterm>
        </listitem>
      </varlistentry>

      <varlistentry id="svnversion">
        <term><command>svnversion</command></term>
        <listitem>
          <para>is used to report the version number and state of a
          working <application>Subversion</application> repository copy.</para>
          <indexterm zone="subversion svnversion">
            <primary sortas="b-svnversion">svnversion</primary>
          </indexterm>
        </listitem>
      </varlistentry>

      <varlistentry id="neon-config">
        <term><command>neon-config</command></term>
        <listitem>
          <para>is a script which provides information about an installed
          copy of the <application>neon</application> library.</para>
          <indexterm zone="subversion neon-config">
            <primary sortas="b-neon-config">neon-config</primary>
          </indexterm>
        </listitem>
      </varlistentry>

      <varlistentry id="libsvn_star">
        <term><filename class='libraryfile'>libsvn_*.{so,a}</filename></term>
        <listitem>
          <para>are the support libraries used by the
          <application>Subversion</application> programs.</para>
          <indexterm zone="subversion libsvn_star">
            <primary sortas="c-libsvn_star">libsvn_*.{so,a}</primary>
          </indexterm>
        </listitem>
      </varlistentry>

      <varlistentry id="libneon">
        <term><filename class='libraryfile'>libneon.{so,a}</filename></term>
        <listitem>
          <para>is used as a high-level interface to common
          HTTP and WebDAV methods.</para>
          <indexterm zone="subversion libneon">
            <primary sortas="c-libneon">libneon.{so,a}</primary>
          </indexterm>
        </listitem>
      </varlistentry>

      <varlistentry id="mod_authz_svn">
        <term><filename class='libraryfile'>mod_authz_svn.so</filename></term>
        <listitem>
          <para>is a plug-in module for the <application>Apache</application>
          HTTP server, used to authenticate users to a
          <application>Subversion</application> repository over the Internet or an
          intranet.</para>
          <indexterm zone="subversion mod_authz_svn">
            <primary sortas="c-mod_authz_svn">mod_authz_svn.so</primary>
          </indexterm>
        </listitem>
      </varlistentry>

      <varlistentry id="mod_dav_svn">
        <term><filename class='libraryfile'>mod_dav_svn.so</filename></term>
        <listitem>
          <para>is a plug-in module for the <application>Apache</application>
          HTTP server, used to make a
          <application>Subversion</application> repository available to others over the
          Internet or an intranet.</para>
          <indexterm zone="subversion mod_dav_svn">
            <primary sortas="c-mod_authz_svn">mod_dav_svn.so</primary>
          </indexterm>
        </listitem>
      </varlistentry>

    </variablelist>

  </sect2>

</sect1>