Using Subversion with TortoiseSVN

Introduction

Subversion is an open source application which is used to build version control system. This document will give a detailed idea about the installation and usage of subversion by using the tool TortoiseSVN.

Install Subversion Client

TortoiseSVN is a very useful and very easy tool for doing all the subversion repository operations and is freely available.

For installing TortoiseSVN, do the following steps.

1. Download TortoiseSVN from http://tortoisesvn.net/downloads
2. Install the application by double clicking the .msi file.
3. Restart the computer.

Accessing the Repository

Right click on the desktop and from the menu select TortoiseSVN->Repo Browser as shown in the figure

In the coming screen type the url of the repository say [http://MyServerName/svn/MyRepos or svn://MyServerName/MyRepos] and clicks OK.

It will display an authentication screen as shown below with provision to provide user id and password to login to repository. The subversion administrator will provide a user id and password for your repository access.

Check save authentication for saving the user name and password and click on [OK]. Now the following screen will appear displaying the repository contents.

Checking Out a Working Copy

To obtain a working copy you need to do a checkout from a repository. For checking out a project, right click on any folder inside the repo browser as shown.

Or

Select a directory in windows explorer where you want to place your working copy. Right click to pop up the context menu and select the command SVNCheckout... as shown below.

Now it will bring another popup shown below.

Provide the directory name and press OK. It will checkout (getting the latest version) the selected repository to the checkout directory.If you enter a folder name that does not yet exist, then a directory with that name is created. You should only check out into an empty directory.

Icon Overlay

One of the most visible features of TortoiseSVN is the icon overlays which appear on files in your working copy.

Icon Explaination

1. A fresh checked out working copy has a green checkmark as overlay. That means the Subversion status is normal.

2. As soon as you start editing a file, the status changes to modified and the icon overlay then changes to a red exclamation mark. That way you can easily see which files were changed since you last updated your working copy and need to be committed.

3. If during an update a conflict occurs then the icon changes to a yellow exclamation mark.

4. If you have set the svn:needs-lock property on a file, Subversion makes that file read-only until you get a lock on that file. Read-only files have this overlay to indicate that you have to get a lock first before you can edit that file.

5. If you hold a lock on a file, and the Subversion status is normal, this icon overlay reminds you that you should release the lock if you are not using it to allow others to commit their changes to the file.

6. This icon shows you that some files or folders inside the current folder have been scheduled to be deleted from version control or a file under version control is missing in a folder.

7. The plus sign tells you that a file or folder has been scheduled to be added to version control.

Sending Your Changes to the Repository

Sending the changes you made to your working copy is known as committing the changes. But before you commit you have to make sure that your working copy is up to date. You can either use TortoiseSVN → Update directly. Or you can use TortoiseSVN → Check for Modifications first, to see which files have changed locally or on the server.

If your working copy is up to date and there are no conflicts, you are ready to commit your changes. Select any file and/or folders you want to commit, then TortoiseSVN → Commit....

Now tortoiseSVN commit dialog will come.

Clicking on OK will commit your changes to repository.

Update Your Working Copy with Changes from Others

Periodically, you should ensure that changes done by others get incorporated in your local working copy. The process of getting changes from the server to your local copy is known as updating. Updating may be done on single files, a set of selected files, or recursively on entire directory hierarchies. To update, select the files and/or directories you want, right click and select TortoiseSVN → Update in the explorer context menu.

A window will pop up displaying the progress of the update as it runs.

Changes done by others will be merged into your files, keeping any changes you may have done to the same files. The repository is not affected by an update.

The progress dialog uses colour coding to highlight different update actions

Purple

New item added to your WC.

Dark red

Redundant item deleted from your WC, or missing item replaced in your WC.

Green

Changes from repository successfully merged with your local changes.

Bright red

Changes from repository merged with local changes, resulting in conflicts which you need to resolve.

Black

Unchanged item in your WC updated with newer version from the repository.

Adding New Files and Directories

If you created new files and/or directories during your development process then you need to add them to source control too. Select the file(be) and/or directory from your working directory and use TortoiseSVN → Add.

Now it will bring a popup as shown below.

Select the required file(be) and folder(be) and click on OK. After you added the files/directories to source control the file appears with an added icon overlay which means you first have to commit your working copy to make those files/directories available to other developers

To add files from outside your working copy you can use the drag-and-drop handler:

1) Select the files you want to add

