Visual Studio Integration for the Alternative Surround SCM Plug-in Option Seapine Software Knowledgebase

Customer Support

Search the Knowledgebase	Browse by Category
Advanced Search \| Home

Knowledgebase Home > Surround SCM > Integrations

Visual Studio Integration for the Alternative Surround SCM Plug-in Option

Last Updated
6th of July, 2010

Print this page

Email this page

Add to favorites

Export to PDF

This article includes information about the integration plug-ins, installing the integration package, selecting the plug-in, adding a solution to Surround SCM, performing Surround SCM actions, setting source control options, and troubleshooting.

About the plug-ins

Surround SCM provides two integration plug-ins for Visual Studio:

Surround SCM Integration Provider plug-in—This plug-in is built using the VSIP API, which allows Visual Studio to access most Surround functionality. If this plug-in is used, a Surround SCM menu is added to the Visual Studio menu bar. This plug-in is supported in Visual Studio 2005 and later. We recommend using this plug-in because you can access most Surround SCM functionality.
Surround SCM plug-in—This plug-in is built using the MSSCCI API, which allows Visual Studio to access a basic, limited set of Surround SCM functionality. This plug-in is supported for all supported Visual Studio versions and is the only option for Visual Studio 2003. You may also need to use this plug-in if other team members are using it or if your team uses Visual Studio integrations with other source control providers.

The following information explains how to use the Surround SCM plug-in. See Visual Studio Integration for information about the Surround SCM Integration Provider plug-in.

Installing the integration package

The Visual Studio integration package is installed during the Surround SCM Client installation. If you did not install it initially, rerun the installer.

Selecting the plug-in

In Visual Studio, choose Tools > Options. Select Plug-in Selection in the Source Control category and select Surround SCM.

Adding an existing solution to Surround SCM

The Visual Studio solution and project must be added to Surround SCM before you can access source control commands. When you put a solution under source control, you are prompted to automatically add all projects and files. To add the solution to Surround SCM:

Open the solution and choose File > Source Control > Add Solution to Source Control. You are prompted to establish the Surround SCM association. Surround SCM cannot establish an association because the solution has not been added to Surround SCM and the directory where the solution resides is not set as a working directory in Surround SCM.
Click Fix to create a repository for the project. The Surround SCM Repository Browser opens.
Select the branch and repository you want to create the new repository in and click Create Repository. Surround SCM creates a single repository if the solution and the project files are in the same directory. If they are in different directories, a repository is created for each directory.
Click OK to close the repository browser.

Performing Surround SCM actions

Select the files to work with in the Solution Explorer, choose File > Source Control, and then choose an action.

Getting files
Get files when you want to view a file but do not need to make any changes. You can automatically get the latest version of files or manually select the files to get in a dialog box.

To automatically get the latest version of files:

Select the files you want to get in the Solution Explorer.
Choose File > Source Control > Get Latest Version. The latest version of the selected solution and project files are retrieved to the working directory.

To manually select the files to get:

Select the files you want to get in the Solution Explorer.
Choose File > Source Control > Get. The Get dialog box opens.
To get a file, select the corresponding check box. Clear the check box if you do not want to get the file.
Click Options to select any additional options.
Click OK. The selected files are retrieved to the working directory.

Checking out files
Check out files when you need to make changes to them.

Select the files you want to check out.
Choose File > Source Control > Check Out. The Check Out dialog box opens.
Click Options to select any additional options.

Note: The Recursive option is not available because it does not apply to check outs from Visual Studio.
Click Check Out. The files are checked out.

Undoing check out
If you check out and modify a file and then decide you do not want to save the changes, you can undo the check out. This discards any changes made to the file and checks it back in to the server.

Select the file you want to undo the check out for.
Choose File > Source Control > Undo Check Out. The Undo Check Out dialog box opens.
Click Options to select any additional options.
Click Undo Check Out. The files are no longer checked out.

Checking in files
Check in updates the file with changes and makes it available to other users.

Select the files you want to check in.
Choose File > Source Control > Check In.
Click Options to select any additional options.

Note: The Recursive option is not available because it does not apply to check outs or check ins from Visual Studio.
Optionally enter any comments.
Click Check In. The files are checked in.

Refreshing file status
You can query the Surround SCM Server to get the latest status of each file. For example, if you check out a file from the Surround SCM Client, it is not displayed as checked out in Visual Studio until you refresh the file status.

Select the files you want to refresh in the Solution Explorer.
Choose File > Source Control > Refresh Status.

Comparing file versions
You can compare the local copy of a file with the latest revision in Surround SCM.

Select the file you want to compare in the Solution Explorer.
Choose File > Source Control > Compare Versions. The differences utility starts if there are differences between the file versions.

Viewing file history
You can view a source file's history and work with historical file versions.

Select a file in the Solution Explorer.
Choose File > Source Control > View History.

Viewing file properties
You can view Surround SCM file properties to view general, check out, and other file information.

Select a file in the Solution Explorer.
Choose File > Source Control > Surround SCM Properties.

Excluding files from source control
Files excluded from source control can no longer be checked out or in.

Select a file in the Solution Explorer.
Choose File > Source Control > Exclude from Source Control.

Note: Click Advanced if you want to destroy the file and remove it from Surround SCM.

Opening a project from source control

Choose File > Source Control > Open from Source Control. The Surround SCM Repository Browser opens.
Select the branch and repository that contain the project or solution you want to open.
Click OK.

Adding a project from source control
You can open a project and add it to the solution.

Choose File > Source Control > Add Project from Source Control. The Surround SCM Repository Browser opens.
Select the branch and repository that contain the project you want to add.
Click OK.

Changing the branch and repository associated with a solution or project

To change the branch and repository associated with a solution or project, you need to remove the source control association and then select the new branch and repository.

Choose File > Source Control > Change Source Control.
Click Unbind to remove the solution or project from source control.
Click Bind to associate the solution or project with a new branch and repository. Select the branch and repository and click OK.

Refer to the Visual Studio documentation for more information about managing source control connections and bindings.

Setting source control options

You can configure several source control options, such as default check in options. In Visual Studio, choose Tools > Options and then select the Source Control category. Refer to the Visual Studio documentation for more information.

Troubleshooting

See the Visual Studio Integration knowledgebase article for troubleshooting information.

Attachments

No attachments were found.