leftborder

Menu [toggle]

...

www.theopenrobotproject.org
Print

Project Galleries

TORP project is stored in a Subversion (external link) (SVN) repository at sourceforge (external link). If you would like to just download the files for a quick look you can do it using a web interface available at:


However, we strongly recommend you to use a SVN client that is capable to download the whole folder and also make you able to upload contributions to the group. This page will provide you the "how to" in order to manage the project using the SVN client. In next sections you will find information about how a SVN system works (if you are not familiar with this concept), how to install and configure a SVN client, how to download files and also how to upload your contributions.

What is a SVN?


If you are not familiar with a SVN System, we will quickly describe here how things work. SVN is a very well known system for collaborative software development, where many people works simultaneously in a single project. All project files remain stored in a SVN Server, and you will need to install and configure a SVN client (it is a very simple and quick process). Since you have a SVN client in your machine, every time you start your work, you must ask your client to download to your machine the newest software version stored in the server. Every time you finish your job (or from time to time), you must sync again with the server in order to upload your changes to the server. After your upload, a newer version of the project is automatically created and this will be the current version of the software if someone tries to download it. The SVN server has also some useful tools: it is capable to manage conflicts in the upload process and also keep stored all files upload indefinitely. In other words, if you made some mistake in your development, it is easy to revert and download an older version of the software.

How to install a SVN client?


There are lots of SVN clients. We will provide here a tutorial to a quick install of TortoiseSVN (external link) for windows. Version 1.5.4 of this client can be downloaded here (external link) (~17M). Just follow this installation process (you will find no surprises). Be sure to restart your system before you can continue.

How do I configure my SVN?


First of all, "right click" in your desktop, select "SVN Checkout..."; Fill in the dialog as follows:


Click "OK". Your login and password will be required. If you are a member of the TORP development group (and have a login at sourceforge), you will be able to upload contributions. Otherwise, login at anonymous for just download files. TortoiseSVN will now check out the code. You can now work in downloaded files normally in our hard disk (they will not be upload unless you do that). A detailed description about the TortoiseSVN configuration for sourceforge can be found here (external link).


How should I work with SVN?


You will need appropriate actions in some special cases:

  • When starting your work. Every time you start to work you must download the newest version of the project. In this way, select the main folder, "right click" and "SVN Update". Now you have the newest version of the project in your machine;
  • When creating new files. If you decided to create a new file (or folder), just do it in the project folder. This file icon will not exhibit the green check as others. This means that this file does not belong to the project yet. You can add it manually with a "right click" in this file and "SVN Add" and "OK". If you prefer, it will be added automatically when you commit the whole project (details of this process bellow). Now this file belongs to the project like others;
  • When finishing your work. This is the most delicate point, and there are two steps to be accomplished. First of all, you must keep in mind that newer versions of the project can have being uploaded by someone else just while you worked in your changes. In this case, there are two possibilities: i) a project file different of those you worked in was changed; ii) the files you worked in were also changed by others. In this way, before you can upload your code, as a first step you must check for new changes in the project. In this way, "right click" in the main folder and "SVN Update". This will download the possible newer files. If some files were newer versions of yours, your files will be replaced by newer ones. However, if someone changed the same file you did, the SVN client will report a "conflict" situation, asking you what to do. As a second step, now you need to update your changed files to the SVN Server. This operation is known as "commit". Select the main TORP folder, "right click" and "SVN commit". A dialog box will appear, and it is important that you insert a text describing the main changes you made in this version. Remember that there will be lots and lots of code versions stored in server, and if you need to search some previous stable version you would like to have detailed descriptions of these versions. Post something like "Improved robot hand with a smaller finger diameter (1cm)". A newer version of the project will be created, and your job is finished.



StarStarStarStarStar




Created by: assimoes. Last Modification: Tuesday 06 of January, 2009 10:52:36 BRT by assimoes.

.
Powered by TikiWiki CMS/Groupware v2.2 -Arcturus-