Skip to end of metadata
Go to start of metadata

You are viewing an old version of this page. View the current version.

Compare with Current View Page History

« Previous Version 76 Next »

The vast majority of SmartGit's system properties can be configured by editing the file in the settings directory.


The file contains only settings for SmartGit itself. If you want to configure your Git repositories, have a look at the various Git configuration files instead, such as .git/config for the configuration of individual Git repositories, and ~\.gitconfig (in your HOME directory) for global configuration options.

First, open the settings directory. Its default location is described in Default Location of SmartGit's Settings Directory. In the settings directory, you will find the file. Open it with a text editor, such as Windows Notepad.

Each of the settings in is specified on a separate line, according to the following syntax: key=value. If a line starts with#, the entire line is treated as a comment and ignored by the program.

The following list shows the available system property keys:

Interaction with Git


By default, Git will search for user configuration files (primarily .gitconfig) in the directory specified by the $HOME environment variable.

Sometimes $HOME passed to SmartGit might not be identical to $HOME available from command line due to specific system configurations. To make SmartGit use the same configuration anyway, specify this property.

Sometimes $HOME might point to a network location which may result in performance problems. In this case, you should create a local HOME directory to use for SmartGit, replicate your .gitconfig into this directory and finally point SmartGit to this directory using smartgit.executable.home.


This specifies a different HOME-directory on Linux/Mac:


This specifies a different HOME-directory on Windows (make sure to use forward slashes):

smartgit.executable.home=c:/Documents and Settings/user/App Data/syntevo/SmartGit/home


By default, SmartGit will invoke Git with environment variable LANG=C set. Use this system property to change the language passed to Git, for example: smartgit.executable.language=en_EN.UTF-8. To skip the LANG environment variable, set smartgit.executable.language=.


This option roughly specifies the maximum Git object size (in MB) to be loaded directly into memory. This helps to avoid out-of-memory-errors, but on the other hand certain operations may become extremely slow. This value may be used to tune performance, but it should be chosen with care!


When merging, Git's verbose default messages are used. If you prefer shorter, easier readable messages (as default until SmartGit 5), set this value to true.


By default, SmartGit will push to all branches which have been declared by (multiple) remote.<name>.push declarations (like command line Git does). To make SmartGit stop after pushing to the first branch, set this option to true.


This option specifies the short SHA length, to be used by SmartGit (mainly for displaying). Valid values are in the range between 4 to 40.


By default, SmartGit will scan for outgoing commits. This may slow down the program for large repositories. To disable the scan, set the value to false.


Set to false to make the Refresh skip scanning submodule folders.


By default, SmartGit will check whether 'assume-unchanged' files are really unchanged or not. To disable this check, set the option to false.


Use this property to specify the amount of time (in milliseconds) between the internal model update and its presentation on the UI during a refresh (at the end of a refresh, there will always be a forced UI update anyway). Increasing the delay will make SmartGit look less responsive during refreshing, however will reduce refreshing time for the initial refresh when opening a repository and subsequent full refreshes.


If set to true, repository paths are stored relative to the SmartGit install location (useful for portable bundles).


The detection of renamed files is by default disabled for very large files. Use this option to adjust when a file is considered 'large'. The value should be given in bytes, like 1000000.


Specifies the minimum required score for two files being considered as renamed. The score value must be an integer between 0 and 100.


Following configuration specifies to detect only exact renames:



By default, SmartGit is rather conservative when updating submodules: for instance modified submodules won't be touched, even if the registered commit in the parent repository has changed. Sometimes it may be convenient to still 'update' these submodules, e.g. by merging local commits with the changed, registered commit. This is what 'git submodule update' will do, if key 'submodule.$name.update' is properly configured in .git/config of the parent repository. To invoke 'git submodule update' for modified submodules, set this value to true.


By default, SmartGit will not recursively initialize new submodules if And initialize new submodules option has been set, i.e submodules of new submodules won't be initialized. Set this system property to true, to recursively initialize submodules.

