Surround SCM supports integration with KDevelop. See Surround SCM Third-Party Integrations for supported versions.

This article includes information about installing the KDevelop plug-in, adding Surround SCM tool views, associating projects with Surround SCM, configuring plug-in settings, performing Surround SCM actions, and troubleshooting.

Installing the plug-in

The KDevelop plug-in is automatically installed during the Surround SCM Client installation if KDE is installed. If the plug-in is not installed, install KDE and then rerun the Surround SCM Client installer.

Adding Surround SCM tool views

The plug-in adds the following tool views to KDevelop.

• Surround SCM Messages—Displays warnings or errors that occur when using the integration.


• Surround SCM Changes—Displays a tree of project items with the source control status. To add this tool view, choose Window > Add Tool View, select Surround SCM Changes, and click OK.

Associating projects with Surround SCM

Before you use the integration, Surround SCM needs to be set as the source control provider for project files.

• If you are adding a new project, you can associate it with Surround SCM when you create the project from a template.


• If you want to work with a project under source control but have not yet retrieved the files, fetch the project from Surround SCM.


• If you already retrieved project files from Surround SCM, choose Project > Open/Import Project in KDevelop and select the project file in your local working directory. Surround SCM is automatically set as the source control provider.

Creating new projects from templates

1. Choose Project > New From Template. The Create New Project dialog box opens.
2. Select a Project Template, enter an Application Name, and set the project working directory Location. You must use an empty directory.
   
   
   
   
3. Click Next.
4. Set the Version Control System to Surround SCM and click Finish.
   
   
   
   Note: You may be prompted to enter additional information depending on the project type you selected.
   
   
5. In the Projects tool view, right-click the new project and choose Surround SCM > Connect.
6. Select a Server, enter your Username and Password, and click Connect. You are prompted to establish a Surround SCM association.
   
   Note: If you are not prompted, you must set up the association in Surround SCM. See Troubleshooting for information.
   
   
7. Click Fix. The Surround SCM Repository Browser opens.
8. Select the branch and repository to associate with the working directory and click OK.
   

After you add the project file to Surround SCM, the project is automatically associated with Surround SCM when other users retrieve the project file from Surround SCM and open it from a local working directory.

Fetching projects from Surround SCM

1. Choose Project > Fetch Project. The KDevelop Import Wizard starts.
2. Select Surround SCM as the source and enter the local directory path you want to retrieve the project to as the Working Directory. You must use an empty directory.
   
   
   
   
3. Click Get. You are prompted to connect to Surround SCM.
4. Enter your Surround SCM login credentials and click Connect. You are prompted to establish a Surround SCM association.
5. Click Fix. The Surround SCM Repository Browser opens.
6. Select the branch and repository to associate with the working directory and click OK. The Get dialog box opens.
7. Select the files to retrieve, select any other options, and click OK.
8. Click Next in the wizard.
9. Locate the project file or build system you want to import or click Next to create a new project.
   
   
   
   
10. Click Finish. If you are prompted to override an existing project configuration, click Open Existing File.
    Note: You may be prompted to enter additional information depending on the project type you selected.

Configuring plug-in settings

1. Choose Settings > Configure KDevelop and select Surround SCM.
   
   
   
   
2. Select Log me in to Surround SCM projects when I load them to automatically connect to Surround SCM when you open projects.
3. Select Check out files when I start editing them to automatically check out read-only files when you edit them.
4. Select an option to prevent dialog boxes from opening when checking in and out files. If you select these options, the default Surround SCM Check In Files and Check Out Files dialog settings are used.
   Note: Do not select these options if you use changelists.
5. Click OK to save the changes.

Performing Surround SCM actions

Select a file in the Projects or Surround SCM Changes tool view and choose an action from the Surround SCM menu. The following commands are available:  Add, Get, Check Out, Undo Check Out, Check In, Rename, and Remove. You can also access changelists, view file and repository differences, history, and properties, start the Surround SCM Client, and disconnect from Surround SCM from this menu.

When you edit a read-only file, it is automatically checked out from Surround SCM. As you work with files and save changes, the Surround SCM Changes tool view is updated with the file status. The following icons indicate the file status.

• Green checkmark—File is checked out by you.


• Red checkmark—File is checked out by another user.


• Multiple checkmarks—File is checked out by multiple users.


• Red outlined file—File is checked out exclusively.

Troubleshooting

Document not saved when using the CMake Project Manager

If you use the CMake Project Manager, an error may occur if the CMakeLists.txt document could not be saved when you add a folder to the build system. This error occurs because the file is read-only. To make the file writable, check out or get the file before adding the folder, and make sure you select the Make files writable option.

Surround SCM association not established when creating a project from a template

Some project templates do not save source control provider information to the project file. If you are not prompted to establish a Surround SCM association after creating a project from a template, you must manually establish the association in the Surround SCM Client.

1. In Surround SCM, select the branch and repository to associate with the local project directory.
2. Choose Repository > Set Working Directory.
3. Select the local project directory as the working directory and click OK.
4. Restart KDevelop. Surround SCM is set as the source control provider for the project.

Buttons to view and edit TestTrack items are not available

The installed TestTrack integration library version is not loaded. You can only attach files to TestTrack items and view TestTrack Pro issues.