2) Right-drag them to the new location inside the working copy

3) Release the right mouse button

4) Select Context Menu SVN Add files to this WC. The files will then be copied to the working copy and added to version control after clicking the commit menu item.

Another way to add the files and folder is by using the repo browser; you can directly drag and drop any item into the required location. But it will not update your working copy. You can use TortoiseSVN→SVN Update option to reflect the newly added items to the working copy.

Adding New Files and Directories

Delete

If you delete a file/directory using TSVN, the file is removed from your working copy and marked for deletion. The file'be parent folder shows a "deleted" icon overlay. You can always get the file back, if you call TortoiseSVN → Revert on the parent folder.

Move

If you want to move files inside a working copy, use the drag-and-drop handler again:

1) Select the files or directories you want to move

2) Right-drag them to the new location inside the working copy

3) Release the right mouse button

4) In the popup menu select Context Menu → SVN Move versioned files here

After moving, renaming or deleting, use SVNCommit option to commit the changes to the repository.

If a file is deleted via the explorer instead of using the TortoiseSVN context menu, the commit dialog shows those files and lets you remove them from version control too before the commit. However, if you update your working copy, Subversion will spot the missing file and replace it with the latest version from the repository. If you need to delete a version-controlled file, always use TortoiseSVN → Delete so that Subversion doesn't have to guess what you really want to do.

If a folder is deleted via the explorer instead of using the TortoiseSVN context menu, your working copy will be broken and you will be unable to commit. If you update your working copy, Subversion will replace the missing folder with the latest version from the repository and you can then delete it the correct way using TortoiseSVN → Delete.

You can directly delete any file or folder by using TortoiseSVN repo browser.

Deny Multiple Checkout

By default, the subversion provides a local copy to all the users and each user can do their modification. Now the problem is, if a user submits their modification after the submission of another user, the subversion will show a message showing out of date, and so we have to merge those changes to the previous version. That means subversion works best without locking, using the "Copy-Modify-Merge" methods. But the main problem is in the case of "unmergeable" files, for example, graphics files, if two people change the same file, merging is not possible, so one of them will lose their changes.

For avoiding this problem, a method called "Locking" which allows only a single user can modify the repository item.

This can be achieved by doing the following steps.

Set the svn:needs-lockPropery to the File(be) or Directory

From the propery list window select [Add] button.

From the property name combo box, select svn:need-lock property.

Click on [OK] and submit your changes to the repository by select TortoiseSVN → SVNCommit which is explained above. Now the icon of the property set item is displayed as shown below.

NB: - For setting the svn:need-lock property for a folder, there is a small difference. I.e, the add property dialog will not display this property in the combo box. So we have to type the property into the editable combo box and check the apply property recursively (if required) for recursively apply the property. The property will not be displayed in the property editor of the folder that we applied, but it will list only for the individual subfiles.

We cannot edit a file with the svn:needs-lock propery (files with grey checked icon).

Getting Lock

A user cannot edit a file which has the property svn:needs-lock (The files become readonly). So for editing the document, right click on the readonly file and select TortoiseSVN → Get lock and commit the changes to the repository.

Now the locked user gets the privilege to modify the file and submit his changes to the repository. All other users cannot edit the file and submit it to the repository (like VSS).

Make the Checkin Comments Mandatory

For this purpose, rightclick on the directory in the working folder and select the property add editor.

Select the tsvn:logminimize property and set the minimum required length to our required size say 25 and commit the changes to the repository.

Now each user can commit their changes to this particular directory only after entering comments with minimum 25 charectors length, because the [OK] button will be enabled only after entering a comment with the specified length.

Settings the Comment Marker

