Using SVN on Windows

Once you have configured SVN for Windows you can start developing VisIt immediately. This page demonstrates how to perform certain actions using TortoiseSVN for Windows.

Checking out the source code

Now that TortoiseSVN is installed and set up to use PuTTY for passwordless SSH access to portal-auth.nersc.gov, you can check out the VisIt source code. Make a new folder and open the folder using Windows explorer. Right click in the folder to open the context menu with the TortoiseSVN options. This time, click on the SVN Checkout ... menu option to open a window that lets you choose which SVN repository that you want to use.

Svncheckout.jpg

Now is when you enter the path to the VisIt SVN repository. You can also specify the level of the source tree that will be downloaded to your local computer. Since Windows development requires the /src directory for the source code and the /windowsbuild directory for Visual Studio project files. Downloading additional directories will cause substantially more data to be downloaded. You might want to checkout /src and /windowsbuild in two separate steps since downloading /test, /data, /docs, /third_party can download several hundreds of megabytes of additional files.

Checking out a Release Candidate branch

The process is the same as above with the following modification to the URL: change 'trunk' to 'branches' and add the Release Candidate version. You can also click the browse button to the right of the URL to look at branches available for checkout. Release candidate branch names combine the version with RC. For example, if you wanted to check out the release candidate for version 2.4 (assuming the release candidate has been created) then you would check out from the 2.4RC branch.

Svncheckoutrc2.jpg

Once you have checked out the VisIt source code, you are ready to build VisIt.

Checking out the anonymous SVN version of VisIt

Checking out VisIt's source code from NERSC requires that you have an account and ssh access. However, a read-only mirror of the VisIt SVN repository as also available so you can checkout anonymously over http. If you want to check out the sources from the mirror, simply check out from http://portal.nersc.gov/svn/visit/trunk instead of the svn+ssh svn repository at NERSC. You will still need to check out the src and windowsbuild directories as when building from the regular svn repository.

Pitfalls

If at any point, Tortoise SVN experiences an error and cannot complete the checkout of the source code, you can still continue. Checkouts sometimes fail when a partial set of files has been downloaded from the SVN repository. In that case, you may have a directory that does not contain all of its files. To recover from this error and continue your checkout without having to start from scratch, remove the partial directory and do choose "SVN update" from the Tortoise SVN shell menu. Tortoise SVN will continue checking out the rest of the source files.

Editing a file

As with other SVN environments, there is no special command required to edit files. Since TortoiseSVN is a Windows shell extension, files that have been checked out into the working copy have special SVN properties. These properties can be accessed by right clicking on a file or directory and opening the Properties panel for the file. Properties are used to store metadata such as SVN revision and author for source code files.

The right-click context menu also provides various SVN options for performing commits, updates, diffs, and a host of other operations.

Svnmenu.jpg

Committing a file

To commit a file or all of the files in a directory, right-click on the file or directory and choose the SVN commit option. Files or directories with local differences show up has having a red exclamation icon instead of the default subversion green check box icon. Once you commit a file, its icon will revert back to the default subversion green check box icon.

Svncommit.jpg

TortoiseSVN will open an editor that allows you to enter your checkin comment and then a file progress window will open to show files upload to the VisIt repository.

Commitresults.jpg