How do I use Subversion (SVN) and TortoiseSVN for source code controlling LabVIEW projects?
Primary Software Version:
Primary Software Fixed Version:
I would like to use Subversion to provide source code control. What is the best way to get started?
The most common way to get started with Subversion is to use the TortoiseSVN interface. TortoiseSVN integrates with the Windows file explorer, allowing you to use the file explorer to manage projects under version control. This article will explain how to set up a repository, add a LabVIEW project to it, commit changes, and revert to old revisions.
You will first need to install TortoiseSVN. You can obtain it for free here
. Creating a repository:
This will create a special folder where all revisions of your project files will be stored. In production environments, the repository is usually stored on a server, and development work can be done on multiple clients.
Adding a project to the repository:
- Open up the Windows file explorer and create a new, blank folder.
- Right click within the new folder and click on TortoiseSVN»Create repository here...
- Click OK when prompted. This folder will now contain all of the revisions of your project. It is important to never modify any file within this folder, and it is a good idea to keep regular backups of the repository.
This step will select files to be added to the repository. This will not actually copy them into the repository, that will be done in the next step.
Committing changes to the repository:
- Create a blank folder. Right click and select SVN Checkout...
- Type in the path of the repository you created in the form of "file:///c:/your-repository" without the quotes. This will check out the blank repository into the folder you just created.
- Copy your LabVIEW project files (including your VIs) into the new folder.
- Right click within the folder (but not on a file) and select TortoiseSVN»Add...
- The project files have been selected to be added to the repository, but the change has not yet been committed. If you add new files later, you can use this same method to add them to the existing repository.
A commit will enter your changes into the repository. Changes will only be entered into the repository when you commit, this includes adding and deleting files.
Changing to a different revision in the repository:
- Right click within the folder and select SVN Commit...
- Enter notes in the Message section to describe the changes that are being checked in. You can also select which modified files should be committed.
- Click OK when ready.
This procedure will allow you to view and modify older revisions of your project, allowing you to backtrack if needed.
Updating to the most recent revision:
- Right click on a file to change or within the folder to change all files and select TortoiseSVN»Update to revision...
- Select the desired revision and click OK.
This is the quickest way to return to the most recent revision of the repository.
- Right click within the folder and select SVN Update. This will update all files to the latest revision.
.svn folder causes Mass Compile issues:
TortoiseSVN creates .svn folders under each source code controlled folder. The .svn folder stores unchanged versions of the files in the format Name.xyz.svn-base. (Example: Help.vi will be stored as Help.vi.svn-base). Mass compiling a folder under TortoiseSVN source code control results in LabVIEW mass compiling the files present in the hidden .svn folder too. Check the following link for more information on how to get around this limitation.
Note: This issue has been resolved in LabVIEW 2009. Use the following configuration token skipSVNFolders=true, in the labview.ini file, which can be located in the LabVIEW directory.
See the related links for more information on Subversion and TortoiseSVN.
Related Links: SubversionTortoiseSVNRemoving .svn folders from a working copy with TortoiseSVN