In the above section, we set the minimum comment length and make the comment mandatory. But a user cannot know how much lenth the comment required to enter and for this purpose we can mark the width of the comment.

Take the add properties editor and select the property tsvn:logwidthmarker as shown and set the value same as the log width.

Commit your changes to the repository. Now in all the commit operation in the directory, the commit dialog will mark the width as shown below.

Integrate with Bug Tracking System

It is very common in Software Development for changes to be related to a specific bug or issue ID. Users of bug tracking systems (issue trackers) would like to associate the changes they make in Subversion with a specific ID in their issue tracker. This type of associativity is mainly required in the case of code file, in which for each bug fix, we can commit the URL of the bug system also to the subversion.

TortoiseSVN can help the user in two ways:

1. When the user enters a log message, a well defined line including the issue number associated with the commit can be added automatically. This reduces the risk that the user enters the issue number in a way the bug tracking tools can't parse correctly.
2. When the user browses the log messages, TortoiseSVN creates a link out of each bug ID in the log message which fires up the browser to the issue mentioned.

For integrating TortoiseSVN with bug tracking system, do the following.

Identify the URL

Normally a URL for a bug tracking system has an id part. For example consider the URL http://tortoisesvn.tigris.org/issues/show_bug.cgi?id=12534

Here we can change the id to a TortoiseSVN internal variable %BUGID%. So the final URL takes the form

http://tortoisesvn.tigris.org/issues/show_bug.cgi?id=%BUGID%.

Apply the URL

For applying the URL to the subversion working folder, rightclick on a particular working folder, select properties and invoke property add dialog.

Select the bugtraq:url property and enter the above preapared URL as value of the property. Click on [OK] and again add another property bugtraq:message and set the same URL as value and click on [OK].

Now the property list dialog should be looking as shown below.

Commit your changes to repository and your integration with bugtracking system is almost completed.

Integartion in action

For each commit operation in subversion, you will get the commit dialog box with a bug-id/Issue-Nr edit box as shown below.

If you have an issue id for the commit, then enter the bug id only in the edit box (else keep it blank) and enter the comments in the message and press [OK].

If you put an issue id say 12324 and comment say This is a bug message., and while taking TortoiseSVN Show Log, the dialog will be displayed as shown below. On clicking the link in the description, it will automatically open the bug tracking system and direct to the mentioned bug. If you did not put any id, then there should not be any URL in the description.

Changing the bug number label

For changing the label of the bug-id/Issue-Nr edit box in the Commit dialog, select the property bugtraq:label and enter the display text and commit your changes to repository.

The resulting dialog should look like shown below.

For displaying a warning message box for the blank bug id input (by default no message), you can set the property bugtraq:warnifnoissue to yes as shown below.

Now it will show a message as shown below on committing your changes.

Conclusion

This article will give a basic idea about the usage of Subversion with the help of a subversion client tool named TortoiseSVN. For getting a detailed idea about TortoiseSVN and all its features and settings, refer the TortoiseSVN user manual. For finding the TortoiseSVN FAQ, visit http://tortoisesvn.net/faq.

About Author

You must Sign In to use this message board.

FAQ  Noise Tolerance Very HighHighMediumLowVery Low  Search Messages    Layout Expand All MessagesThread ViewNo Javascript (slow)No Javascript Preview    Per page 102550

Msgs 1 to 15 of 15 (Total in Forum: 15) (Refresh) FirstPrevNext

