Difference between revisions of "Development Team/Jhbuild"

From Sugar Labs
Jump to: navigation, search
(Dealing with dependencies: sugar-jhbuild depscheck should be the primary means of getting a list of dependencies now)
(factor out distribution specific information)
Line 6: Line 6:
 
==Compatible Platforms==
 
==Compatible Platforms==
  
Jhbuild is quite demanding with regard to the packages and setup for the host Linux distribution. As a result there are only a few Linux Distributions which are known to work with it.
+
Jhbuild is quite demanding with regard to the packages and setup for the host Linux distribution. As a result there are only a few Linux distributions which are known to work with it.
  
Distros supported by the development community are Debian unstable, Fedora Rawhide, Fedora 10, and Ubuntu 8.10. Other distros which have a recent-enough release (e.g. including the latest stable GNOME release) can be supported if someone is willing to maintain the dependencies for that distro release (in config/sysdeps).
+
See the distribution specific instructions for information about whether your distribution is currently supported. Other distros which have a recent-enough release (e.g. including the latest stable GNOME release) can be supported if someone is willing to maintain the dependencies for that distro release (in config/sysdeps).
  
''' Note that Debian Unstable and derived distros (e.g. Ubuntu Intrepid) contain a bug  in python-gnome that impedes running jhbuild '''
+
==Check distro-specific instructions==
  
To work around this use chrpath to remove the rpath setting from your system's gconf.so:  
+
Many distributions have some quirks that need to be catered for and there are different package managing tools in use, so please check the page for your distribution before proceeding:
  
  sudo aptitude install chrpath
+
* [[/Debian]]
  find /usr/lib/python-support/python-gnome2/python2.5/gtk-2.0 -name "*.so" | sudo xargs chrpath -d
+
* [[/Fedora]]
 +
* [[/Ubuntu]]
  
==Checkout sugar-jhbuild==
+
==Check out sugar-jhbuild==
  
 
In a suitable directory, execute
 
In a suitable directory, execute
Line 38: Line 39:
  
 
Some tips:
 
Some tips:
* You may have some issues with penguintv on ubuntu, just interrupt the pull with a CTRL+C, open a shell, repeat the command manually, and accept the certificate permanently.
 
 
* hulahop stopped building because I had installed a more recent version of xulrunner on my machine. The workaround was to <code>rm -rf ~/sugar-jhbuild/source/hulahop</code> and then run update and build again.
 
* hulahop stopped building because I had installed a more recent version of xulrunner on my machine. The workaround was to <code>rm -rf ~/sugar-jhbuild/source/hulahop</code> and then run update and build again.
  
==== Debian ====
+
== Run Sugar ==
On Debian-based distros, you can use this invocation to install all dependencies automatically:
 
 
 
./sugar-jhbuild depscheck -s | sudo xargs aptitude -y install
 
 
 
==== Fedora ====
 
 
 
