RKWard Source Repository

From RKWard
(Difference between revisions)
Jump to: navigation, search
(Purpose of this page)
(Update info)
 
Line 4: Line 4:
 
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.
 
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.
  
'''Note''': For instructions on fetching and building sources for the KDE 3 versions of RKWard, please refer to [https://rkward.kde.org/w/index.php?title=RKWard_SVN&oldid=902 an older revision of this page].
+
== Alternatives: Daily builds ==
  
== Alternatives ==
+
Sometimes all you want is to test a relatively recent development snapshot, easily.
  
Sometimes all you want is to test a relatively recent development snapshot, easily. For Ubuntu users, a variety of PPAs is available at [https://launchpad.net/~rkward-devel], including an archive of [https://launchpad.net/~rkward-devel/+archive/rkward-dailys daily builds].
+
- 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/
  
 
== Pre-requisites ==
 
== Pre-requisites ==
Line 18: Line 22:
 
  $ apt-get install git
 
  $ apt-get install git
  
Further, you need the KDE4/QT4 libraries and headers and R. See  [[Building_RKWard_From_Source#Requirements|the Requirements]] section on the [[Building_RKWard_From_Source]] page.
+
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.
  
 
== Checking out the current Git sources ==
 
== Checking out the current Git sources ==
Line 48: Line 52:
 
== Producing patches ==
 
== Producing patches ==
  
If you would like to contribute patches, the easiest way (both for you, and also for the developers) is this:
+
Our preferred mechanism of accepting patches is via "phabricator" ([https://community.kde.org/Infrastructure/Phabricator instructions]).
 +
 
 +
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
Line 55: Line 61:
 
# Maybe run ''git pull --rebase'' 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 git diff > patch.diff
 
# run git diff > patch.diff
# submit the diff on http://git.reviewboard.kde.org, or send it 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 Git repository online: http://quickgit.kde.org/?p=rkward.git
+
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