customize option amirjamili@hotmail.com 1:45 28 Nov '08   hi, can i disable/remove delete option in TortoiseSVN? no one can remove any file.... without admin permission. Regards, Amir Jamili Sign In·View Thread·PermaLink Good Work! Jijo raj 3:54 26 Aug '08   Excellent writeup dude! Indeed, TortoiseSVN is a excellent version control system. For past 5 years i was using the SourceSafe and for last 6 months i've switched to SVN. Its far far better! Well, keep writing and my 5 votes for you. Well, you could write a second part of the article about branching and merging. It will be so useful. Regards, Jijo. _____________________________________________________ http://weseetips.com[^] Visual C++ tips and tricks. Updated daily. Sign In·View Thread·PermaLink Re: Good Work! Prathapachandran.v 19:11 26 Aug '08   Thanks. Sign In·View Thread·PermaLink Good article N a v a n e e t h 8:07 28 Jun '08   Hello, This is a good article. My 5 for you. I need to use Tortoise SVN but I don't have a SVN server. So I planned to setup SVN repositories on the local machine of all developers (there won't be many, maximum 2). Each day we will merge the changes, is this looking good ? Or any other aleternatives ? All C# applications should call Application.Quit(); in the beginning to avoid any .NET problems.- Unclyclopedia How to use google | Ask smart questions Sign In·View Thread·PermaLink Re: Good article Prathapachandran.v 19:35 29 Jun '08   By using a version management system, we have several advantages. One of the main advantage is we can save a lot of effort. Setting svn repositories in all developer machine is a bad practice and it will not give you the benifits of a version management system. If you are not interested to setup an svn server, you can simply share the folder in any one machine and can access all the users using file:///\MachineName/RepositoryName. So you can avoid the merging. Please note that setting up a subversion server is very easy. Sign In·View Thread·PermaLink Problem With "Get lock" zinki 8:53 10 Jun '08   Hi Am using tortoisesvn.I have set getlock to a file,but stil the other user can edit the file,but cant commit.please help thanks zinki Sign In·View Thread·PermaLink Re: Problem With "Get lock" pmorelfourrier 5:17 19 Jun '08   You have to set "svn:needs-lockPropery" attribute on the repository files, so other users won't be able to modify the file you are modifying. The article explains how to do that. Otherwise, anyone can modify anything anytime! Sign In·View Thread·PermaLink Error with TortoiseSVN1.4.8 Julie Boby 2:50 14 Apr '08   When i do a commit/Add (most operations) I get a "No error occured" error message. Can you throw some light on this TIA Sign In·View Thread·PermaLink svn plugin for vs2005 ? norbert_barbosa 2:32 3 Oct '07   Nice and complete article. Tortoise is very nice, but a SVN plugin for vs2005 should be cool too, to automatically manage refactoring (file rename and change location). Lot of them exist for java IDE (eclipse, Idea) Do you know if something like this exist for vs2005 ? Sign In·View Thread·PermaLink Re: svn plugin for vs2005 ? Prathapachandran.v 4:27 3 Oct '07   Yes. It is available. I am using one called AnkhSVN and you can be download it from http://ankhsvn.tigris.org/servlets/ProjectDocumentList?folderID=7315 Regards, Prathap Sign In·View Thread·PermaLink Re: svn plugin for vs2005 ? Sir Kot 4:55 10 Oct '07   http://pushok.com/soft_short_info.php PushOK Software has developed plugin to control CVS and SVN from any software, that uses SCC interface . (I've seen some other products that allows version control using the SCC, that is usualy a SourceSafe) Sign In·View Thread·PermaLink Re: svn plugin for vs2005 ? Patje 4:22 27 Jun '08   VisualSVN ()[^] Enjoy life, this is not a rehearsal !!! Sign In·View Thread·PermaLink Re: svn plugin for vs2005 ? Snakefoot 10:35 11 Jul '08   Integrates Subversion into VS2005 using External Tools (Even works with VS2005 Express): Visual Studio 2005 and TortoiseSVN Subversion Integration Sign In·View Thread·PermaLink download link SteveKing 20:40 2 Oct '07   Please don't link to some random mirror server nobody's heard about. Link to the official website! http://tortoisesvn.net/downloads[^] Only get your installer files from there! And please, if you link to some mirror, at least make sure it contains the latest version and not a really, really old one. Sign In·View Thread·PermaLink 5.00/5 (1 vote) Re: download link Prathapachandran.v 23:27 2 Oct '07   Dear SteveKing, Thanks for the comments. I have corrected it. Regards, Prathap Sign In·View Thread·PermaLink

Last Visit: Monday, December 1, 2008 8:02 PM     Last Update:Monday, December 1, 2008 8:02 PM