Fedora dependencies (to be installed before going through the jhbuild process) are [http://wiki.laptop.org/go/Sugar_on_Fedora#Step_1:_Install_the_build_prerequisites listed here].
 
 
 
==Run Sugar==
 
  
 
This command launches the Sugar emulator:
 
This command launches the Sugar emulator:
Line 58: Line 49:
 
To exit the emulator, press Alt-Q.
 
To exit the emulator, press Alt-Q.
  
== Running multiple instances==
+
== Running multiple instances ==
 
To run multiple instances of sugar you can start it in the following way:
 
To run multiple instances of sugar you can start it in the following way:
  

Revision as of 09:05, 17 March 2009

english | 日本語 | spanish HowTo [ID# 22018]  +/-  


Sugar-jhbuild will automatically download the latest of Sugar's dependencies as well as Sugar itself directly from their source repositories, rather than relying on source packages that may have become stale. Below are generic instructions on how to use jhbuild to get up and running with Sugar.

Compatible Platforms

Jhbuild is quite demanding with regard to the packages and setup for the host Linux distribution. As a result there are only a few Linux distributions which are known to work with it.

See the distribution specific instructions for information about whether your distribution is currently supported. Other distros which have a recent-enough release (e.g. including the latest stable GNOME release) can be supported if someone is willing to maintain the dependencies for that distro release (in config/sysdeps).

Check distro-specific instructions

Many distributions have some quirks that need to be catered for and there are different package managing tools in use, so please check the page for your distribution before proceeding:

Check out sugar-jhbuild

In a suitable directory, execute

git clone git://git.sugarlabs.org/sugar-jhbuild/mainline.git sugar-jhbuild

Build sugar base system and its dependencies

Change directory and start the build.

cd sugar-jhbuild
./sugar-jhbuild update
./sugar-jhbuild depscheck
./sugar-jhbuild build

Dealing with dependencies

sugar-jhbuild depscheck will print a list of required packages. They are part of the distribution you're using and should be installed using your favourite package manager (e.g. aptitude/synaptic for Debian, yum for Fedora). If you notice that there's a package missing from the depscheck output (i.e. it's required for Sugar to work properly and not installed, but depscheck does not mention it), please file a bug (login required first, but currently no automatic redirection to login page) against the sugar-jhbuild Component in the SugarLabs bug tracker.

Some tips:

  • hulahop stopped building because I had installed a more recent version of xulrunner on my machine. The workaround was to rm -rf ~/sugar-jhbuild/source/hulahop and then run update and build again.

Run Sugar

This command launches the Sugar emulator:

./sugar-jhbuild run

To exit the emulator, press Alt-Q.

Running multiple instances

To run multiple instances of sugar you can start it in the following way:

SUGAR_PROFILE=2 ./sugar-jhbuild run

This will create a new profile in ~/.sugar/, i.e. ~/.sugar/2/. You will find logs and configuration for this instance here. The default profile is ~/.sugar/default/

Run an individual activity

Within sugar, e.g. in Terminal, this command launches an individual activity for testing:

sugar-launch [bundle name]

You will see debug output appearing in Terminal.

Configure the mode and resolution of Sugar

You can make Sugar run in a window as well as specify a resolution. Within the sugar-jhbuild/install/share/sugar/shell directory, backup, then edit the python program file emulator.py:

cd sugar-jhbuild
cp install/share/sugar/shell/emulator.py install/share/sugar/shell/emulator.py.backup
nano install/share/sugar/shell/emulator.py

Find this piece of code:

    cmd = [ 'Xephyr' ]
    cmd.append(':%d' % display)
    cmd.append('-ac')

     if gtk.gdk.screen_width() < 1200 or gtk.gdk.screen_height() < 900:
         cmd.append('-fullscreen')
     else:
         cmd.append('-screen')
         cmd.append('%dx%d' % (1200, 900))

Comment out the if and else instructions, and specify the screen resolution and mode you want (it's important to delete 4 spaces before the "cmd.append" lines):

    cmd = [ 'Xephyr' ]
    cmd.append(':%d' % display)
    cmd.append('-ac')

#    if gtk.gdk.screen_width() < 1200 or gtk.gdk.screen_height() < 900:
#        cmd.append('-fullscreen')
#    else:
    cmd.append('-screen')
    cmd.append('%dx%d' % (800, 600))

Sugar will now run on a 800x600 window. This file may be replaced next time you update sugar-jhbuild, and you'll have to do this again. Also note that 800x600 is not an optimal resolution for the window, because the activity circle will be vertically off center. 1024x768 is a more useable resolution.

Other commands

JHBuild has several other commands that can be useful for development. You can get an overview with:

./sugar-jhbuild --help-commands

A useful sequence of commands for building Sugar, from the Sugar mailing list: (Note that build will update first anyway, so run update separately if you want to see what changed more easily.)

./sugar-jhbuild update
./sugar-jhbuild build
./sugar-jhbuild run

If update and build don't work

In May 2008 there were some changes that broke updates on sugar-jhbuild. A version from before this date cannot update or build after this date; the symptoms are various, but generally include errors which mention the "build-scripts" directory. You need to rebuild from scratch in a new jhbuild directory. Something like the following:

cd ..
mv sugar-jhbuild sugar-jhbuild.old
git-clone git://dev.laptop.org/sugar-jhbuild

then, to save bandwidth, move the tar files from your old version:

mkdir sugar-jhbuild/source
mv sugar-jhbuild.old/source/*.tar* sugar-jhbuild/source

then build:

cd sugar-jhbuild
./sugar-jhbuild build

You may then also see some new dependencies; see the relevant instructions above.

From within Sugar

Once you have Sugar running, here are some useful commands:

  • Alt+Shift+F makes the frame appear and disappear
  • Ctrl-Q quits an activity
  • Alt+Shift+Q quits Sugar
  • Alt+Shift+O opens the search
  • Alt+Shift+R rotates the screen

Creating an xsession for Sugar-jhbuild

Create the file /usr/share/xsessions/sugar-jhbuild.desktop with the following content:

[Desktop Entry]
Encoding=UTF-8
Name=Sugar jhbuild
GenericName=Sugar
Exec=/usr/bin/sugar-jhbuild
Type=Application

Create the file /usr/bin/sugar-jhbuild with the following content:

#!/bin/sh
export GTK2_RC_FILES=/home/walter/sugar-jhbuild/install/share/sugar/data/sugar-xo.gtkrc
exec /home/walter/sugar-jhbuild/sugar-jhbuild run dbus-launch /home/walter/sugar-jhbuild/install/bin/sugar-shell

where you substitute the path of wherever you installed sugar-jhbuild for "/home/walter"

Customize

To customize the build create a configuration file, named .sugar.jhbuildrc, in your home directory.

Write access to the repositories

If you have write access to the repositories you can add this (if your login name happens to be marco):

repos['gnome.org'] = ':ext:marco@cvs.gnome.org:/cvs/gnome'
repos['mozilla.org'] = ':ext:marco%gnome.org@cvs.mozilla.org:/cvsroot'
repos['dev.laptop.org'] = 'git+ssh://marco@dev.laptop.org/git/'
repos['dev.laptop.org/projects'] = 'git+ssh://marco@dev.laptop.org/git/projects/'

Useful Internal Links

External links