RKWard Source Repository

From RKWard
(Difference between revisions)
Jump to: navigation, search
m (Compiling)
(Update info)
 
(8 intermediate revisions by 3 users not shown)
Line 2: Line 2:
 
== Purpose of this page ==
 
== 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.
+
Instructions to track the most recent development version in our source repository (git). 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 ==
+
== Alternatives: Daily builds ==
  
=== Generic requirements ===
+
Sometimes all you want is to test a relatively recent development snapshot, easily.
  
We need a Subversion client; on Debian based systems:
+
- For Ubuntu users, a variety of PPAs is available at [https://launchpad.net/~rkward-devel], including the following daily build archives:
 +
  - [https://launchpad.net/~rkward-devel/+archive/ubuntu/rkward-kf5-daily KF5 version of RKWard]
 +
  - [https://launchpad.net/~rkward-devel/+archive/ubuntu/rkward-kf5-daily-cran KF5 version of RKWard compiled for CRAN R]
 +
  - [https://launchpad.net/~rkward-devel/+archive/ubuntu/rkward-kf5-backports-daily-cran KF5 version of RKWard compiled for CRAN R and KF5 backports]
 +
- For Windows users, daily builds can be found at https://binary-factory.kde.org/job/RKWard_Nightly_mingw64/
  
$ apt-get install subversion
+
== Pre-requisites ==
  
Other requirements such as PHP, R headers, and some build tools are covered below.
+
=== Generic requirements ===
  
=== For trunk (0.5.0 and above) ===
+
You need a git client; on Debian based systems:
  
These require the KDE4/QT4 libraries and headers. See [[Building_RKWard_From_Source#Requirements|this Requirements]] section on the [[Building_RKWard_From_Source]] page. PHP and R headers are covered therein.
+
  $ apt-get install git
  
=== For KDE3 versions ===
+
Further, you need the KDE/Qt libraries and headers and R. See  [[Building_RKWard_From_Source#Requirements|the Requirements]] section on the [[Building_RKWard_From_Source]] page.
  
These require the KDE3/QT3 libraries and headers. See  [[Building_RKWard_From_Source#Requirements_2|this Requirements]] section on the [[Building_RKWard_From_Source]] page. PHP and R headers are covered therein.
+
== Checking out the current Git sources ==
  
Some additional build tools are needed for configuring the code from SVN. On Debian based systems (such as Ubuntu):
+
For anoynmous (read-only) access, use
  
# autotools
+
  $ git clone git://anongit.kde.org/rkward.git rkward_devel
  $ apt-get install automake1.9 autotools-dev
+
  
== Checking out the current SVN sources ==
+
This will download the development sources to a directory called '''rkward_devel'''.
 
+
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 ==
 
== Compiling ==
  
Proceed with compilation / installation as mentioned on [[Building RKWard From Source]]. Specifically,
+
Proceed with compilation / installation as usual (see [[Building RKWard From Source]]). Make sure the path provided to cmake is correct (for example, depending on where you create the build directory, ''''../rkward'''' may be appropriate instead of ''''..'''').
* for trunk (0.5.0 and above, i.e., KDE4 versions) see [[Building_RKWard_From_Source#Compilation| these Compiling instructions]]. Make sure the path provided to cmake is correct (for example, depending on where the build directory is created, ''''../rkward'''' may appropriate instead of ''''..'''').
+
* for the KDE3 branch (0.4.9x and below) see [[Building_RKWard_From_Source#Compilation_2|these Compiling instructions]]
+
  
 
== Staying up to date ==
 
== Staying up to date ==
Line 69: Line 40:
 
To update your working copy to the most recent changes, go to that directory, and run
 
To update your working copy to the most recent changes, go to that directory, and run
  
  $ svn up
+
  $ git pull --rebase
  
 
After this, generally only the
 
After this, generally only the
Line 79: Line 50:
 
steps are needed (less, if you use some advanced tricks).
 
steps are needed (less, if you use some advanced tricks).
  
=== KDE3 branch ===
+
== Producing patches ==
  
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
+
Our preferred mechanism of accepting patches is via "phabricator" ([https://community.kde.org/Infrastructure/Phabricator instructions]).
 
+
$ 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:
+
However, especially for simple patches, you can also submit them to the [[Contact|mailing list]]. In general, follow this procedure:
  
 
# Follow the instructions given above
 
# Follow the instructions given above
# run svn up
+
# run git pull --rebase
# Make your changes directly in the working copy
+
# Make your changes directly in your clone of the repository
# Maybe run svn up again, to make sure changes other people made don't conflict with your changes
+
# Maybe run ''git pull --rebase'' again, to make sure changes other people made don't conflict with your changes
# run svn diff > patch.diff
+
# run git diff > patch.diff
# send the diff to the mailing list with a short message, on what you did, and why.
+
# submit the diff on http://phabricator.kde.org, or send it to the mailing list with a short message, on what you did, and why.
  
 
== Source browsing ==
 
== Source browsing ==
  
You can also browse the SVN repositories online: http://rkward.svn.sourceforge.net/viewvc/rkward/ .
+
You can also browse the Git repository online: https://cgit.kde.org/rkward.git

Latest revision as of 18:37, 5 April 2018

Contents

[edit] Purpose of this page

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

[edit] Alternatives: Daily builds

Sometimes all you want is to test a relatively recent development snapshot, easily.

- For Ubuntu users, a variety of PPAs is available at [1], including the following daily build archives:

 - KF5 version of RKWard
 - KF5 version of RKWard compiled for CRAN R
 - KF5 version of RKWard compiled for CRAN R and KF5 backports

- For Windows users, daily builds can be found at https://binary-factory.kde.org/job/RKWard_Nightly_mingw64/

[edit] Pre-requisites

[edit] Generic requirements

You need a git client; on Debian based systems:

$ apt-get install git

Further, you need the KDE/Qt libraries and headers and R. See the Requirements section on the Building_RKWard_From_Source page.

[edit] Checking out the current Git sources

For anoynmous (read-only) access, use

$ git clone git://anongit.kde.org/rkward.git rkward_devel

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

[edit] Compiling

Proceed with compilation / installation as usual (see Building RKWard From Source). Make sure the path provided to cmake is correct (for example, depending on where you create the build directory, '../rkward' may be appropriate instead of '..').

[edit] Staying up to date

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

$ git pull --rebase

After this, generally only the

$ make

and

$ sudo make install

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

[edit] Producing patches

Our preferred mechanism of accepting patches is via "phabricator" (instructions).

However, especially for simple patches, you can also submit them to the mailing list. In general, follow this procedure:

  1. Follow the instructions given above
  2. run git pull --rebase
  3. Make your changes directly in your clone of the repository
  4. Maybe run git pull --rebase again, to make sure changes other people made don't conflict with your changes
  5. run git diff > patch.diff
  6. submit the diff on http://phabricator.kde.org, or send it to the mailing list with a short message, on what you did, and why.

[edit] Source browsing

You can also browse the Git repository online: https://cgit.kde.org/rkward.git

Personal tools
Namespaces

Variants
Actions
RKWard
Documentation
wiki
Toolbox
Affiliations