User Tools

Site Tools


wiki:development:development-workspace

Differences

This shows you the differences between two versions of the page.

Link to this comparison view

Both sides previous revision Previous revision
Next revision
Previous revision
wiki:development:development-workspace [2012/12/21 12:32]
kjellski [Building]
wiki:development:development-workspace [2013/03/14 23:40] (current)
sunweaver [Build X2Go Packages for Debian]
Line 1: Line 1:
-====== How to set up an X2go Development Workspace ======+====== How to set up an X2Go Development Workspace ======
  
 ===== Get the Code ===== ===== Get the Code =====
Line 7: Line 7:
  
 ===== Building ===== ===== Building =====
 +
 +==== Debian/Ubuntu ====
  
 On Ubuntu you'll probably need the following dependencies to get a proper build: On Ubuntu you'll probably need the following dependencies to get a proper build:
  
 <code> <code>
-  sudo apt-get install devscripts debhelper +  sudo apt-get install devscripts debhelper ubuntu-dev-tools build-essential
-    ubuntu-dev-tools build-essential +
-    libldap2-dev libssh-dev libxpm-dev libcups2-dev+
 </code> </code>
  
 +More info in general form: [[https://wiki.ubuntu.com/PackagingGuide/HandsOn]]
  
 ==== Getting Build Dependencies ==== ==== Getting Build Dependencies ====
-Each git has a file'' debian/control''. It has a section ''Build-Depends''.+Each Git has a file'' debian/control''. It has a section ''Build-Depends''.
  
 The package ''ubuntu-dev-tools'' (also provided in Debian) allows to install them running ''sudo get-build-deps debian/control''. The package ''ubuntu-dev-tools'' (also provided in Debian) allows to install them running ''sudo get-build-deps debian/control''.
Line 33: Line 34:
 ===== Development Strategies ===== ===== Development Strategies =====
  
-There are a few different approaches for working on X2go code (or Git-hosted code in general). This wiki page will address two of them: HEAD development and local branch development.+There are a few different approaches for working on X2Go code (or Git-hosted code in general). This wiki page will address two of them: HEAD development and local branch development.
  
-=== HEAD X2go Development ===+=== HEAD X2Go Development ===
  
-With the term HEAD one refers to the topmost recent code in a code repository. The Git branch that HEAD development gets committed to is the master branch of each X2go Git project.+With the term HEAD one refers to the topmost recent code in a code repository. The Git branch that HEAD development gets committed to is the master branch of each X2Go Git project.
  
-If you are a core X2go developer and the code you are working on is something that is intended to become a core component of X2go then you are likely to directly work on HEAD.+If you are a core X2Go developer and the code you are working on is something that is intended to become a core component of X2Go then you are likely to directly work on HEAD.
  
 Also bug fixes should be committed to the master branch directly. Also bug fixes should be committed to the master branch directly.
Line 46: Line 47:
 === Development on Local Git Branches === === Development on Local Git Branches ===
  
-However, if you work on a piece of code or a feature, that may or may not become a part of X2go or a piece of code that will break a couple of things when committed to the master branch then you should rather start a local branch to work on that.+However, if you work on a piece of code or a feature, that may or may not become a part of X2Go or a piece of code that will break a couple of things when committed to the master branch then you should rather start a local branch to work on that.
  
 If you want to branch of from HEAD, use this command: If you want to branch of from HEAD, use this command:
Line 63: Line 64:
 You then continue your work on the <my-local-branch-name> branch and commit your changes there. You then continue your work on the <my-local-branch-name> branch and commit your changes there.
  
-You may also upload your local branch to the X2go Git site. Please discuss this first on the x2go-dev mailing list.+You may also upload your local branch to the X2Go Git site. Please discuss this first on the x2go-dev mailing list.
  
 <code> <code>
Line 71: Line 72:
 To incorporate changes from your <my-local-branch-name> you may use e.g. the ''git-cherry-pick'' command or the ''git-checkout'' command.  To incorporate changes from your <my-local-branch-name> you may use e.g. the ''git-cherry-pick'' command or the ''git-checkout'' command. 
  
-Note: The only thing we do not accept on X2go Git are Git merges.+Note: The only thing we do not accept on X2Go Git are Git merges.
  
 ==== Coding Strategies ==== ==== Coding Strategies ====
  
-There are some recommendations that we give when coding X2go and committing in X2go Git:+There are some recommendations that we give when coding X2Go and committing in X2Go Git:
  
   * run ''git-pull'' before starting to work on new code snippets (to avoid nasty merge problems)   * run ''git-pull'' before starting to work on new code snippets (to avoid nasty merge problems)
Line 91: Line 92:
 </code> </code>
  
-__After__ you have performed some changes on an X2go Git project, please use the ''git-commit'' command to commit your changes to your local Git:+__After__ you have performed some changes on an X2Go Git project, please use the ''git-commit'' command to commit your changes to your local Git:
  
 <code> <code>
Line 131: Line 132:
 ==== Maintaining Changelogs ==== ==== Maintaining Changelogs ====
  
-Currently we use Debian tools to maintain each project's changelog file. Debian tools are optimal for developing Debian packages. For an upstream project like X2go we have to find something that's more generic.+Currently we use Debian tools to maintain each project's changelog file. Debian tools are optimal for developing Debian packages. For an upstream project like X2Go we have to find something that's more generic.
  
-However, as this is in process and till it has settled, please continue as described below when maintaining the X2go projects' changelog files.+However, as this is in process and till it has settled, please continue as described below when maintaining the X2Go projects' changelog files.
  
   - code your code   - code your code
Line 148: Line 149:
 ==== Install Software ==== ==== Install Software ====
  
-For working with X2go Git you have to install some software on your development workstation. We will presume you develop under Debian:+For working with X2Go Git you have to install some software on your development workstation. We will presume you develop under Debian:
  
 <code> <code>
Line 179: Line 180:
  
  
-==== Releasing X2go Projects ====+==== Releasing X2Go Projects ====
  
-The X2go version scheme is a four digit version number: ''<major>.<minor>.<micro>.<nano>''+The X2Go version scheme is a four digit version number: ''<major>.<minor>.<micro>.<nano>''
  
-For releasing X2go components make sure that you have a GPG key for your commit mail address available and installed on your local system. The commit mail address can normally be found in ''~/.gitconfig'' (see above).+For releasing X2Go components make sure that you have a GPG key for your commit mail address available and installed on your local system. The commit mail address can normally be found in ''~/.gitconfig'' (see above).
  
-If you decide for releasing an X2go component, please perform the following steps:+If you decide for releasing an X2Go component, please perform the following steps:
  
   - Change any string location in the project that reflects the version number: changelog, VERSION.<x2go-project> file, maybe there is a version number somewhere in the code (Python: __init__.py files)   - Change any string location in the project that reflects the version number: changelog, VERSION.<x2go-project> file, maybe there is a version number somewhere in the code (Python: __init__.py files)
Line 195: Line 196:
 $ git push --tags $ git push --tags
 </code> </code>
-  - Use the ''x2go-updatebuildmain'' script from the X2go buildscripts to update the build-main branch of the project<code>+  - Use the ''x2go-updatebuildmain'' script from the X2Go buildscripts to update the build-main branch of the project<code>
 $ x2go-updatebuildmain HEAD $ x2go-updatebuildmain HEAD
 </code> </code>
-  - Run ''x2go-tarballrelease'' in the base folder of the X2go Git project to be released:<code>+  - Run ''x2go-tarballrelease'' in the base folder of the X2Go Git project to be released:<code>
 $ x2go-tarballrelease <a.b.c.d> [<blessed-refspec-or-tag>] $ x2go-tarballrelease <a.b.c.d> [<blessed-refspec-or-tag>]
 </code>The tarball will then be moved to this location: ''../_releases_/source/<project>/''. </code>The tarball will then be moved to this location: ''../_releases_/source/<project>/''.
Line 216: Line 217:
 As ''x2go-admin'' you can: As ''x2go-admin'' you can:
  
-  * create new X2go Git projects+  * create new X2Go Git projects
   * edit Git configs   * edit Git configs
   * edit Git descriptions   * edit Git descriptions
Line 224: Line 225:
   * upload Debian packages to http://packages.x2go.org/debian   * upload Debian packages to http://packages.x2go.org/debian
  
-==== Using X2go Build Scripts ====+==== Using X2Go Build Scripts ====
  
-The X2go project uses a hand full of build scripts that are also hosted in X2go Git:+The X2Go project uses a hand full of build scripts that are also hosted in X2Go Git:
  
 <code> <code>
Line 265: Line 266:
 </code> </code>
  
-==== Build X2go Packages for Debian ==== +==== Build X2Go Packages for Debian ====
- +
-On ''code.x2go.org'' there is a qemubuilder build environment installed. However, as the underlying system is already a VM, and thus, does not render KVM support (qemu software emulation only :-( ), building packages with qemubuilder on ''code.x2go.org'' is not at all recommended.+
  
-Currently, packages for Debian are built on a non-public machine at DAS-NETZWERKTEAM in Northern Germany and then get uploaded to ''code.x2go.org'' aka ''packages.x2go.org''.+On ''japsand.x2go.org'' there is a qemubuilder build environment installed.
  
-==== Upload X2go Packages to X2go's Debian Repository ====+==== Upload X2Go Packages to X2Go's Debian Repository ====
  
-As ''x2go-admin'' you have upload rights for the X2go Debian repository. Use Debian's ''dupload'' tool for this (for further info refer to ''man dupload'' and ''man dupload.conf''). Please add the following lines to your ''~/.dupload'' configuration file:+As ''x2go-admin'' you have upload rights for the X2Go Debian repository. Use Debian's ''dupload'' tool for this (for further info refer to ''man dupload'' and ''man dupload.conf''). Please add the following lines to your ''~/.dupload'' configuration file:
  
 <code> <code>
-### X2go/DEBIAN+### X2Go/DEBIAN
 $cfg{"x2go-debian-sid"} = { $cfg{"x2go-debian-sid"} = {
         fqdn => "code.x2go.org",         fqdn => "code.x2go.org",
wiki/development/development-workspace.1356093143.txt.gz · Last modified: 2013/03/08 13:31 (external edit)