If you are encountering problems when cloning a local repository to/from a mapped network drive, it may be necessary to add '--no-hardlinks' for 'git clone'. To achieve that, set this option to true. Do not forget to reset the option, once you have cloned successfully.


If an SSH-URL does not contain 'user@', SmartGit will by default use the system user name to authenticate at the SSH server. Use this property to change to a custom default user name.


Use this option to configure additional other refs to be displayed in the Branches view; the default value is notes. To include e.g. archive-refs, set to notes;archive.


To exclude certain tags from being processed by SmartGit, specify a regular expression matching the corresponding tag names (not including refs/tags/). This can be useful if you have a large amount of auto-generated tags which may slow down various SmartGit operations, especially related to the Log.


To exclude all tags starting with the prefix autotag-, specify:



To exclude certain remote branches from being processed by SmartGit, specify a regular expression matching the corresponding remote branch names (not including refs/remotes/<remote>). For details, see smartgit.branch.tagExcludeRegEx.


If the ref count exceeds this limit a notification is shown about too much refs possibly causing performance problems.


Use this option to customize the commit message used by the Revert command: ${message} will be substituted by the commit's message, ${sha} will be substituted by the commit's SHA and \n will be substituted by a newline character.


To get the same commit message as set by command line Git, use:

							smartgit.revert.commitMessageTemplate=revert "${message}"\n\nThis reverts commit ${sha}.


Use this option to customize the default commit message used by the Finish Feature command. {0} will be substituted with the feature name.


smartgit.gitflow.finishFeature.message=Finished feature {0}.






SVN integration


Set to false to disable the possibility to clone SVN repositories.


Set to true to have SVN connection logging enabled. This will create a connection.log in SmartGit's settings directory which will be helpful for error diagnosis.


For certain SVN repositories, the .gitattributes file may become very large, which would slow down various (Smart)Git operations. For that reason, the mapping of svn:eol-style and svn:mime-type will be disabled if the size of the .gitattributes file exceeds the threshold specified by the specified value (in bytes). For more information, see To have the .gitattributes mapping always enabled, you may set the threshold to a large value.


Set to true to enable recursion into unchanged SVN submodules when a submodule update is performed. This may be useful if you always want to fetch the latest revisions from an SVN repository even if the svn:external which is mapped to .gitsvnextmodules does require fetching these revisions.


Set to false to prevent glueing of multiple revisions together when performing an SVN clone. Glueing revisions together improves performance and usually has no negative side-effects. Sometimes, for large repositories, it may result in out-of-memory errors, though.


Set to true to scan (refresh) SVN sub-modules for non-SVN parent repositories.


Use this option to change the default SVN "commit message" when e.g. pushing a tag. There are a couple of variables, which will be replaced by proper strings: {Action}, {Actiond}, {action}, {actiond}, {target}, {source}, {sourceRevision}.


Some example definitions:

{Actiond} {target}{ from {source}{:{sourceRevision}}}
{target} {action} { from {source}{:{sourceRevision}}}

Interacting with Mercurial


Use this system property to change the maximum allowed Mercurial version SmartGit will be able to work with.

In case of Mercurial API changes, this might break SmartGit's Mercurial integration.

