source: general/prog/subversion.xml@ d60cd837

elogind
Last change on this file since d60cd837 was d60cd837, checked in by DJ Lucas <dj@…>, 5 years ago

Merge to HEAD 21080.

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

  • Property mode set to 100644
File size: 19.0 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 subversion-download-http "https://archive.apache.org/dist/subversion/subversion-&subversion-version;.tar.bz2">
8 <!ENTITY subversion-download-ftp " ">
9 <!ENTITY subversion-md5sum "5797bf701d2d868fa964c7bbc4931267">
10 <!ENTITY subversion-size "8.1 MB">
11 <!-- for 1.11.0
12 make javahl: 0.4 SBU 26 MB;
13 swig-pl swig-py and swig-rb: 1.6 SBU 90 MB -->
14 <!ENTITY subversion-buildsize "174 MB (add 116 MB for bindings, 24 MB for docs, 1.0 GB for tests)">
15 <!ENTITY subversion-time "0.5 SBU (Using parallelism=4; add 2.0 SBU for bindings, 5.5 SBU for tests)">
16]>
17
18<sect1 id="subversion" xreflabel="Subversion-&subversion-version;">
19 <?dbhtml filename="subversion.html"?>
20
21 <sect1info>
22 <othername>$LastChangedBy$</othername>
23 <date>$Date$</date>
24 </sect1info>
25
26 <title>Subversion-&subversion-version;</title>
27
28 <indexterm zone="subversion">
29 <primary sortas="a-Subversion">Subversion</primary>
30 </indexterm>
31
32 <sect2 role="package">
33 <title>Introduction to Subversion</title>
34
35 <para>
36 <application>Subversion</application> is a version control system that is
37 designed to be a compelling replacement for <application>CVS</application>
38 in the open source community. It extends and enhances
39 <application>CVS</application>' feature set, while maintaining a similar
40 interface for those already familiar with <application>CVS</application>.
41 These instructions install the client and server software used to
42 manipulate a <application>Subversion</application> repository. Creation of
43 a repository is covered at <xref linkend="svnserver"/>.
44 </para>
45
46 &lfs83_checked;
47
48 <bridgehead renderas="sect3">Package Information</bridgehead>
49 <itemizedlist spacing="compact">
50 <listitem>
51 <para>
52 Download (HTTP): <ulink url="&subversion-download-http;"/>
53 </para>
54 </listitem>
55 <listitem>
56 <para>
57 Download (FTP): <ulink url="&subversion-download-ftp;"/>
58 </para>
59 </listitem>
60 <listitem>
61 <para>
62 Download MD5 sum: &subversion-md5sum;
63 </para>
64 </listitem>
65 <listitem>
66 <para>
67 Download size: &subversion-size;
68 </para>
69 </listitem>
70 <listitem>
71 <para>
72 Estimated disk space required: &subversion-buildsize;
73 </para>
74 </listitem>
75 <listitem>
76 <para>
77 Estimated build time: &subversion-time;
78 </para>
79 </listitem>
80 </itemizedlist>
81
82 <bridgehead renderas="sect3">Subversion Dependencies</bridgehead>
83
84 <bridgehead renderas="sect4">Required</bridgehead>
85 <para role="required">
86 <xref linkend="apr-util"/> and
87 <xref linkend="sqlite"/>
88 </para>
89
90 <bridgehead renderas="sect4">Recommended</bridgehead>
91 <para role="recommended">
92 <xref linkend="serf"/> (for handling http:// and https:// URLs)
93 </para>
94
95<!-- support for berkeley db is deprecated since 1.8
96 <note>
97 <para>
98 If you require the <application>Berkeley DB</application> back-end hooks
99 in <application>Subversion</application> to build or support BDB based
100 repositories, you must have <application>APR-util</application> linked to
101 the <application>Berkeley DB</application> library.
102 </para>
103 </note>
104-->
105
106 <bridgehead renderas="sect4">Optional</bridgehead>
107 <para role="optional">
108 <xref linkend="apache"/>,
109<!-- support for berkeley db is deprecated since 1.8
110 <xref linkend="db"/>,
111-->
112 <xref linkend="cyrus-sasl"/>,
113 <xref linkend="dbus"/>,
114 <xref linkend="libsecret"/>,
115<!-- <xref linkend="kdelibs"/> (for <ulink url="http://utils.kde.org/projects/kwalletmanager/">KWallet</ulink> support), -->
116 <xref linkend="python2"/> (with sqlite support for the tests),
117 <xref linkend="ruby"/>,
118 <xref linkend="swig"/> (for building Perl, Python and Ruby bindings),
119 <ulink url="https://github.com/lz4/lz4/releases">LZ4</ulink>, and
120 <ulink url="http://git.netsurf-browser.org/libutf8proc.git/">UTF8proc</ulink>
121 </para>
122
123 <bridgehead renderas="sect4">Optional (for the Java Bindings)</bridgehead>
124 <para role="optional">
125 One of <xref linkend="openjdk"/>,
126 <ulink url="http://www.inet.no/dante/">Dante</ulink> or
127 <ulink url="http://jikes.sourceforge.net/">Jikes</ulink>,
128 and <ulink url="https://junit.org/junit4/">JUnit 4</ulink>
129 (to test the Java bindings). Note that JUnit is included with
130 <xref linkend="apache-ant"/>.
131 </para>
132
133 <para condition="html" role="usernotes">
134 User Notes: <ulink url="&blfs-wiki;/subversion"/>
135 </para>
136
137 </sect2>
138
139 <sect2 role="installation">
140 <title>Installation of Subversion</title>
141
142 <note>
143 <para>
144 This package may fail during the make phase when using multiple
145 processors. If this occurs try continuing with
146 <emphasis>make -j1</emphasis> or redo the entire build process with
147 fresh sources using <emphasis>-j1</emphasis>.
148 </para>
149 </note>
150
151 <para>
152 Install <application>Subversion</application> by running the following
153 commands:
154 </para>
155
156<screen><userinput>./configure --prefix=/usr \
157 --disable-static \
158 --with-apache-libexecdir \
159 --with-lz4=internal \
160 --with-utf8proc=internal &amp;&amp;
161make</userinput></screen>
162
163 <para>
164 If you have <xref linkend="doxygen"/> installed and you wish to build the
165 API documentation, issue: <command>doxygen doc/doxygen.conf</command>.
166 </para>
167
168 <para>
169 If you passed the <option>--enable-javahl</option> parameter to
170 <command>configure</command> and wish to build the Java bindings, issue
171 the following command:
172 </para>
173 <para>
174 <screen><command>make javahl</command></screen>
175 </para>
176
177 <para>
178 If you want to compile <application>Perl</application>,
179 <application>Python2</application>, or <application>Ruby</application>
180 bindings, issue any of the following command:
181 </para>
182 <para>
183 <screen><command>make swig-pl</command> # for <application>Perl</application>
184<command>make swig-py \
185 swig_pydir=/usr/lib/python&python2-majorver;/site-packages/libsvn \
186 swig_pydir_extra=/usr/lib/python&python2-majorver;/site-packages/svn</command> # for <application>Python</application>
187<command>make swig-rb</command> # for <application>Ruby</application></screen>
188 </para>
189
190 <para>
191 To test the results, issue: <command>make check</command>.
192 </para>
193
194 <para>
195 To test the results of the Java bindings build,
196 issue <command>make check-javahl</command>. The
197 <application>JUnit</application> testing framework must be installed,
198 and the location of the JUnit jar has to be specified by passing the
199 <option>--with-junit=&lt;path to junit jar&gt;</option> parameter to
200 <command>configure</command>. Note that <application>JUnit</application>
201 is included in <xref linkend="apache-ant"/>, and can be accessed by
202 passing <option>--with-junit=/opt/ant/lib/junit-4.12.jar</option>
203 to <command>configure</command>.
204 </para>
205
206 <para>
207 To test the results of any of the <application>SWIG</application>
208 bindings, you can use any of the following commands:
209 <command>make check-swig-pl</command>,
210 <command> make check-swig-py</command>, or
211 <command>make check-swig-rb</command>.
212 </para>
213
214 <!-- <para>
215 The Ruby bindings test, <command>make check-swig-rb</command>, fails due
216 to errors in the test suite.
217 </para>
218 -->
219 <para>
220 Now, as the <systemitem class="username">root</systemitem> user:
221 </para>
222
223<screen role="root"><userinput>make install &amp;&amp;
224
225install -v -m755 -d /usr/share/doc/subversion-&subversion-version; &amp;&amp;
226cp -v -R doc/* \
227 /usr/share/doc/subversion-&subversion-version;</userinput></screen>
228
229 <para>
230 If you built the Java bindings, issue the following command as the
231 <systemitem class="username">root</systemitem> user to install them:
232 </para>
233 <para>
234<screen><command>make install-javahl</command></screen>
235 </para>
236
237 <para>
238 If you built the <application>Perl</application>,
239 <application>Python2</application>, or
240 <application>Ruby</application> bindings, issue any of the following
241 commands as the <systemitem class="username">root</systemitem> user
242 to install them:
243 </para>
244 <para>
245<screen><command>make install-swig-pl</command>
246<command>make install-swig-py \
247 swig_pydir=/usr/lib/python&python2-majorver;/site-packages/libsvn \
248 swig_pydir_extra=/usr/lib/python&python2-majorver;/site-packages/svn</command>
249<command>make install-swig-rb</command></screen>
250 </para>
251
252 </sect2>
253
254 <sect2 role="commands">
255 <title>Command Explanations</title>
256
257 <xi:include xmlns:xi="http://www.w3.org/2001/XInclude"
258 href="../../xincludes/static-libraries.xml"/>
259
260 <para>
261 <parameter>--with-apache-libexecdir</parameter>:
262 If <xref linkend="apache"/> is installed, the shared
263 <application>Apache</application> modules are
264 built. This switch allows to have those modules installed to
265 <application>Apache</application>'s configured module dir instead
266 of <filename class="directory">/usr/libexec</filename>. It has no effect
267 if <application>Apache</application> is not installed.
268 </para>
269
270 <para>
271 <parameter>--with-lz4=internal, --with-utf8proc=internal</parameter>:
272 Remove them if you have installed the optional dependencies.
273 </para>
274
275 <para>
276 <option>--enable-javahl</option>: enables compilation of Java high level
277 bindings. Running <command>make javahl</command> is necessary to do
278 the compilation.
279 </para>
280
281 <para>
282 <option>--with-junit=&lt;location of the junit jar file&gt;</option>:
283 gives the location of the junit jar, otherwise the javahl tests cannot
284 be run.
285 </para>
286
287 <para>
288 <option>--disable-gmock</option>: Do not use the Googlemock testing
289 framework.
290 </para>
291
292 </sect2>
293
294 <sect2 role="configuration">
295 <title>Configuring Subversion</title>
296
297 <sect3 id="subversion-config">
298 <title>Config Files</title>
299
300 <para>
301 <filename>~/.subversion/config</filename> and
302 <filename>/etc/subversion/config</filename>
303 </para>
304
305 <indexterm zone="subversion subversion-config">
306 <primary sortas="e-AA.subversion/config">~/.subversion/config</primary>
307 </indexterm>
308
309 <indexterm zone="subversion subversion-config">
310 <primary sortas="e-etc-subversion-config">/etc/subversion/config</primary>
311 </indexterm>
312 </sect3>
313
314 <sect3>
315 <title>Configuration Information</title>
316
317 <para>
318 <filename>/etc/subversion/config</filename> is the
319 <application>Subversion</application> system-wide configuration file.
320 This file is used to specify defaults for different
321 <command>svn</command> commands.
322 </para>
323
324 <para>
325 <filename>~/.subversion/config</filename> is the user's personal
326 configuration file. It is used to override the system-wide defaults set
327 in <filename>/etc/subversion/config</filename>.
328 </para>
329 </sect3>
330
331 </sect2>
332
333 <sect2 role="content">
334 <title>Contents</title>
335
336 <segmentedlist>
337 <segtitle>Installed Programs</segtitle>
338 <segtitle>Installed Libraries</segtitle>
339 <segtitle>Installed Directories</segtitle>
340
341 <seglistitem>
342 <seg>
343 svn, svnadmin, svnbench, svndumpfilter, svnfsfs, svnlook, svnmucc,
344 svnrdump, svnserve, svnsync, and svnversion
345 </seg>
346 <seg>
347 libsvn_*-1.so and optionally, a Java library, the mod_dav_svn.so and
348 and mod_authz_svn.so <application>Apache HTTP</application> DSO
349 modules and various <application>Perl</application>,
350 <application>Python</application> and
351 <application>Ruby</application> modules.
352 </seg>
353 <seg>
354 /usr/include/subversion-1,
355 /usr/lib/perl5/site_perl/&lfs-perl-version;/{,auto/}SVN,
356 /usr/lib/python2.7/site-packages/{libsvn,svn},
357 /usr/lib/ruby/site_ruby/&lt;x.y.z&gt;/{,&lt;arch-linux&gt;-linux/}svn,
358 /usr/lib/svn-javahl, and
359 /usr/share/doc/subversion-&subversion-version;
360 </seg>
361 </seglistitem>
362 </segmentedlist>
363
364 <variablelist>
365 <bridgehead renderas="sect3">Short Descriptions</bridgehead>
366 <?dbfo list-presentation="list"?>
367 <?dbhtml list-presentation="table"?>
368
369 <varlistentry id="svn">
370 <term><command>svn</command></term>
371 <listitem>
372 <para>
373 is a command-line client program used to access
374 <application>Subversion</application> repositories.
375 </para>
376 <indexterm zone="subversion svn">
377 <primary sortas="b-svn">svn</primary>
378 </indexterm>
379 </listitem>
380 </varlistentry>
381
382 <varlistentry id="svnadmin">
383 <term><command>svnadmin</command></term>
384 <listitem>
385 <para>
386 is a tool for creating, tweaking or repairing a
387 <application>Subversion</application> repository.
388 </para>
389 <indexterm zone="subversion svnadmin">
390 <primary sortas="b-svnadmin">svnadmin</primary>
391 </indexterm>
392 </listitem>
393 </varlistentry>
394
395 <varlistentry id="svnbench">
396 <term><command>svnbench</command></term>
397 <listitem>
398 <para>
399 is a benchmarking tool.
400 </para>
401 <indexterm zone="subversion svnbench">
402 <primary sortas="b-svnbench">svnbench</primary>
403 </indexterm>
404 </listitem>
405 </varlistentry>
406
407 <varlistentry id="svndumpfilter">
408 <term><command>svndumpfilter</command></term>
409 <listitem>
410 <para>
411 is a program for filtering <application>Subversion</application>
412 repository dumpfile format streams.
413 </para>
414 <indexterm zone="subversion svndumpfilter">
415 <primary sortas="b-svndumpfilter">svndumpfilter</primary>
416 </indexterm>
417 </listitem>
418 </varlistentry>
419
420 <varlistentry id="svnfsfs">
421 <term><command>svnfsfs</command></term>
422 <listitem>
423 <para>
424 is the FSFS (FileSystem atop of the FileSystem -
425 <application>Subversion</application> filesystem implementation)
426 repository manipulation tool.
427 </para>
428 <indexterm zone="subversion svnfsfs">
429 <primary sortas="b-svnfsfs">svnfsfs</primary>
430 </indexterm>
431 </listitem>
432 </varlistentry>
433
434 <varlistentry id="svnlook">
435 <term><command>svnlook</command></term>
436 <listitem>
437 <para>
438 is a tool for inspecting a <application>Subversion</application>
439 repository.
440 </para>
441 <indexterm zone="subversion svnlook">
442 <primary sortas="b-svnlook">svnlook</primary>
443 </indexterm>
444 </listitem>
445 </varlistentry>
446
447 <varlistentry id="svnmucc">
448 <term><command>svnmucc</command></term>
449 <listitem>
450 <para>
451 is a Multiple URL Command Client for <application>Subversion</application>.
452 </para>
453 <indexterm zone="subversion svnmucc">
454 <primary sortas="b-svnmucc">svnmucc</primary>
455 </indexterm>
456 </listitem>
457 </varlistentry>
458
459 <varlistentry id="svnrdump">
460 <term><command>svnrdump</command></term>
461 <listitem>
462 <para>
463 is a tool for dumping or loading a remote
464 <application>Subversion</application> repository.
465 </para>
466 <indexterm zone="subversion svnrdump">
467 <primary sortas="b-svnrdump">svnrdump</primary>
468 </indexterm>
469 </listitem>
470 </varlistentry>
471
472 <varlistentry id="svnserve">
473 <term><command>svnserve</command></term>
474 <listitem>
475 <para>
476 is a custom standalone server program, able to run as a daemon
477 process or invoked by SSH.
478 </para>
479 <indexterm zone="subversion svnserve">
480 <primary sortas="b-svnserve">svnserve</primary>
481 </indexterm>
482 </listitem>
483 </varlistentry>
484
485 <varlistentry id="svnsync">
486 <term><command>svnsync</command></term>
487 <listitem>
488 <para>
489 is a <application>Subversion</application> repository
490 synchronisation tool.
491 </para>
492 <indexterm zone="subversion svnsync">
493 <primary sortas="b-svnsync">svnsync</primary>
494 </indexterm>
495 </listitem>
496 </varlistentry>
497
498 <varlistentry id="svnversion">
499 <term><command>svnversion</command></term>
500 <listitem>
501 <para>
502 is used to report the version number and state of a working
503 <application>Subversion</application> repository copy.
504 </para>
505 <indexterm zone="subversion svnversion">
506 <primary sortas="b-svnversion">svnversion</primary>
507 </indexterm>
508 </listitem>
509 </varlistentry>
510
511 <varlistentry id="libsvn_star-1">
512 <term><filename class="libraryfile">libsvn_*-1.so</filename></term>
513 <listitem>
514 <para>
515 are the support libraries used by the
516 <application>Subversion</application> programs.
517 </para>
518 <indexterm zone="subversion libsvn_star-1">
519 <primary sortas="c-libsvn_star-1">libsvn_*-1.so</primary>
520 </indexterm>
521 </listitem>
522 </varlistentry>
523
524 <varlistentry id="mod_authz_svn">
525 <term><filename class="libraryfile">mod_authz_svn.so</filename></term>
526 <listitem>
527 <para>
528 is a plug-in module for the <application>Apache</application> HTTP
529 server, used to authenticate users to a
530 <application>Subversion</application> repository over the Internet
531 or an intranet.
532 </para>
533 <indexterm zone="subversion mod_authz_svn">
534 <primary sortas="c-mod_authz_svn">mod_authz_svn.so</primary>
535 </indexterm>
536 </listitem>
537 </varlistentry>
538
539 <varlistentry id="mod_dav_svn">
540 <term><filename class="libraryfile">mod_dav_svn.so</filename></term>
541 <listitem>
542 <para>
543 is a plug-in module for the <application>Apache</application> HTTP
544 server, used to make a <application>Subversion</application>
545 repository available to others over the Internet or an intranet.
546 </para>
547 <indexterm zone="subversion mod_dav_svn">
548 <primary sortas="c-mod_authz_svn">mod_dav_svn.so</primary>
549 </indexterm>
550 </listitem>
551 </varlistentry>
552
553 </variablelist>
554
555 </sect2>
556
557</sect1>
Note: See TracBrowser for help on using the repository browser.