In this section:
General Source Control Settings
scontrol.timeout
This setting specifies the timeout value for operations with source control.
Acceptable Values
| [secods] | The timeout for operations with your source control system. The default value is 60. |
|---|
scontrol.branch
This setting specifies a custom name for the tested branch to be output by the ${scontrol_branch} variable (see Using Variables). It can be used to describe unique analysis runs. If not specified, the tested branch is detected automatically based on code provided for analysis.
Acceptable Values
| [name] | The name of the tested branch. |
|---|
Example Usage
In the following example, the custom branch name is "fix-pr8734":
scontrol.branch=fix-pr8734
As a result, the default session tag displayed on the report is as follows (assuming that the analysis is performed on a 64-bit Windows):
fix-pr8734-win32_x86_64
Git Source Control Settings
If you are going to report authorship information from Git to DTP, the cloned repository should not be shallow. A Git repository is considered shallow if the file .git/shallow exists. Git may not accurately produce authorship data when checking out shallow clones from a repository. You should check out full clones to retrieve accurate authorship information.
scontrol.rep{n}.type
This setting specifies that the repository type is Git.
Acceptable Values
| git | The Git repository identifier. |
|---|
scontrol.git.exec
This setting specifies the path to git executable. If not set, assumes git command is on the PATH.
Acceptable Values
| [path] | The path to the git executable. |
|---|
Use double backslashes to specify the file path on Windows.
scontrol.rep{n}.git.url
This setting specifies the remote repository URL.
Acceptable Values
| [URL] | The URL to the remote repository. |
|---|
Example Usage
scontrol.rep1.git.url=git://hostname/repo.git
scontrol.rep{n}.git.workspace
This setting specifies the directory that contains the local git repository.
Acceptable Values
| [path] | The path to the directory with the local git repository. |
|---|
Use double backslashes to specify the file path on Windows.
Shallow Clones
A Git repository is considered shallow if the file .git/shallow exists. Git may not accurately produce authorship data when checking out shallow clones from a repository. You should check out full clones to retrieve accurate authorship information.
scontrol.rep{n}.git.branch
This setting specifies a custom name for the tested branch.
Acceptable Values
| [name] | The name of the tested branch |
|---|
Example Usage
scontrol.rep1.git.branch=myproject-release20170115
Mercurial Source Control Settings
scontrol.rep{n}.type
This setting specifies that the repository type is Mercurial.
Acceptable Values
| hg | The Mercurial repository identifier. |
|---|
scontrol.hg.exec
This setting specifies the path to the external client executable.
Acceptable Values
| [path] | The path to the external client executable (the default is hg). |
|---|
Use double backslashes to specify the file path on Windows.
scontrol.rep{n}.hg.url
This setting specifies the remote repository URL.
Acceptable Values
| [URL] | The URL to the remote repository. |
|---|
Example Usage
scontrol.rep1.hg.url=http://hostname/path
scontrol.rep{n}.hg.workspace
This setting specifies the directory that contains the local Mercurial repository.
Acceptable Values
| [path] | The path to the directory with the local Mercurial repository. |
|---|
Use double backslashes to specify the file path on Windows.
Perforce Source Control Settings
scontrol.rep{n}.type
This setting specifies that the repository type is Perforce.
Acceptable Values
| perforce | The Perforce repository identifier. |
|---|
scontrol.perforce.exec
This setting specifies the path to the external client executable.
Acceptable Values
| [path] | The path to the external client executable (the default is p4). |
|---|
Use double backslashes to specify the file path on Windows.
scontrol.rep{n}.perforce.host
This setting specifies the Perforce server host.
Acceptable Values
| [host_name] | The Perforce server host name. |
|---|
scontrol.rep{n}.perforce.port
This setting specifies Perforce server port.
Acceptable Values
| [port_number] | The Perforce server port number. The default port is 1666. |
|---|
scontrol.rep{n}.perforce.login
This setting specifies the Perforce user name.
Acceptable Values
| [user_name] | The Perforce user name. |
|---|
scontrol.rep{n}.perforce.password
This setting specifies user's password to Perforce (optional if the ticket is used for authentication).
Acceptable Values
| [password] | The password to the Perforce source control. |
|---|
scontrol.rep{n}.perforce.client
This setting specifies the client workspace name as specified in the P4CLIENT environment variable or its equivalents. The root directory for specified workspace should be configured correctly for the local machine.
Acceptable Values
| [client] | The client workspace name. |
|---|
Subversion Source Control Settings
scontrol.rep{n}.type
This setting specifies that the repository type is Subversion.
Acceptable Values
| svn | The Subversion repository identifier. |
|---|
scontrol.svn.exec
This setting specifies the path to an external client executable (svn).
Acceptable Values
| [path] | The path to the external client executable. |
|---|
Use double backslashes to specify the file path on Windows.
scontrol.rep{n}.svn.url
This setting specifies the protocol, server name, port and starting repository path.
The URL should not include the project name and a trailing slash (/) to ensure that DTP can properly process information about your files.
Acceptable Values
| [URL] | The URL. |
|---|
Example Usage
scontrol.rep1.svn.url=svn://buildmachine.foobar.com/home/svn
scontrol.rep{n}.svn.login
This setting specifies the Subversion user name.
Acceptable Values
| [user_name] | The Subversion user name. |
|---|
scontrol.rep{n}.svn.password
This setting specifies user's password to Subversion (not encoded).
Acceptable Values
| [password] | The password to the Subversion source control. |
|---|
scontrol.rep{n}.svn.branch
This setting specifies a custom name for the tested branch.
Acceptable Values
| [name] | The name of the tested branch |
|---|
Example Usage
scontrol.rep.svn.branch=myproject-release20170115
Microsoft Team Foundation Server Source Control Settings
scontrol.rep{n}.type
This setting specifies that the repository type is Team Foundation Server.
Acceptable Values
| tfs | The TFS repository identifier. |
|---|
scontrol.rep{n}.tfs.url
This setting specifies the URL to TFS repository.
Acceptable Values
| [URL] | The URL to the TFS repository. |
|---|
Example Usage
scontrol.rep{n}.tfs.url=http://localhost:8080/tfs
scontrol.rep{n}.tfs.login
This setting specifies the TFS username.
Ensure you provide the same username that you used to configure the TFS repository on your machine.
Acceptable Values
| [user_name] | The TFS username. |
|---|
scontrol.rep{n}.tfs.password
This setting specifies user's password to TFS .
Acceptable Values
| [password] | The password to the TFS source control. |
|---|
