Visual Guide: How to install, use, and compile Subclipse

Sunghun Kim , Guozheng Ge

{hunkim, guozheng}@cs.ucsc.edu

Abstract. In this memo, we explain how to install, use and compile Subclipse, a Subversion plug-in for
Eclipse. We show as may figures as possible.

1 Introduction
Subversion [1] is a version control tool like CVS [2], but the Subversion project is started to replace
CVS (by the same developers of CVS) due to several limitations of CVS such as lack of versioning support
for directory and file metadata, namespace problems, complexity in administration, etc. Subversion uses
Apache HTTPD [3] server as their server and uses open protocols, such as HTTP[4], WebDAV [5], and
DeltaV [6]. Subversion will be the next generation version control system, so we strongly recommend
using Subversion as your version control system for software development. More information about
Subversion is available from the project home page, http://subversion.tigris.org.
Eclipse [7] is an open extensible software development framework. Due to its openness and extensibility
with plugin architecture, more and more developers start using and developing it, and many researchers try
to build their own research ideas on top of the Eclipse platform. At the time of this writing, there are more
than 400 Eclipse plug-ins are available [8].
Subclipse [9] is Subversion plug-in for Eclipse. It aims to provide all Subversion functionality to the
Eclipse development environment. Its an open source project as well, and available at the project
homepage, http://subclipse.tigris.org/
In this memo, we briefly introduce how to install and use Subclipse for Subversion and Eclipse users.
We also give guidelines for hacking the source code of Subclipse for developers to contribute to the
Subclipse project.

2 Installation
Installation process is quite simple:
1) Download a distribution Zip file at Subclipse website.
2) Unzip the file into the parent directory of the eclipse installation directory, e.g. if your Eclipse
installation directory is C:\Eclipse, then unzip to C:\.
3) Restart eclipse.

3 Using and Compiling Subclipse

If you have installed Subclipse successfully and restarted the Eclipse, you need to add SVN perspective
to checkout source code (Window>Open Perspective>SVN Repository Exploring), like in Figure 1.
We Illustrate how to use Subclipse plugin by showing how to compiling the source code from Subclipse
source repository. First we need to checkout the Subclipse source code from Subclipse repository,

http://svn.collab.net/repos/subclipse/. If you are using Eclipse 2.1.x you can check out source code from
http://svn.collab.net/repos/subclipse/. If you are using Eclipse 3.0, you check out source code at a branch
from the version tree at http://svn.collab.net/repos/subclipse/branches/subclipse/subclipse-3/.

Figure 1. Select SVN Repository Perspective in Eclipse.

Figure 2. Setup A Subversion Workspace.

To check out source code, we need to open the SVN perspective, and add the Subclipse repository (by
right click in the Subclipse view and select New>Repository Location). Left part in Figure 2
appears for you to enter URL for Subversion repository, username and password, in our case, enter
http://svn.collab.net/repos/subclipse for repository URL and leave username and password blank. When
you are done, click Finish and then you will see the Subversion repository structure shown the right

figure in figure 2. Browse down to the /trunk or /branches/subclipse/subclipse3. We need to check out as a
project for three directories:
svnClientAdapter
core
ui
By right clicking on a SVN directory, you can check out the directory as a project. We have two options
to check out: Check Out As and Check Out As Project. As gives us more choice such as
project name, type, etc. As project just checks out the project as the directory name. For example if we
check out /branches/Subclipse/Subclipse3/core directory using As project, the project name is core
and local directory for checked out source code is <eclipse installation dir>/workspace/core. We
recommend to checkout using As project for Subclipse source code. After checking out three directories,
you will have three projects: svnClientAdapter, core, and ui. The figure 2 shows the menu for check out.
Table 1 shows the summary of projects you need to checkout.
Table 1 Repository and Projects
Eclipse
version
2.0.x
3.0

Repository

Project

http://svn.collab.net/repos/subclipse/trunk/svnClientAdapter
http://svn.collab.net/repos/subclipse/trunk/subclipse/core
http://svn.collab.net/repos/subclipse/trunk/subclipse/ui
http://svn.collab.net/repos/subclipse/branches/subclipse/subclipse3/svnClientAdapter/
http://svn.collab.net/repos/subclipse/branches/subclipse/subclipse3/subclipse/core/
http://svn.collab.net/repos/subclipse/branches/subclipse/subclipse3/subclipse/ui/

svnClientAdapter
core
ui
svnClientAdapter
core
ui

Change your perspective to the Plug-in development (Window>Open Perspective>Plug-in

Development). Depending on your platform you might see X marks on the projects and need to configure
SWT library path. For example, if you are running Eclipse on windows, you need to add swt.jar in
eclipse/plugins/org.eclipse.swt.win32_x.x.x/ws/win32 (x.x.x corresponds to the version of Eclipse platform
you are using, e.g. 2.1.0, 2.1.1) to CLASSPATH. We recommend adding a library using variable extension
rather than using absolute path, since the path can be changed. Delete other platforms library, if you have
any. Figure 3 shows how to add a new library by extending variables.

