RKWard Source Repository

From RKWard
Revision as of 00:44, 21 May 2009 by Kapatp (Talk | contribs)

Jump to: navigation, search

Contents

Purpose of this page

Instructions to track the most recent development version in SVN (Subversion). This is of interest both to people wanting to be on the bleeding edge of RKWard development, and to people wanting to contribute patches.

Pre-requisites

Generic requirements

We need a Subversion client; on Debian based systems:

$ apt-get install subversion

Other requirements such as PHP, R headers, and some build tools are covered below.

For trunk (0.5.0 and above)

These require the KDE4/QT4 libraries and headers. See this Requirements section on the Building_RKWard_From_Source page. PHP and R headers are covered therein.

For KDE3 versions

These require the KDE3/QT3 libraries and headers. See this Requirements section on the Building_RKWard_From_Source page. PHP and R headers are covered therein.

Some additional build tools are needed for configuring the code from SVN. On Debian based systems (such as Ubuntu):

# autotools
$ apt-get install automake1.9 autotools-dev

Checking out the current SVN sources

Sourceforge provides generic instructions on checking out the development sources, which are given here: http://sourceforge.net/svn/?group_id=50231

Unless SourceForge changes something, just run this command:

$ svn co http://rkward.svn.sourceforge.net/svnroot/rkward/trunk rkward_trunk

This will download the development sources to a directory called rkward_trunk.

KDE 3 branch

If you would like to check out the latest KDE 3 branch of RKWard, use this command:

$ svn co http://rkward.svn.sourceforge.net/svnroot/rkward/branches/release_branch_0.4.9/ rkward_kde3

This will download the development sources to a directory called rkward_kde3.

Preparing the sources

trunk (0.5.0 and above)

No special setup is needed. Just follow the usual compilation instructions. Note that an out-of-source build (as described) is strongly recommended when working with SVN.

KDE 3 branch

Several files needed to build RKWard are not stored in SVN, but rather generated by automake. After the checkout, cd to the source directory (rkward_kde3, as above), then run

$ make -f Makefile.svn

If there are any errors, make sure you have installed the required packages.

Compiling

Proceed with compilation / installation as mentioned on Building RKWard From Source. Specifically,

  • for trunk (0.5.0 and above, i.e., KDE4 versions) see these Compiling instructions. Make sure the path provided to cmake is correct (for example, depending on where the build directory is created, '../rkward' may be appropriate instead of '..').
  • for the KDE3 branch (0.4.9x and below) see these Compiling instructions

Staying up to date

To update your working copy to the most recent changes, go to that directory, and run

$ svn up

After this, generally only the

$ make

and

$ sudo make install

steps are needed (less, if you use some advanced tricks).

KDE3 branch

In the KDE3 branch, sometimes it is necessary to re-run automake and ./configure as well. As a rule of thumb: If make and make install don't work, try running

$ make -f Makefile.svn
$ ./configure

first, then try running make and make install again.

Producing patches

If you would like to contribute patches, the easiest way (both for you, and also for the developers) is this:

  1. Follow the instructions given above
  2. run svn up
  3. Make your changes directly in the working copy
  4. Maybe run svn up again, to make sure changes other people made don't conflict with your changes
  5. run svn diff > patch.diff
  6. send the diff to the mailing list with a short message, on what you did, and why.

Source browsing

You can also browse the SVN repositories online: http://rkward.svn.sourceforge.net/viewvc/rkward/ .

Personal tools
Namespaces

Variants
Actions
RKWard
Documentation
wiki
Toolbox
Affiliations