Development Setup

Asked by Martin Knoller Stocker

Hi, I'd like to contribute. I am aiming for a feature ;)

Could you give some instructions to setup the development environment, so that I can easily run tests, install
a specific revision and uninstall it?

I am used to work with maven as a build tool. Which build tool does the diodion build tool use?

Question information

Language:
English Edit question
Status:
Answered
For:
Diodon Edit question
Assignee:
No assignee Edit question
Last query:
Last reply:
Revision history for this message
Oliver Sauder (sao) said :
#1

Build system
==========================================
Diodon uses waf as a build tool. To get more details check out "The Waf Book" (http://waf.googlecode.com/svn/docs/wafbook/single.html).

But the basics to start with are quite simple.

./waf configure
Is needed as first command which will check your system for needed dependencies and needed system directories etc. This command can be additionally called with --debug so debug information will be added to the binary.

./waf build
This command will compile the source code and build the diodon binary

sudo ./waf install
Installing the diodon binaries and data files per default to /usr/local

sudo ./waf uninstall
Removing the installed diodon binaries and data per default from /usr/local

./waf clean
Cleaning up all files created by the build command

./waf distclean
Cleaning up all files created by build and configure

Committing code
==========================================

Diodon uses the Launchpad integrated baazar as scm. Checkout <https://wiki.ubuntu.com/Bzr> to get more insights. However basically you should get up and running with the following:
bzr lp:diodon # create a branch from the trunk series (the only series currently available)
# do some changes
bzr commit # commit changes to your locale repo
bzr push lp:~username/diodon/some-branch-name # push your changes to a public branch on launchpad

So from here attach the branch to a bug/issue and propose it for merging (https://help.launchpad.net/Code/Review).

Contribution: Fixing Bugs / New features
==========================================
Just checkout the list of Bugs https://bugs.launchpad.net/diodon While working on a bug assign it to you and set the status to "Work in progress". When you come up with an idea for a new feature, best report an new issue or check out the blueprints where new upcoming features are discussed.

Unit Test
==========================================

Unfortunately currently there are no unit tests available in Diodon. Would be great to get this up and running soon. See also blueprint https://blueprints.launchpad.net/diodon/+spec/build-system-waf and bug https://bugs.launchpad.net/diodon/+bug/634393

Hope this introduction helps to easier dive into Diodon. Happy coding ;).

Revision history for this message
Oliver Sauder (sao) said :
#2

Some notes about Vala:
A documentation can be found on <http://live.gnome.org/Vala/Documentation>. I currently use gedit and valencia (http://yorba.org/valencia/) for developing Diodon.

There is also a vim syntax highlight available for vala (http://live.gnome.org/Vala/Vim) which might be helpful.

Can you help with this problem?

Provide an answer of your own, or ask Martin Knoller Stocker for more information if necessary.

To post a message you must log in.