Apache Subversion

Apache Subversion

64px
Original author(s)	CollabNet
Developer(s)	Apache Software Foundation
Initial release	20 October 2000 (2000-10-20)
Stable release	1.9.3 (December 15, 2015 (2015-12-15)) [±]
Preview release	1.9.0-beta1 (March 18, 2015 (2015-03-18)) [±]
Development status	Active
Written in	C
Operating system	Cross-platform
Type	Revision control
License	Apache License
Website	subversion.apache.org

Apache Subversion (often abbreviated SVN, after the command name svn) is a software versioning and revision control system distributed as free software under the Apache License. Software developers use Subversion to maintain current and historical versions of files such as source code, web pages, and documentation. Its goal is to be a mostly compatible successor to the widely used Concurrent Versions System (CVS).

The free software community has used Subversion widely: for example in projects such as Apache Software Foundation, Free Pascal, FreeBSD, GCC, Mono and SourceForge. Google Developers also provides Subversion hosting for their free software projects. CodePlex offers access to Subversion as well as to other types of clients.

The corporate world has also started to adopt Subversion. A 2007 report by Forrester Research recognized Subversion as the sole leader in the Standalone Software Configuration Management (SCM) category and as a strong performer in the Software Configuration and Change Management (SCCM) category.

Subversion was created by CollabNet Inc. in 2000, and is now a top-level Apache project being built and used by a global community of contributors.

History

CollabNet founded the Subversion project in 2000 as an effort to write an open-source version-control system which operated much like CVS but which fixed the bugs and supplied some features missing in CVS. By 2001, Subversion had advanced sufficiently to host its own source code, and in February 2004, version 1.0 was released. In November 2009, Subversion was accepted into Apache Incubator: this marked the beginning of the process to become a standard top-level Apache project. It became a top-level Apache project on February 17, 2010.

Version	Original release date	Latest version	Release date	Status
Old version, no longer supported: 1.0	2004-02-23	1.0.9	2004-10-13	No longer supported
Old version, no longer supported: 1.1	2004-09-29	1.1.4	2005-04-01	No longer supported
Old version, no longer supported: 1.2	2005-05-21	1.2.3	2005-08-19	No longer supported
Old version, no longer supported: 1.3	2005-12-30	1.3.2	2006-05-23	No longer supported
Old version, no longer supported: 1.4	2006-09-10	1.4.6	2007-12-21	No longer supported
Old version, no longer supported: 1.5	2008-06-19	1.5.9	2010-12-06	No longer supported
Old version, no longer supported: 1.6	2009-03-20	1.6.23	2013-05-30	No longer supported
Old version, no longer supported: 1.7	2011-10-11	1.7.22	2015-08-12	No longer supported
Older version, yet still supported: 1.8	2013-06-18	1.8.15	2015-12-15	Partially supported
Current stable version: 1.9	2015-08-05	1.9.3	2015-12-15	Fully supported
Legend: Old version Older version, still supported Latest version Latest preview version Future release

Features