Background: SmartGit is accessing internal Mercurial API which may change for newer versions of Mercurial, for example when switching from version 3.7 to version 3.8 (this actually happened already multiple times in the past, breaking SmartGit's integration). Thus, SmartGit is limited to a certain version of Mercurial. We are updating this "dependency" with newer (major) SmartGit versions. If you want to use a very recent Mercurial version before SmartGit officially supports it, you may do so by changing this property. We always appreciate input on known working configurations and on problems with new Mecurial versions at


To allow SmartGit to work with any major Mercurial version (up to 99.9) , set following system property:




Set to false to disable the file monitor (which watches for file system changes).


On Linux, SmartGit will by default not monitor files which are located in ignored directories. Usually this does not cause any problems but improves Refreshing performance and reduces required inotify handles. Sometimes ignored directories are containing tracked files in which case changes to these files might not show up automatically. If this is the case for you, you should disable this optimization by setting this system property to false.


On Windows, set this option to false to disable file monitoring for folders that lie on removable drives.


On Windows, set this option to true to enable file monitoring for UNC paths. Depending on the network drive type, this may slow down file monitoring and/or may not work reliably.


This setting specifies the number of seconds to wait for a response from a hanging external process before suggesting to kill it. Among other things, this helps to avoid hanging Git processes when trying to access a repository.

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.


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


Use these properties to specify servers to connect directly to, bypassing the configured proxy, for example: *|localhost. Note, that only internal code of SmartGit is honoring http.nonProxyHosts. This does not include Git itself.


Set this property to false if you have configured your http(s) proxy in SmartGit for accessing URLs outside your network, but your https-authenticated repositories are located inside your network and should not be tunneled through your proxy.

smartgit.proxy.timeout.connect and

These two settings specify the timeout in milliseconds for connecting to and for reading from a proxy, respectively. Proxies may be used e.g. by "SmartGit Updates".

User Interface


By default Ctrl+I enters a tab character. SmartGit contains code to prevent this. To use the default behavior (disable SmartGit Ctrl+I code), set this option to true.


If an Author column is not wide enough to fully show the complete author's name, SmartGit tries to shorten it, e.g. "Thomas Singer" becomes "T. Singer" or even "TS". To avoid this, set this option to false.


By default the system browser is used on Windows and Mac. On Linux common browsers are tried to find. If you want to use a certain browser, you may set its path using this option.


Configures whether the confirmation buttons in a dialog should be right beside the aborting button. default: Windows = false, OS X = true, Linux = false (depends on the system configuration)


By default SmartGit tries to use the right scaling factor depending on the DPI setting of the operating system. On some systems (e.g. Linux), though, this does not work or needs tweaking. With this option you can set the dpiFactor to either 1 (= 100%) or 2 (200%)., smartgit.monospaceFont.size

SmartGit uses a fixed-width (monospace) font for displaying something, e.g. in the Outputdialog. You can use these options to change this font or its size.


The age of output messages that should be considered as too old, so they may be cleared automatically. Set to 0 to disable automatic clearing.


Set to true to show the path behind closed repositories in the Repositories view.


The Repositories view indicates favorite repositories with a trailing * behind the repository name. With this option you can define the used indicator, e.g. \u2605 for a filled 5-star, \u2606 for an outlined 5-star or \u2665 for a heart sign.


Clicking on a toolbar button with additional drop-down menu only should show the drop-down menu when clicking and holding the mouse button for a moment. A short click on any part of the button will invoke the button's default action.


Clicking on a drop-down menu toolbar button should show the drop-down menu immediately when clicking with the left mouse button. Otherwise the drop-down menu will only be displayed when releasing the mouse button or after a short moment (click and hold).


The symbol displayed as an indicator for the additional drop-down menu can be customized. Alternative suggestions: \u2304...v-like open arrow, \u25bc...filled downward triangle, \u25bd...empty downward triangle, \u25be...tiny filled downward triangle, \u25bf...tiny empty downward triangle

smartgit.branches.priority. <category>=<value>

The Branches view sorts groups in a certain order. By using these category constants you can set different values to change the order: plugin, flowFeatures, flowHotfixes, flowReleases, flowSupports, localBranches, remotes, tags, stashes, metaRefs, otherRefs, insignificantMerges, lostHeads.


The Branches view uses a unicode character to indicate the checked out branch. If you like to change that, set this property. To add a trailing line space, e.g., use the value "> ".


This is similar as for smartgit.branches.head, but for the current checked out Hg branch while a bookmark is checked out.


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


To hide the splash screen, set this option to false.


By default, times from today and yesterday are shown in a short form. To always show the date in the full form, set this option to false.


For times from the last 7 days, show the week day name. Set to false to disable that.


To show only the time (i.e. without "Today") for times from today, set this option to false.


The format pattern used for displaying the week day name. EEEE = fully, E = shortened


On Linux, the system tray is disabled by default due to problems with Unity desktops. To enable the system tray, set this option to true.


By default, for new Git repositories the "Update registered submodules" option is enabled. To disable by default, set this option to false.


By default, for new Git repositories the "And initialize new submodules" option is enabled. To disable by default, set this option to false.


Set this otpion to true to default the Pull dialog to the Fetch option.

smartgit.pull.defaultToRebase and smartgit.pull.defaultToRememberDefault

Set both options to true to have the Pull dialog always default to "Rebase" and remember this as default. This will be helpful to fix Merge vs. Rebase settings after upgrading to SmartGit 4.


In the Annotate window, if the mouse hovers over the yellow line detail column, a tooltip with additional information is shown. With this property you can specify a maximum width in pixels for this tooltip. The specified value must lie in the range [10; 1000]. If the value is not specified or out of range, the default value of 400 pixels is used.


In the Annotate window, commit messages are displayed in the combobox in the upper part of the window. This property limits the length of the displayed commit messages, i.e. all commit messages that are longer than this property's value will be truncated.


Defines whether the tree views throughout the program should use "full selection" style. "Full selection" means that when an item on a tree is selected, the selection box will fill the entire width of the tree, rather than only the item's width.


Defines whether tree or table views are allowed to use colors other than the system's default background and foreground color to display selected items. Depending on the current platform, the usage of additional colors is disabled by default to improve the readability of selected items.


The number of entries in the Outgoing view is limited for performance reasons. Use this option to change the limit.


Usually, secondary remotes which have "mirror" set to "true" in the .git/config are not interesting from the perspective of which commits are pushable and hence are ignored. Set this option to true to also have these remotes honored as well.


Set this option to false to let SmartGit adjust the author dates when rearranging commits.


"Reveal in File Manager" by default uses hard-coded, platform-specific file managers (Windows: Explorer, OS X: Finder, Linux: Nautilus). Depending on your file manager, you may use the placeholder ${filePath} or ${fileUri}.


When creating a new repository, e.g. by dropping a directory onto the Repositories view, SmartGit will use the directory name as name for the repository. This could lead to equally named repositories. When setting this option to true, SmartGit will append number suffixes to ensure that the new repository names don't collide with already existing ones.


You can use this system 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.


To hide the Tools page, set:


smartgit.forceActive, smartgit.forceActive.dialog and smartgit.forceActive.window

Set one of these options to true to forcibly make new windows or dialogs active. On some Linux systems some dialogs don't get activated automatically otherwise.


Set this option to false to disable simple markdown formatting for error dialogs.


When entering unsupported characters for a new branch or feature, they will be replaced automatically with '_'. To replace them with a different character, configure this option.


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


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


Set this option to true to allow running SmartGit with Java 9.


Set this option to false to skip the check for the Git config files containing a valid username and email configuration when invoking Commit.

Text editors / File Comparison

To disable the comparison of binary files set this option to true. This may be useful if you usually have large binary files in your repository. When read, these files may slow down certain views, e.g. the "Changes" view.

By default, the file comparison is disabled for very large files. Use this setting to adjust at what size (in bytes) a file is considered 'too large'.

By default, the file comparison treats files with very long lines as binary files for performance reasons. Use this option to configure the maximum characters per line (default: 10000) which should be treated as text files. and

The file comparison algorithm consists of two phases. In the first phase, changed lines are detected, and in the second phase, the algorithm will search for changes within corresponding lines. The second phase becomes slower if there are too many long lines, so it is skipped when that happens. These settings allow you to adjust the detection of long lines: The second phase is skipped if the two files contain more than 'maximumLongLineCount' lines that are longer than 'maximumLineLength' characters in length.\u2B70, smartgit.styledtext.lineEnding.crlf=\u2B70\u2936, smartgit.styledtext.lineEnding.lf=\u2936

These texts are used to draw old Mac OS, Windows or Unix line-endings in the file compare or other similar controls.


Set this option to false to switch syntax highlighting off permanently, regardless of Preferences settings.



Set to false to disable the detection of renamed files in the Log. In rare cases (large commits with many additions and removals and large files), rename detection may slow down the Log significantly.


Set to true line if you want to include all refs for the "On Branches" display in the Log Details view.


By default, the Log shows stashes. To change this, set to false.


Use this option to change the priorities of Git-Flow branch types in the Log. The priorities are affecting the order in which these branches will be displayed in the Log graph. The order is specified using a comma-separated list of following branch categories where every category must occur exactly once in the list: developfeaturerelease, masterhotfixsupport.


To layout in the inverse default order, specify:



This text is used when shortening a commit message to a single-line as replacement for line-ending.


The maximum length for a medium-sized commit message.


SmartGit uses a shortened commit message in various places, e.g. in the commit message column of the Log table. Shortening means the full commit message is cut off after the number of characters specified by this setting.


When shortening a commit message, stop at an empty line after non-empty lines.


By default, commit messages are UTF-8 encoded. To use the default encoding for your platform instead, set to true.


Set this system property to true if you are having performance- or memory-related problems when showing a File or Sub-Directory Log for a huge repository: by default, SmartGit will run the log for all branches and tags. This is necessary to e.g. properly assign branches/tags to the File or Sub-Directory commits. Also, by default, you will be able to toggle Log roots in the Branches view. When setting this option, SmartGit will only log the current HEAD commit and the Branches view will remain empty.


Set this system property to false to not stop logging a file once SmartGit has encountered an addition of the file. This will make SmartGit report additional commits for which a file with the same name has been changed. Note however, that these files are usually not related.


When setting this system property to true, you will get additional layouting actions in the context menu of the Log graph. Max. Connector Length specifies the maximum length a continuous connector may have; if the length would exceed this limit, SmartGit will use arrowsRectilinearity affects how straight connectors will be (degree of "bending"). Once you have a set of parameters which works fine for you, you can skip the system property again. The configuration is stored in the settings.xml configuration file and can be edited there directly, too.

System property "smartgit.log.branchPriorities" to specify order of Git-Flow refs in Log


Git's cherry-pick command has an -x option that tells Git to automatically append a "cherry picked from commit ..." message to the created commits, in order to indicate where the latter came from. SmartGit does not do this by default, but you can enable it by setting this propery to cherry picked from commit.


To change the size of the avatar image, change this option.


If you want to use a different server than to provide the avatars shown in the log, you may configure it in the next line.

  • {0} will be replaced by the MD5-hash of the lowercase email
  • {1} will be replaced by the avatar size (see above){0}.jpg?s=256

This is the URL used to show when clicking on the gravatar in the Log's Details view.

  • {0} will be replaced by the MD5-hash of the lowercase email
  • {1} will be replaced by the avatar size (see above)


The colors of the graphical Log-elements can be configured using this property. Valid types are: tag, branchLocal, branchRemote, branchOther and headArrow. Valid components are red, green and blue. Valid values are 0..255. Example:


Following system properties can be used to customize the layout of the Journal view.


Use these system properties to increase (or lower) the maximum number of commits displayed per type. Be careful to not use unnecessarily large values because this may affect SmartGit's performance significantly.


To show up to 50 local commits use



Set this system property to true, to have SmartGit consider all remote branches (not just the tracked remote branch) when determining pushable vs. pushed commits. This will especially be useful to see already pushed commits for local branches which do not have a tracked branch.

Depending on the size of your repository and the number/age of your remote branches, using this system property may result in significant performance losses.

Background operations


When SmartGit is idle for a certain amount of time, it will start executing various background tasks. With this option you may set the number of seconds to wait until the 'idle' state is reached.


The delay/frequency in seconds for which SmartGit will poll (git ls-remote) remote repositories, if enabled in the Preferences, section Background Commands.


The delay/frequency in seconds for which SmartGit will fetch remote repositories, if enabled in the Preferences, section Background Commands.


The initial delay in seconds after application startup after which SmartGit will start fetching remote repositories, if enabled in the Preferences, section Background Commands. The purpose of this delay is to alleviate the application immediately after startup, where you will usually want to have processing power to be focused on opened repositories (refreshing status, populating Branches view and Journal).


A couple of background commands are working only on repositories which have been Marked as Favorite. If the amount of known repositories (listed in the Repositories view) is equal or below the threshold specified by this property, all repositories will be considered as favorite.


To disable automatic favorite repositories, use:



The maximum number of objects which are allowed before SmartGit will suggest to Clean Up the repository (i.e. run git gc). If you are frequently seeing the Clean up notification this may be caused by high activity in your local repository. To get rid of the notifications in this case, you may increase this system property. Note: you shouldn't set this value too high, otherwise the clean up won't be triggered anymore by SmartGit.

GitHub integration


The number of pull requests to fetch from GitHub is limited by "pages" (one page contains a couple of pull requests). The default page limit is 3.


The number of comments to fetch from GitHub is limited by "pages" (one page contains a couple of comments). The default page limit is 3.


The number of objects per page retrieved from the server (default: 100).

BitBucket integration


Set to true to force SmartGit to connect to repositories using HTTPS, instead of SSH.

JIRA integration


Set to false to disable optional resolving of JIRA issues on Push.


Specifies the name of the JIRA states which are considered as closed: SmartGit will only offer to resolve an issue, if the issue is not yet in a closed state and there is at least one transition available for the issue which puts into a closed state.


Default closed states are resolved,closed,done. To add an additional code complete state, change the property to:

smartgit.jira.closedStates=resolved,closed,done,code complete

Update Check


Set to false to disable the 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.


Set to true to force the check for new versions more often than the specified interval in the Preferences, section SmartGit Updates.


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.


Set to true 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=false instead.

Bug Reporting


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.

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.

License user/seat tracking

For licenses with a large number of users, it can be helpful to track the number of active SmartGit users over time. For this purpose, SmartGit can optionally access ("ping") a configurable URL which can be used to collect these user statistics on the server side. This requires customer-specific configuration because in different companies different means define a person (user), e.g. by a user-specific unique environment variable value. A simple implementation on the server-side would just be a virtual host logging to a separate access log file. The resulting log files can be analyzed, e.g. using grep.


Enables the license user tracking feature and specifies the URL (template) which SmartGit will connect to on startup and once per day. The template is basically a URL for which following keywords will be replaced:

  • ${email} will be replaced by the user's email found in the ~/.gitconfig file.
  • ${smartgit.version} will be replaced by SmartGit's version followed by a # and the build number, e.g. 17.1.1#11176.
  • ${smartgit.license} will be replaced by a unique string of the registered SmartGit license file.
  • ${smartgit.license.x} will be replaced by the value of the corresponding (case-sensitive!) key from the registered SmartGit license file, e.g. ${smartgit.license.SupportUntil}.
  • ${prop.x} will be replaced by the Java system property x. For instance, ${} will be replaced by the Java system property
  • ${env.X} will be replaced by the environment variable X. For instance, ${env.USERID} will be replaced by the environment variable USERID.


Specifies the HTTP request method to be used, either GET or HTTP (defaults to GET).


Following configuration will track users on (including a custom USERID environment variable) at


Debug Properties


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


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




The delay/frequency in minutes for which SmartGit will fetch remote repositories, if enabled in the Preferences, section Background Commands


  • No labels