VM options
Certain configuration of SmartGit has to be done by VM options, in
files called smartgit.vmoptions
: there is a global file which affects
the entire installation, i.e. is applied to all users and a
user-specific file which only affects the current user and overrides
options from the global file. The location of both files depends on your
operating system:
- Windows: the global file is
bin\smartgit.vmoptions
in SmartGit’s installation directory; the local file is%APPDATA%\syntevo\SmartGit\smartgit.vmoptions
(%APPDATA%
is the path defined in the environment variableAPPDATA
) - Linux: the global file is
bin/smartgit.vmoptions
in SmartGit’s installation directory; the local file is~/.smartgit/smartgit.vmoptions
- Mac: the global file is
Contents/MacOS/smartgit.vmoptions
in SmartGit’s installation directorySmartGit.app
; the local file is~/Library/Preferences/SmartGit/smartgit.vmoptions
Following VM options can be specified in either of these two files:
Location of the Settings Directory
The settings contains SmartGit’s settings. See Installation and Files
for information about the default location and contents of the settings
directory. On Windows and Linux, you can change its location by
modifying the VM option -Dsmartgit.settings
.
Note
Changing the settings directory’s location is not supported on Mac OS X.
Within the value of smartgit.settings
, certain Java system properties
are allowed, such as user.home
. Another accepted value is the special
smartgit.installation
property, which refers to the SmartGit
installation directory.
Example
To tell SmartGit to store its settings in the subdirectory
.settings
of the SmartGit installation directory, add follow line tosmartgit.vmoptions
:
-Dsmartgit.settings=${smartgit.installation}\.settings
(Windows)
-Dsmartgit.settings=${smartgit.installation}/.settings
(Linux)
Location of the Updates Directory
The Updates directory contains downloaded program updates. See
Installation and Files
for information about the default location and contents of the Updates
directory. On Windows and Linux, you can change its location by
modifying the VM option -Dsmartboot.sourceDirectory
.
Example
To tell SmartGit to store its program updates in the subdirectory
.updates
of the SmartGit installation directory, add follow line tosmartgit.vmoptions
:
-Dsmartgit.settings=.updates
Used Java Runtime Environment
Windows
Use the Windows environment variable SMARTGIT_JAVA_HOME
to tell
SmartGit which JRE to use. In case of using a 64-Bit JRE, you will have
run to SmartGit using bin/smartgit64.exe
.
Example
To switch to a 64-Bit JRE located at in
C:\Program Files\Java\jre8
, set the environment variableSMARTGIT_JAVA_HOME=C:\Program Files\Java\jre8
.
Linux
On Linux, you can configure the JRE to be used by adding
jre=/path/to/jre
to smartgit.vmoptions
.
Example
To tell SmartGit to use the JRE located in
/opt/jre/jre32/jre1.7.0
, add following line tosmartgit.vmoptions
:
jre=/opt/jre/jre32/jre1.7.0
Memory Limit
The memory limit (also known as maximum heap size) specifies how much
RAM the SmartGit process is allowed to use. The memory limit can be
configured by the VM option -Xmx
.
Example
To change the maximum memory limit to 1GB, add following line to
smartgit.vmoptions
:
-Xmx1024m
If the set value is too low, SmartGit may run out of memory during memory-intensive operations.
Note
32-Bit Java VMs only allow to configure a maximum memory limit of roughly
1200M
. For almost all setups and repository sizes, this should be sufficient. If you nevertheless need to configure a higher limit, you will have to use a 64-bit VM and on Windows invokesmartgit64.exe
.