Development  »  Building Ogre  »  Getting Sources With TortoiseHG

This page is a quick and dirty guide to getting the OGRE sources with tortoisehg, a windows mercurial client. It is a quick guide, and is not meant to replace the mercurial information page and the OGRE developer guide.

Getting the sources for the first time

Get tortoisehg

Download the client from http://tortoisehg.bitbucket.org and install it.

Configure tortoise hg

 
After installation, right click in a windows folder -> tortoisehg -> Global Settings -> Click "Edit file", and paste these contents to it :

[extensions]
progress=
rebase=
transplant=
hgext.win32text=
[diff]
git = True
[ui]
username = Your Name <youraddress@domain.org>
[encode]
** = cleverencode:
[decode]
** = cleverdecode:
[hooks]
# Reject commits which would introduce windows-style text files
pretxncommit.crlf = python:hgext.win32text.forbidcrlf
[tortoisehg]
postpull = rebase

 
(If using a fresh install, the only line in the file should be # Generated by tortoisehg-config )

Getting the ogre sources

 
Right click in a folder -> tortoisehg -> clone repository. Source path should be http://bitbucket.org/sinbad/ogre , and it will get checked out to the dest dir.

Other operations

 
You now have the OGRE sources checked out! Here are some additional operations you might want to do :

Switching to a different branch

 
tortoisehg context menu -> update -> select desired branch in menu. (For example, 1-7, 1-6 etc).

You can also easily have multiple branches on your computer. After fetching the code once, you can use the local path of the ogre sources as the source directory for your next clone. Clone the repository somewhere else (using the destination path of the first checkout as the source path), then switch to the desired branch in the new directory. It will greatly reduce the amount of data you have to fetch from the ogre servers.

If you do this, you might want to make the second clone independent of the first. To do that, go to Context Menu -> Repository Settings -> Synchronize (from left menu list) -> Set the default repository path to http://bitbucket.org/sinbad/ogre/ (or whichever connection mode you're using).

Creating a patch

 
The Commit action is different in mercurial. It does not automatically upload things to the server. To create a patch of your local change, first commit it into your local repository.

Next, open the repository explorer (context menu -> Hg Repository Explorer), right click the changeset you wish to create a patch from, and select Export -> Export Patch :

Applying a patch

 
In the same repository explorer, select 'Import' from the 'Synchronize' menu and point to the patch. You will then have an opportunity to commit it into your local repo.

 
TODO : continue and maybe add more images.