Options Dialog—Source Control Tab

The options you see on this tab depend on whether your project is already bound to source control.

Not all options are applicable to each of Flare's integrated source control providers. If you select an option that is not applicable to the provider you are using, this option is ignored. For example, Git does not use lock functionality, so if you select this option it will be ignored.

Additionally, terminology varies for each source control provider. You may see slightly different dialogs or prompts depending on which source control provider you are using.

Option

Description

Automatically check file out from source control when saving file changes

Select this check box to automatically check the file out from source control when you save changes to it. See Checking Out Source Control Files.

Lock files when automatically checking out

You can select this check box if you are using Microsoft Team Foundation Server, Apache Subversion, or Perforce Helix Core and want files that are automatically checked out to be locked as well. Locking files means that other users cannot check those same files in when you have them checked out. You might use this feature to prevent conflicting changes from occurring and having to merge files as a result. See Checking Out Source Control Files.

Note Subversion will automatically lock a modified file when saving changes (if it is not already locked) if you selected the option to automatically check out files from source control when saving them. Because there is not a "checked out" status for Subversion files, these files will be marked as modified Source Control Checked Out icon and can be committed. See Options Dialog.

Show prompt to add auto-created files to source control

Select this if files were automatically added to your project and you want to be prompted to add those files to source control. For example, this might occur if you drag a word file to Content Explorer. Multiple files might be automatically created when you do this.

Enable background status checks

Select this check box if you are using source control integration in Flare and you want the application to check for frequent status changes automatically. You can specify the number of minutes and seconds when you want Flare to ping the source control repository and get status changes for files that have been checked out, checked in, moved, deleted, etc. The upside of this feature is that you can ensure that the source control status information is always up to date. The downside is that you may experience slower performance due to this constant communication over the network. See Enabling Source Control Status Checks.

Do not prompt to get latest when opening source control bound projects

When you open a project that is bound to source control, a message automatically asks if you want to get the latest version of files. Select this check box if you want to disable this prompt. Therefore, in the future when you open the project you will no longer see the message, and the project will open without replacing any local files with the latest ones from source control. See Disabling the Get Latest Prompt.

Prompt to check in files when closing source control bound projects

Select this if you want to automatically be reminded to check in files when you close a project that is bound to source control.

Enforce TFS comment policy

By default, Flare ignores all Microsoft Team Foundation Server check-in policies. However, if your source control administrator requires a comment when you check in a file, you can select this option to force Flare to abide by this policy.

Note Selecting this option only enforces the TFS comment policy. It will not check for other policies.

Bind Detection

Bind Detection

Bind detection scans your project when you load it to see if the project has been previously bound to source control. If a binding is detected, you then have the option of applying the binding and committing the project to source control. Depending on the provider you are using, Flare may search the file system and its artifacts, as well as contact and query servers, to find potential source control bindings.

For more details, see the following:

Use Git executable for network functions

Get Git for Windows

Get an updated version of Git for Windows

Use this section to integrate Git for Windows (Git.exe) if your project is bound to Git (not a Central binding though) via Secure Shell (SSH). This might be necessary to avoid errors. However, an upside to installing Git.exe is that it is likely to result in faster and better performance for file transfers. See Using Git for Windows.

MadCap Central Transfer Protocol

If you plan to bind a Flare project to a MadCap Central license, you must use the HTTPS transfer protocol. This field also shows the SSH protocol, but this protocol is actually no longer available for Central connections due to security issues. Selecting SSH here will no longer cause Flare to use SSH for Central bindings.