User Tools

Site Tools


svn_client

Differences

This shows you the differences between two versions of the page.

Link to this comparison view

Both sides previous revision Previous revision
Next revision
Previous revision
svn_client [2009-04-28 10:40]
snakeman added cancel and cleanup info for tortoiseSVN.
— (current)
Line 1: Line 1:
-====== SVN ====== 
  
-Subversion (SVN) is a version control system (VCS), it allows users to keep track of changes made over time to any type of electronic data. Typical uses are versioning source code, web pages or design documents. ​ 
- 
-ACE/​OAC/​PMC/​Zeus use SVN to develop their respected mods for ArmA, it allows them to track any changes made to the mod and have multiple people working on it any time.  
- 
- 
-====== Installing SVN Client ====== 
- 
-We have open read access on the SVN repository (the place where we keep the mod) so that anyone can get the latest version. This guide will help any newcomers to SVN gain access to the latest version of the mod. 
- 
-Step 1 
- 
-In order to fully utilize the SVN system you will need a Subversion client. All the developers use the open source client TortoiseSVN. You will need to install [[http://​tortoisesvn.net/​downloads|TortoiseSVN]] and restart your computer before you can use it. 
- 
-Step 2 
- 
-In order to get the mod you will need to tell TortoiseSVN where to get the mod from and where to put it. TortoiseSVN works off shell extension so open Windows Explorer and navigate to your Armed Assault directory. 
- 
-Create a folder called MOD_DEV (to distinguish between server version and development version.) Right click on the new folder and select 'SVN Checkout'​. A dialogue will come up with a blank field entitled 'URL of repository:'​ in which you will need to put the http link provided by your mod developer / SVN admin. 
- 
-The field entitled '​Checkout directory:'​ needs to point to the empty folder you just made. Example: 
- 
-C:​\Games\MOD_DEV 
- 
-Leave the other options blank and click OK. TortoiseSVN will now begin downloading the mod. Screenshot: 
- 
-IMAGE MISSING, sorry :) 
- 
-Step 3 
- 
-Because this is used for development,​ we keep the mod in folder form (not compressed into pbos). In order to be able to play with it, you will need to '​build'​ it using a tool we have included in the mod. In the tools folder there is a file called build.bat. Run the file and do not press any keys while it is running. Now you can play with it by running the folder you created as a normal mod folder. ​ 
- 
- 
-====== SVN Update for a MOD ====== 
- 
-SVN Update means "gimme the new files!"​ in short, if you think the developers of a mod has been editing something, do a SVN Update to get all the latest files. Usually this is done daily, if not even few times a day if there is active development going on. 
- 
-When you want to update your SVN directory for the specified mod, just RMB click the MOD_DEV directory and choose "SVN Update",​ now the SVN client starts and downloads any and all available updates for this SVN repository (mod_dev). 
- 
-Please be aware that TortoiseSVN client is slow to respond, do the RMB clicking and //wait patiently//​. Don't mess with the client before its finished its download / updating. 
- 
-After the update you see the revision of the mod and you can see the changelog, you can go into specific files like text files to read even the individual changes. 
- 
-If the SVN Update "​bugs"​ or hangs without any reply for several minutes, maybe 10 minutes or so, then you can click the Cancel button. Now usually pressing cancel don't do nothing, SVN client (TortoiseSVN) just sits there, just click the cancel button few times and wait, after few of such tries if nothing has happened (client wont cancel), then you can safely close the client from the X at the upper right hand corner. Usually after this I'm afraid the SVN files on your directory are broken a little bit, it might require "SVN Cleanup"​ before you can continue. To do this, choose RMB and then TortoiseSVN -> Clean up, and its cleaning the dir up. 
- 
- 
-====== Handling SVN Directory ====== 
- 
-SVN is fragile software or sort of file system so to speak. 
- 
-**Do not move or delete files in the MOD_DEV SVN directory at any time!** 
- 
-**Do not move or delete the MOD_DEV SVN directory at any time!** 
- 
-You can see from your windows shell explorer that the files are tagged for SVN affiliation,​ if you move or delete these files, your SVN repository is ruined and often only way to correct this error is to re download the whole mod from the mod's SVN server. Please, do not mess around in the MOD_DEV directory unless you //really// know what you're doing. 
- 
-You are free to copy files out from the MOD_DEV dir, just copy paste them where you want, but be aware that there are hidden .SVN files in the dir so if your win shell explorer shows hidden files please do not copy them. If you want to copy the whole SVN dir into your ArmA mod directory, choose RMB -> TortoiseSVN -> Export. Now you can specify to the directory where you want the SVN directory contents copied / exported safely. This way you don't need to worry about hidden files or damaging your SVN dir. 
svn_client.1240915257.txt.gz ยท Last modified: 2009-04-28 10:40 (external edit)