Changing Low Level Properties in SmartGit

In addition to the options available in the SmartGit Preferences, additional customization options are accessible through the SmartGit Properties file (smartgit.properties). This article describes these additional properties.

Most low-level properties below can be edited directly in the Edit | Preferences settings dialog under the Low-Level Properties section. Changing these values updates the smartgit.properties file, which is located in SmartGit’s Settings Directory.

In rare instances, you may need to edit the smartgit.properties file directly.

Warning

  • Changing settings in smartgit.properties with an invalid value can cause issues with the normal operation of SmartGit. It is strongly recommended that a backup copy of the smartgit.properties file be made before making direct changes.
  • You can reset a setting by selecting it and clicking the Reset command in the context menu.
  • As a last resort, you can delete or rename the smartgit.properties file to reset all settings to the installation defaults.
  • After editing the smartgit.properties file directly, you will need to restart SmartGit for the changes to take effect.

Each setting in smartgit.properties must be specified on a separate line using the following syntax:

key=value

If a line starts with#, the entire line is treated as a comment and ignored by SmartGit.

The file encoding is UTF-8.

Note

  • The smartgit.properties file contains only SmartGit-specific settings. To configure the underlying behavior of Git, use Edit | Preferences | Git Config to change common git.config settings. Alternatively, you can edit Git configuration files, such as .git/config (for individual Git repository settings) and ~\.gitconfig (in your HOME directory for global configuration options).

Changes View

changes.maximumFileSize

File comparison can be disabled for very large files, for performance reasons. Use this setting to adjust the size (in bytes) at which a file is considered too large for the Changes View. The default value is approximately 1 MB.

Note

It is recommended to keep this setting at a reasonable level (a few MB), as setting it too high could negatively impact the performance of the user interface.

Networking

java.net.preferIPv4Stack

By default, SmartGit prefers to connect via IPv4. To instead connect via IPv6, set this option to false.

http.nonProxyHosts

Use these properties to specify servers to connect directly to, bypassing the configured proxy, for example: *.foo.com|localhost. Note: This only affects the behavior of SmartGit. Any git usage outside of SmartGit will not use the http.nonProxyHosts.

Company-wide configuration

smartgit.setupFinishedUrl

This setting specifies the URL to open after SmartGit has been started for the first time and the setup wizard was completed.

smartgit.preferences.<category>.visible

You can use this low-level property to hide certain Preferences pages. Available categories are:

  • executables
  • externalTools
  • compareTools
  • conflictSolver
  • spellCheck
  • proxy
  • updateCheck
  • bugReports

To hide a specific page, set the corresponding property to false.

Example

To hide the Tools page, set:

smartgit.preferences.externalTools.visible=false

smartgit.contactSupportEnabled

Set this option to false to hide the menu item Help | Contact Support.

smartgit.registerEnabled

Set this option to false to hide the menu item Help | Register.

Update Check

smartgit.updateCheck.enabled

Set to false to disable the automatic checking and disallow the manual checking for new program versions by hiding the corresponding menu items Help | Check for New Version and Help | Check for Latest Build. You should only turn this check off for network installations where SmartGit users may not be able to perform the update themselves. When settings this option, you will probably also want to hide the corresponding page from the Preferences, using smartgit.preferences.updateCheck.visible.

Note that this will also disable notifications of new bugfix releases which you can upgrade to for free and which improve the stability or reliability of SmartGit.

If you just want to switch off automatic checking, use smartgit.updateCheck.automatic=false instead.

smartgit.updateCheck.automatic

Set to false to disable the automatic check for new versions on a global level which can be convenient e.g. for network installations. To disable the check for an individual installation/user, better do that in the Preferences, section SmartGit Updates.

smartgit.updateCheck.alwaysUpgradeToLatestBuild

Set to true to make SmartGit check for the availability of a new latest build on start up. Latest Builds are the “bleeding edge” builds between subsequent (minor) release builds, like between version 8.0.1 and 8.0.2 or 8.1 preview 3 and 8.1 preview 4. They will contain the latest improvements and bugfixes. Usually we will ask you to manually fetch the latest build using Help | Check for Latest Builds.

smartgit.updateCheck.checkForLatestBuildVisible

Set to false to hide Help | Check for Latest Build.

smartgit.installation.update.workingArea

Use this property to customize the program updater’s temporary directory, which is by default located in your home directory/profile. This should only be necessary if updating is not possible due to (file system) restrictions in this default directory, e.g. if execution of files is prevented by the system. On Windows, paths have to be specified using forward-slashes, like c:/temp.

Bug Reporting

smartgit.disableBugReporting

Set to true to disable sending of crash footprints (even if configured in the Preferences) and skip the option to send bug reports to us. When setting this option, you will probably also want to hide the corresponding page from the Preferences, see smartgit.preferences.bugReports.visible.

Warning

When using this option, be sure to provide an alternative way for your users to report SmartGit bugs to you, otherwise they will go unnoticed.

smartgit.license.defaultPath

By default, SmartGit will look for a “default” license file in the installation default directory. You can use this low-level property to specify a different file system path for the default license to look for.

Example

To have SmartGit take the default license from \\license-server\smartgit\license, set: smartgit.license.defaultPath=\\\\license-server\\smartgit\\license

smartgit.license.alwaysCheckForNewerDefaultLicense

By default, SmartGit will only look for a default license, if there is no or no valid existing license. Sometimes, it may be desirable to replace even valid licenses by newer default licenses. To do so, set:

Example

smartgit.license.alwaysCheckForNewerDefaultLicense=true

Debug Properties

logging.[category]

Use this property to enable debug logging for certain SmartGit modules; [category] has to be replaced by the appropriate module identifier.

Example

To enable debug logging for the Refreshing modules, set following properties:

logging.smartgit.refresh=DEBUG
logging.sc.vcs.model.refresh=DEBUG