• Commits as true atomic operations (interrupted commit operations in CVS would cause repository inconsistency or corruption).
• Renamed/copied/moved/removed files retain full revision history.
• The system maintains versioning for directories, renames, and file metadata (but not for timestamps). Users can move and/or copy entire directory-trees very quickly, while retaining full revision history.
• Versioning of symbolic links.
• Native support for binary files, with space-efficient binary-diff storage.
• Apache HTTP Server as network server, WebDAV/Delta-V for protocol. There is also an independent server process called svnserve that uses a custom protocol over TCP/IP.
• Branching is a cheap operation, independent of file size (though Subversion itself does not distinguish between a branch and a directory)
• Natively client–server, layered library design.
• Client/server protocol sends diffs in both directions.
• Costs proportional to change size, not to data size.
• Parsable output, including XML log output.
• Free software licensed – Apache License since the 1.7 release; prior versions use a derivative of the Apache Software License 1.1.
• Internationalized program messages.
• File locking for unmergeable files ("reserved checkouts").
• Path-based authorization.
• Language bindings for C#, PHP, Python, Perl, Ruby, and Java.
• Full MIME support – users can view or change the MIME type of each file, with the software knowing which MIME types can have their differences from previous versions shown.
• Merge tracking – Merges between branches will be tracked, this allows automatically merging between branches without telling Subversion what (doesn't) need to be merged.
• Changelists to organize commits into commit groups.

Repository types

Subversion offers two types of repository storage.

Berkeley DB (deprecated)

The original development of Subversion used the Berkeley DB package. Subversion has some limitations with Berkeley DB usage when a program that accesses the database crashes or terminates forcibly. No data loss or corruption occurs, but the repository remains offline while Berkeley DB replays the journal and cleans up any outstanding locks. The safest way to use Subversion with a Berkeley DB repository involves a single server-process running as one user (instead of through a shared filesystem).

FSFS

In 2004, a new storage subsystem was developed and named FSFS. It works faster than the Berkeley DB backend on directories with a large number of files and takes less disk space, due to less logging.

Beginning with Subversion 1.2, FSFS became the default data store for new repositories.

The etymology of "FSFS" is based on Subversion's use of the term "filesystem" for its repository storage system. FSFS stores its contents directly within the operating system's filesystem, rather than a structured system like Berkeley DB. Thus, it is a "[Subversion] FileSystem atop the FileSystem".

Repository access

Main article: Comparison of Subversion clients

Access to Subversion repositories can take place by:

1. Local filesystem or network filesystem, accessed by client directly. This mode uses the file:///path access scheme.
2. WebDAV/Delta-V (over http or https) using the mod_dav_svn module for Apache 2. This mode uses the http://host/path access scheme or https://host/path for secure connections using ssl.
3. Custom "svn" protocol (default port 3690), using plain text or over TCP/IP. This mode uses either the svn://host/path access scheme for unencrypted transport or svn+ssh://host/path scheme for tunneling over ssh.

All three means can access both FSFS and Berkeley DB repositories.

Any 1.x version of a client can work with any 1.x server. Newer clients and servers have additional features and performance capabilities, but have fallback support for older clients/servers.

Layers

Internally, a Subversion system comprises several libraries arranged as layers. Each performs a specific task and allows developers to create their own tools at the desired level of complexity and specificity.

Fs 

The lowest level; it implements the versioned filesystem which stores the user data.

Repos 

Concerned with the repository built up around the filesystem. It has many helper functions and handles the various "hooks" that a repository may have, e.g. scripts that run when an action is performed. Together, Fs and Repos constitute the "filesystem interface".

mod_dav_svn 

Provides WebDAV/Delta-V access through Apache 2.

Ra 

Handles "repository access", both local and remote. From this point on, repositories are referred to using URLs, e.g.

• file:///path/ for local access,
• http://host/path/ or https://host/path/ for WebDAV access, or
• svn://host/path/ or svn+ssh://host/path/ for the SVN protocol.

Client, Wc 

The highest level. It abstracts repository access and provides common client tasks, such as authenticating users or comparing versions. Subversion clients use the Wc library to manage the local working copy.

Filesystem

File:Svn 3D-tree.svg

250px

One can view the Subversion filesystem as "two-dimensional". Two coordinates are used to unambiguously address filesystem items:

• Path (regular path of Unix-like OS filesystem)
• Revision

Each revision in a Subversion filesystem has its own root, which is used to access contents at that revision. Files are stored as links to the most recent change; thus a Subversion repository is quite compact. The system consumes storage space proportional to the number of changes made, not to the number of revisions.

The Subversion filesystem uses transactions to keep changes atomic. A transaction operates on a specified revision of the filesystem, not necessarily the latest. The transaction has its own root, on which changes are made. It is then either committed and becomes the latest revision, or is aborted. The transaction is actually a long-lived filesystem object; a client does not need to commit or abort a transaction itself, rather it can also begin a transaction, exit, and then can re-open the transaction and continue using it. Potentially, multiple clients can access the same transaction and work together on an atomic change, though no existing clients expose this capability.

Properties

One important feature of the Subversion filesystem is properties: simple name=value pairs of text. Properties occur on filesystem entries (i.e., files and directories). These are versioned just like other changes to the filesystem. Users can add any property they wish, and the Subversion client uses a set of properties, which it prefixes with 'svn:'.

svn:executable 

Makes files on Unix-hosted working copies executable.

svn:mime-type 

Stores the Internet media type ("MIME type") of a file. Affects the handling of diffs and merging.

svn:ignore 

A list of filename patterns to ignore in a directory. Similar to CVS's .cvsignore file.

svn:keywords 

A list of keywords to substitute into a file when changes are made. The file itself must also reference the keywords as $keyword$ or $keyword:...$. This is used to maintain certain information (e.g., author, date of last change, revision number) in a file without human intervention.
The keyword substitution mechanism originates from RCS and from CVS.

svn:eol-style 

Makes the client convert end-of-line characters in text files. Used when the working copy is needed with a specific EOL style. "native" is commonly used, so that EOLs match the user's OS EOL style. Repositories may require this property on all files to prevent inconsistent line endings, which can cause a problem in itself.

svn:externals 

Allows parts of other repositories to be automatically checked-out into a sub-directory.

svn:needs-lock 

Specifies that a file is to be checked out with file permissions set to read-only. This is designed for use with the locking mechanism. The read-only permission reminds one to obtain a lock before modifying the file: obtaining a lock makes the file writable, and releasing the lock makes it read-only again. Locks are only enforced during a commit operation. Locks can be used without setting this property. However, that is not recommended, because it introduces the risk of someone modifying a locked file; they will only discover it has been locked when their commit fails.

svn:special 

This property is not meant to be set or modified directly by users. As of 2010 it is only used for having symbolic links in the repository. When a symbolic link is added to the repository, a file containing the link target is created with this property set. When a Unix-like system checks out this file, the client converts it to a symbolic link.

svn:mergeinfo 

Used to track merge data (revision numbers) in Subversion 1.5 (or later). This property is automatically maintained by the merge command, and it is not recommended to change its value manually.

Subversion also uses properties on revisions themselves. Like the above properties on filesystem entries the names are completely arbitrary, with the Subversion client using certain properties prefixed with 'svn:'. However, these properties are not versioned and can be changed later.

svn:date 

the date and time stamp of a revision

svn:author 

the name of the user that submitted the change(s)

svn:log 

the user-supplied description of the change(s);

Branching and tagging

Subversion uses the inter-file branching model from Perforce to implement branches and tagging. A branch is a separate line of development. Tagging refers to labeling the repository at a certain point in time so that it can be easily found in the future. In Subversion, the only difference between branches and tags is how they are used.

A new branch or tag is set up by using the "svn copy" command, which should be used in place of the native operating system mechanism. The copied directory is linked to the original in the repository to preserve its history, and the copy takes very little extra space in the repository.

All the versions in each branch maintain the history of the file up to the point of the copy, plus any changes made since. One can "merge" changes back into the trunk or between branches.

File:Subversion project visualization.svg

Visualization of a simple Subversion project

Limitations and problems

A known problem in Subversion affects the implementation of the file and directory rename' operation. As of 2014, Subversion implements the renaming of files and directories as a "copy" to the new name followed by a "delete" of the old name. Only the names change, all data relating to the edit history remains the same, and Subversion will still use the old name in older revisions of the "tree". However, Subversion may become confused when a move conflicts with edits made elsewhere, both for regular commits and when merging branches. The Subversion 1.5 release addressed some of these scenarios while others remained problematic. The Subversion 1.8 release addressed some of these problems by making moves a first-class operation on the client, but it is still treated as copy+delete in the repository.

As of 2013, Subversion lacks some repository-administration and management features. For instance, someone may wish to edit the repository to permanently remove all historical records of certain data. Subversion does not have built-in support to achieve this simply.

Subversion stores additional copies of data on the local machine, which can become an issue with very large projects or files, or if developers work on multiple branches simultaneously. In versions prior to 1.7 these .svn directories on the client side could become corrupted by ill-advised user activity like global search/replace operations. Starting with version 1.7 Subversion uses a single centralized .svn folder per working area.

Subversion does not store the modification times of files. As such, a file checked out of a Subversion repository will have the 'current' date (instead of the modification time in the repository), and a file checked into the repository will have the date of the check-in (instead of the modification time of the file being checked in). This might not always be what is wanted. To mitigate this, third-party tools exist that allow for preserving modification time and other filesystem meta-data. However, giving checked out files a current date is important as well — this is how tools like make(1) will take notice of a changed file for rebuilding it.

Subversion uses a centralized revision control model. Ben Collins-Sussman, one of the designers of Subversion, believes a centralised model would help prevent "insecure programmers" from hiding their work from other team members. Some users of version control systems see the centralised model as detrimental; famously, Linus Torvalds attacked Subversion's model and its developers.

Subversion often does not deal well with the filename mangling performed by the HFS+ filesystem. This can cause problems when files with accented characters in their names are added to the repository on a non-HFS+ filesystem and the repository is then used with HFS+.

Subversion tags and branches

Revision numbers are difficult to remember in any version-control system. For this reason, most systems offer symbolic tags as user-friendly references to them. Subversion does not have such a feature and what its documentation recommends to use instead is very different in nature. Instead of implementing tags as references to points in history, Subversion recommends making snapshot copies into a well-known subdirectory ("tags/") in the space of the repository tree. Only a few predefined references are available: HEAD, BASE, PREV and COMMITTED.

This history-to-space projection has multiple issues:

1. When a snapshot is taken, the system does not assign any special meaning to the name of the tag/snapshot. This is the difference between a copy and a reference. The revision is recorded and the snapshot can be accessed by URL. This makes some operations less convenient and others impossible. For instance, a naïve svn diff -r tag1:tag2 myfile does not work; it is slightly more complicated than that to achieve, requiring the user to know and input URL/paths to the snapshots instead of just the names: svn diff <URL-TO-TAG1>/myfile <URL-TO-TAG2>/myfile. Other operations like for instance svn log -r tag1:tag2 myfile are just impossible.

2. When two (ideally independent) object types live in the repository tree, a "fight to the top" can ensue. In other words, it is often difficult to decide at which level to create the "tags/" subdirectory:

trunk/ /componentfoo/ /componentbar/ tags/ /1.1/ /componentfoo/ /componentbar/

or

componentfoo/ /trunk/ /tags/ /1.1/ componentbar/ /trunk/ /tags/ /1.1/

3. Tags, by their conventional definition are both read-only and light-weight, on the repository and client. Subversion copies are not read-only, and while they are light-weight on the repository, they are incredibly heavy-weight on the client.

To address such issues, posters on the Subversion mailing lists have suggested a new feature called "labels" or "aliases". SVN labels would more closely resemble the "tags" of other systems such as CVS or Git. The fact that Subversion has global revision numbers opens the way to a very simple label->revision implementation. Yet as of 2013, no progress has been made and symbolic tags are not in the list of the most wanted features.

Development and implementation

CollabNet has continued its involvement with Subversion, but the project runs as an independent open source community. In November 2009, the project was accepted into the Apache Incubator, aiming to become part of the Apache Software Foundation's efforts. Since March 2010, the project is formally known as Apache Subversion, being a part of the Apache Top-Level Projects.

In October 2009, WANdisco announced the hiring of core Subversion committers as the company moved to become a major corporate sponsor of the project. This included Hyrum Wright, president of the Subversion Corporation and release manager for the Subversion project since early 2008, who joined the company to lead its open source team.

The Subversion open-source community does not provide binaries, but potential users can download binaries from volunteers. While the Subversion project does not include an official graphical user interface (GUI) for use with Subversion, third parties have developed a number of different GUIs, along with a wide variety of additional ancillary software.

Work announced in 2009 included SubversionJ (a Java API) and implementation of the Obliterate command, similar to that provided by Perforce. Both of these enhancements were sponsored by WANdisco.

The Subversion committers normally have at least one or two new features under active development at any one time. The 1.7 release of Subversion in October 2011 included a streamlined HTTP transport to improve performance and a rewritten working-copy library.

See also

• List of revision control software
• Comparison of revision control software
• Comparison of Subversion clients
• List of software that uses Subversion
• TortoiseSVN

References

• C. Michael Pilato, Ben Collins-Sussman, Brian W. Fitzpatrick; Version Control with Subversion; O'Reilly; ISBN 0-596-00448-6 (1st edition, paperback, 2004, full book online, mirror)
• Garrett Rooney; Practical Subversion; Apress; ISBN 1-59059-290-5 (1st edition, paperback, 2005)
• Mike Mason; Pragmatic Version Control Using Subversion; Pragmatic Bookshelf; ISBN 0-9745140-6-3 (1st edition, paperback, 2005)
• William Nagel; Subversion Version Control: Using the Subversion Version Control System in Development Projects; Prentice Hall; ISBN 0-13-185518-2 (1st edition, paperback, 2005)

Further reading

• Dispelling Subversion FUD by Ben Collins-Sussman (Subversion developer), link broken as of 2013-03-07 (Internet Archive.org Wayback Machine 2011-07-18 captured version, "last updated" 2004-12-21)

External links

• • Previous official site Not all content has yet been migrated to the new official site.
• Version Control with Subversion, an O'Reilly book available for free online
• Subversion at DMOZ