1. mercurialeclipse
  2. main


Clone wiki

main / Installation_and_Configuration

Installation and Configuration


Requires Eclipse and Mercurial to be installed. See Releases for specific version requirements.

Install from update site

Update Site URL
Stable Releases:http://mercurialeclipse.eclipselabs.org.codespot.com/hg.wiki/update_site/stable
Development Snapshots:http://mercurialeclipse.eclipselabs.org.codespot.com/hg.wiki/update_site/snapshots

Generally only use the stable update site. Use the development snapshots update site to try out the latest features or to help test the next version.

Install from update site Instructions

In Eclipse add the update site "Help"->"Install New Software...". Exact screens may vary depending on Eclipse version.


To add the site click on the Available software tab. You should see something like the following screenshot:


Now click on the Add site... button and enter one of the Update Site URLs listed above. Select the newly added site and click on Install to start download and installation.

Install from source

And finally, if you want to try out the most recent changesets in our development repository, have a look at Hackers deploy section.

MercurialEclipse preferences

Eclipse's preferences can be accessed by selecting to Windows->Preferences (Windows/Linux) respectively Eclipse->Preferences in the Application's menu.


Main preferences

Note: Some of this section may be obsolete

The MercurialEclipse plugin adds to the already existing Eclipse preferences. On the left side, in the tree, you should see an entry named MercurialEclipse. Please click on it. You should see the main MercurialEclipse preference page similar to the preferences I use, shown in the following screenshot.


Mercurial ExecutableThe path to the hg executable.A valid path, e.g. /usr/local/bin/hg. This entry must be valid and filled.
Gpg ExecutableThe path to the gpg executable.A valid path, e.g. /usr/local/bin/gpg or nothing if Gpg is not used.
Mercurial UsernameThe default Mercurial username.Overrides the configuration in your hgrc files. You need not fill it.
Use external merge tool for resolving conflictsSwitch between internal Eclipse merge and configured merge tool.If not selected, use Mercurial simplemerge and then the Eclipse internal merge facilities
When a folder contains files with different statuses, flag the folder: as modifiedAlways mark resource changes, additions, etc. with the modified decorator image.selected / unselected
When a folder contains files with different statuses, flag the folder: with the most important statusAlways mark resource changes, additions, etc. with the associated decorator image.selected / unselected
Enable font and color decorationEnables color and fonts settings for decorators. This will slow down decorator performance.selected / unselected
Automatically associate MercurialEclipse with new projects containing a Mercurial repositoryChecks if newly opened projects are already associated with an Eclipse Team provider. If not, it checks if this settings is set. If it is, it checks if the project has a Mercurial repository in the project directory or uptree. If this true as well, such anewly opened project is automatically shared as MercurialEclipse team project.selected / unselected
Number of commit messages to saveThe number of previously entered commit messages to be saved for remembering them in the Commit dialog.Should not exceed 30 as each saved comment will get added to a combo box in commit dialog

Console preference page

This preference page controls how the Mercurial console behaves and looks like. The Mercurial console shows each Mercurial command and enables you to see how MercurialEclipse interacts with Mercurial.


Wrap textDo line wraps if necessaryselected / unselected
Console widthNumber of characters to fit in one linebetween 10 and 999
Limit outputDon't keep the full history of an Eclipse session in the consoleselected / unselected
Number of charactersNumber of characters to limit the console toa number
Open console on messageCreates and opens a console if no console is open and brings the console view to the foreground when the Mercurial console receives a message.selected / unselected
Show all Hg messagesShows complete Mercurial output. USE WITH CARE as hg log and hg status data is output, too. So the amount of data written can become huge.selected / unselected
Command colorThe color with which Mercurial command invocations are displayeda color
Message colorThe color with which plugin messages are displayeda color
Error colorThe color with which error messages are displayeda color

Performance preference page

This preference page enables you to set performance related settings.


hg log revision limitThe number of changesets / revisions to pull in a batch, e.g. in the History viewa number
Number of files to query hg status withThe number of files which we may add to one invocation to statusa number
Always call hg status for whole repositoryAlways get the status for all repository files instead of getting the status for single or multiple files. This option should be switched on (Bastian's Hint)selected / unselected
Compute deep decorationEnabling this will calculate the refreshed resources' uptree status in order to decorate the whole tree and all folders correctly. This option is a waste of time if the status option is set to getting status for the whole repositoryselected / unselected
Show changeset information for filesThis adds additional information to each resource's decoration like the last author, changeset-index of last modification etc. The downside of this is that it comes with a huge performance penalty.selected / unselected

Timeouts preference page

This preference page allows you to specify the longest time you want to wait for an operation. Usually the defaults are sufficient, so if you don't see timeouts just leave these settings alone.