Tortoise SVN

From Joomla! Documentation

Revision as of 12:12, 21 May 2010 by AmyStephen (Talk | contribs)

Tortoise SVN

Tortoise SVN is a simple solution for Windows users working with Joomla!'s SVN environment. You can use it to download a current copy of the development repository and to create, apply, and revert patches for testing with the Joomla Bug Squad.

Prerequisites: A local web host environment, such as XAMPP and You administrator privileges on a Windows environment.

If you are using an IDE, you can generally perform these functions in that environment. Instructions for Eclipse are available. If you use Eclipse, Tortoise SVN is not required (although it can still be used along side Eclipse.)

Install Tortoise SVN

Tortoisesvn download.png

Navigate to the Tortoise SVN Site.

Download and install either the 32 or 64-bit option, depending upon your operating system requirements.

To create a local testing environment

Note: You must have XAMPP or another local host environment in place. Right-click an empty folder where you want to create a test site (This must be within your documents folder for your localhost environment). Select SVN Checkout. Enter for URL of repository. Press OK. If prompted, enter anonymous for username and nothing for password. Wait while all files are downloaded from Joomcode.

Update for the latest patches

Right-click the repository created above. Click SVN-Update.

Apply a patch

Download the patch file from an Issue report on Joomlacode. (File tab on bottom of an issue report page.) Right click-the repository folder created above. Select Apply Patch. Locate the patch saved in step 1, click open. Wait for the "File patches" dialog box to appear, right click and select "Patch all."

Revert a patch (remove it after testing)

Right-click the repository where you applied the patch. Click Tortoise-SVN-Revert Select specific files or all files (bottom) to revert the patch changes. Press OK. Wait until the Revert action is complete, then press ok.

Create a patch (after you fixed a bug)

Right-click the repository where you made changes to the code. Click Tortoise-SVN-Create Patch. Select specific files or all files (bottom) that apply to the patch changes. Press OK. Save the patch file (usually named Issue #.patch) to your local environment. Upload the file as an attachment to the Issue. (Note: always delete old patch files so that it's clear to testers which file to use.) Document your issue to include clear testing instructions.