Figure 3. Add a new library. Right click on a project and select Properties, this brings up left half
of Figure 2. Select Java Build Path, then pick Libraries from multipane and click on Add
Variable button. A new window appears like right half of Figure 2. Select ECLIPSE_HOME<eclipse install dir> and click Extend button. Another new window appears and select
plugins>org.eclipse.swt.win32_x.x.x>ws>win32>swt.jar.

Another way to add new library is using Plug-in Development Environment (PDE). If you click
plugin.xml in core project, you will see PDE shown in Figure 4. You can select dependencies and use
context menu (right mouse button). You can select the Computer Build Path menu to automatically
computer build path for you. You should compute core first, and ui the second.

Figure 4. Computing Build Path

If you successfully added the SWT library for your platform, the X marks will disappear. Eclipse
automatically compiles the source code for you. Now try to run the compiled Subclipse Plug-in. You can
test your Subclipse by running a new Workbench. Now we have two Subclipse, one we installed and the
other we just compiled and run. We need to turn off installed Subclipse when we run new Workbench.
Select menu run>run. You need to choose Run-time Workbench and click new button. A
new_configuration item appears. You can give the configuration name such as my Subclipse. Next
you need turn off installed Subclipse plugin by deselecting org.tigris.subversion.subclipse.core and
org.tigris.subversion.subclipse.ui from the Plug-ins and Fragments tab. The figure 4 shows the
configuration process.

Figure 5. Configure Workbench to Run Subclipse in new Workbench.

Now try to run compiled Subclipse project and the Eclipse will open a new workbench where you can
test your Subclipse. If you want to change something, come back to the old workbench and change source
files like files in a regular project. The label decoration for Subclipse will show the status of the resources
such as modified and added (left half of Figure 6).

When you created a new resource you can add it into Subversion repository using the Add to version
control menu in the team menu (right half of Figure 6). If you have commit permission, you can commit
your changes. All Subversion functions are available in the team menu shown in figure 6.

Figure 6. Label decoration and the Team menu.

Figure 7. Create a Patch.

If you dont have the commit permission or want to create a patch, you can use the Create Patch
menu in the team menu. The patch wizard windows will show and ask several options. You can create a
patch as a file, or simply copy it to the clipboard. Figure 7 shows the process to create a patch.
You can send your patch to Subclipse development mailing list, [email protected], if you want to
contribute to the project. The patch might not be accepted by the core developers though. Even if it will not
get accepted, you can still make a deployable plug-in for your friends or yourself. We need to setup the
target environment, by choosing menu Window>Preferences>Plug-In Development>Target Platform
shown in Figure 8. In that preference window, you need to select all plug-ins except Subclipse, since we
need to add compiled Subclipse. Figure 9 shows the exporting process. The zip file includes the plug-ins
and libraries. You or your friends can unzip the file into their Eclipse directory to deploy new compiled
Subclipse.

Figure 8. Target Platform

Figure 9. Exporting process.

4 Conclusions
If you are using the Eclipse, Subversion, Subclipse, we would say youve got the right choice for the
next generation software development tools. We hope this memo can be helpful to those who start using
Subclipse and those who try to contribute to the Subclipse project as well. We also feel thankful to those
who started the Subclipse project in the first place and other enthusiastic users who answered our questions
regarding using and compiling Subclipse.

References
1.
2.
3.
4.
5.
6.
7.
8.
9.

Behlendorf, B., et al., Subversion Project Homepage. 2003.http://subversion.tigris.org/

Berliner, B. CVS II: Parallelizing Software Development. in Winter 1990 USENIX Conference.
1990. Washington, DC.
Apache Foundation, The Apache HTTPD Server Project. 2003.http://httpd.apache.org/
Fielding, R., et al., Hypertext Transfer Protocol -- HTTP/1.1, in Internet Draft Standard Request
for Comments (RFC) 2616. 1999
Goland, Y., et al., HTTP Extensions for Distributed Authoring -- WEBDAV, in Internet Proposed
Standard Request for Comments (RFC) 2518. 1999
Clemm, G., et al., Versioning Extensions to WebDAV, in Internet Proposed Standard Request for
Comments (RFC) 3253. 2002
IBM, Eclipse.org Main Page. 2003.http://www.eclipse.org
Eclipse plugins : plugin overview. 2003.http://eclipse-plugins.2y.net/eclipse/plugins.jsp
cdric, c. and D. Bradby, Subclipse Project Homepage. 2003.http://subclipse.tigris.org/