Fingerprints of Casper Fabricius

Subversion is a brilliant piece of open-source software for version control. It is the heir of the renowned CVS and suprior to the infamous SourceSafe in every way. This tutorial is not about running a Subversion server - although it is easy and free - but about using Subversion for easy collaboration and version control in Windows.

What is version control?

Version control is basically about storing different versions of the same files, which enables you to go back previous versions in case you mess something up. Since the files are usually stored on a central server - often, but not necessarily, accessible from the internet - a nice side effect of version control is that it enables several people to work with the same set of files simultaneously, by letting everyone syncronize their files with the server.

What is a repository?

Remember the central server running Subversion? This is where the repositories is located. Each repository is a unique and seperate collection of files with a forthrunning version number. You usually create a new repository for each new project you choose to version control, but in case you can’t just create new repositories, there is no problem in grouping several projects in the same repository.

I assume that you already know two things: The url of the Subversion repository you want to work with, and the username and password to use with it. If not, feel free to expirement with (but not abuse) a test repository I have setup for this tutorial:

• Url: http://svn.casperfabricius.com/sandbox/
• Login: test
• Password: test

TortoiseSVN - making Subversion easy

Your first step is to install TortoiseSVN; a free open-source client for working with Subversion in Windows, which integrates seamlessly with Windows Explorer. Go on; download and install the latest version right now! (Select the TortoiseSVN-X.X.X.XXXX-svn- X.X.X.msi file.)

Once installed; start Windows Explorer or open My Computer from your desktop and create a folder a place where you would like to place your first repository - I usually keep mine in “C:\Projects”. Right-click on the folder (or in the “white space” inside it) to discover two new items in your context menu: “SVN Checkout” and “TortoiseSVN”. Select to “SVN Checkout” to make the folder your local working folder for the files in the repository. Enter the url of the repository you want to use, or use “http://svn.casperfabricius.com/sandbox/”. Enter your username and password (both are case-sensitive) or use test as both if you are checking out my test repository. I recommend that you check the “Save authentication” box, unless you are not using your own computer. I might encounter the message saying “Error validating server certificate …” during the process, if the repository is using SSL. It’s not a problem at all, just select “Accept Permantly” and go on with the tutorial. TortoiseSVN will now download any files in the repository to the folder, and add several new items to the context-menu, enabling you to syncronize with the Subversion repository. Your are ready to start using the repository!

Commit and update - your two basic commands

Basically, the point with Subversion is all about sharing your changes with others, and in turn getting their changes reflected in your local working copy of the repository. When you upload you files to the repository on the central server, you are in fact - in Subversion slang - commiting your changes. Every time some one commits a change, the Subversion server creates a new version of the repository. Not that it copies every single file in the repository each time a change is commited, but it creates change sets which enables the server to produce an exact copy of the repository in any given version. Even deleted files still exists in previous versions, so once you have commited something, you can always get it back later, no matter what changes other people make.

So how do you actually commit files? You right on the folder or inside the folder with the files you want to commit, and select “SVN Commit” from the context menu. This brings up an overview of all the files you have changed and new files that has not yet been added to the repository. You must actively check the box for new (non-versioned) files to get added and committed to the repository. You don’t have to add all files in the folder to the repository, actually; you should make sure that generated files - such as dll-files genereated from code files - are not added to the repository.

Updating - as you have probably guessed by now - is simply a matter of selecting “SVN Update” in the context menu and letting magic happen.

Merging and conflicts - two people; one file

But what happens if two people make changes to the same file? The scenario goes like this:

1. Bob and Alice both change helloworld.txt
2. Alice commits her version of the file, unknowingly that Bob has also made changes
3. Now Bob commits his version of file, but get’s an error message; his file is out of date
4. Bob fixes this by updating his local working copy, and most likely; Subversion is able to merge his changes automatically with Alice’s changes.
5. If Subversion cannot merge the changes; a conflict occurs.
6. Bob now needs to navigate to the conflicted file, select “TortoiseSVN > Edit conflicts” and the context menu for the file, manually merge the two files using the build-in program, and mark the conflict as resolved.
7. Bob are now able to commit his version of the file, which contains both his and Alice’s changes.
8. The next time Alice update, she gets Bob’s merged file and everyone is happy

Why does it work like this? Why aren’t the files “locked” so only one person can edit a file at the time? Well, for one thing; this way everyone in a team can work unbothered and even offline on the same set of files, and Subversion will (mostly) be able to merge the changes. If you are used to SourceSafe, it will probably take you a bit of time to get used to the idea, but it is - in my opinion - by the best way to work. Embrace merging and even conflicts - they are always easily resolved. If you can’t; Subversion also supports locking, but that’s another story.

One last thing: Subversion can’t (by default) merge binary files. It’s not a problem storing Word-documents, Visio-diagrams, Photoshop-images etc. in a Subversion repository, but once a conflict occurs; you are on your own.

Rearranging - renaming, moving and deleting files.

In time; your repositories grow big and ugly, and you’ll want to rearrange or clean up the mess. When doing this; it’s important to be aware that you can’t just rename, move and delete as you usually do it in “My Computer” or Windows Explorer. Well, you can, but Subversion won’t know it, and will consider a renamed or moved a new file, while restoring the file with the old name in it’s old location on your next update.

For this reason, you should always use the “Rename” and “Delete” commands in the “TortoiseSVN” sub menu in the context menu. This also applies to folders. Also, if you want to move a file to another folder in the repository, you should drag it with right mouse-button and drop it on the folder you want to move it to. This will open a context menu, and when you select “SVN Move versioned files here”, TortoiseSVN will make all the dirty work for you, moving the file to it’s new location.

The result of sticking to using the rename, delete and move command is that the files will automatically renamed, deleted and moved in other peoples local working copies once they update.

How do I get my own Subversion repository?

If you know me personally, I can probably be persuaded to create a repository for you. If you have our own server, or access to one, you can install Subversion following the instructions on http://subversion.tigris.org/.

Otherwise, there are plenty of companies that offers to fullfill all your Subversion needs. I can recommend these two, since I use them my selve:

• Dreamhost
• CVS Dude

Conclusion

I could go on for long about other features of Subversion and TortoiseSVN, but with this; the most basic and important commands and functionality are covered. Happy versioning!

Read more:

• http://subversion.tigris.org/
• http://tortoisesvn.tigris.org/