Editing PyMaemo/How to build

Warning: You are not logged in. Your IP address will be recorded in this page's edit history.

The edit can be undone. Please check the comparison below to verify that this is what you want to do, and then save the changes below to finish undoing the edit.

Learn more about Contributing to the wiki.

<b style="color: red">DRAFT</b>

= How to build PyMaemo packages=

== Introduction ==

To build PyMaemo packages from the source, you'll need:

* Maemo 5 SDK 
* Rootstraps for X86 and ARMEL targets
* grep-dctrl
* pymaemo-tools

The scripts from pymaemo-tools are used to download packages' sources and build them using sbdmock, one at a time. sbdmock, in turn, uses the SDK and the rootstraps to create a clean environment for building every package. More information about sbdmock can be obtained [[Building_packages_with_sbdmock|here]], although pymaemo-tools uses a slightly modified of sbdmock - see pymaemo-tools README if you want to know which modifications were made.

The build scripts from pymaemo-tools can be used to build the entire set of packages or only some of them, for X86 or ARMEL targets. It is advised to first build and (if possible) test in the X86 target and use ARMEL target only for cross-compiling for the device.

== Overview of the build process ==

The build process is composed of three phases: download, preparation and the proper build. A high-level description of the process follows:

* Download phase:
** If the package is originally from Debian or Ubuntu:
*** The original source is taken from upstream;
*** The Debian packaging for Maemo is taken from the respective repository in PyMaemo project.
** If the package is Maemo-specific:
*** The source package is taken from the respective repository in PyMaemo project
* Preparation phase:
** If the package is taken from upstream, assemble package
** Verify if dependencies are satisfied
* Build phase:
** Call sbdmock with proper parameters

== Configuration ==

The base directory for these instructions, refered as $BASE, is /scratchbox/users/<user>/home/<user>/pymaemo, 
where <user> is your username in Scratchbox. All operations are made '''outside''' Scratchbox.

First, download the rootstraps for X86 and ARMEL targets and put them in $BASE/rootstraps:

* http://repository.maemo.org/stable/5.0/armel/maemo-sdk-rootstrap_5.0_armel.tgz
* http://repository.maemo.org/stable/5.0/i386/maemo-sdk-rootstrap_5.0_i386.tgz

Clone the pymaemo-tools project inside $BASE:

$ git clone [git repo]

This will create the directory pymaemo-tools under $BASE.

Edit the fremantle_i386.cfg and fremantle_armel.cfg under $BASE/pymaemo-tools/sbdmock,
putting the rootstrap path correspondent to each in the following key:
* i386: config_opts['rootstrap'] = "$BASE/rootstraps/maemo-sdk-rootstrap_5.0_i386.tgz"
* armel: config_opts['rootstrap'] = "$BASE/rootstraps/maemo-sdk-rootstrap_5.0_armel.tgz"

== Building ==

For building all the packages for the X86 target, enter $BASE/pymaemo-tools and run:

$ ./build_packages.sh sbdmock:fremantle_i386 packages_fremantle.ini

The same can be done to ARMEL target, just replacing "i386" with "armel". The file packages_fremantle.ini contains all data necessary for obtaining the sources.

You can build individual packages too, specifying them as parameters. If you want to build only, let's say, pyopenssl and pycurl for the ARMEL target, run:

$ ./build_packages.sh sbdmock:fremantle_armel packages_fremantle.ini pyopenssl,pycurl

Be advised that any PyMaemo dependency for these packages must be built first, as build_packages.sh will attempt to build only the packages provided at the command line.

There are other options for the build; for more information, run build_packages.sh 
with no parameters or refer to the README file inside pymaemo-tools.

When the build finishes the resultant Debian packages will be placed at 
$BASE/pymaemo-tools/workdir/fremantle_<target>/repo, where <target> is i386 or armel,and the build logs placed in $BASE/pymaemo-tools/workdir/fremantle_<target>/logs.
From that point on, they can be installed on the targets and the ARMEL ones
can be copied to the device to be installed there.

=== Directories created ===

* $BASE/pymaemo-tools/download_cache: all downloaded files are placed here, one directory by package, so you don't have to download everything again in every build. If the sources are updated, though, you will have to erase the corresponding entries on download_cache for allow them to be downloaded again.
* $BASE/pymaemo-tools/workdir: the generated files (prepared sources, logs, built packages) are placed under this directory, grouped by the name of the sbdmock config file used to build them. Inside each group, the logs and repo directories will contain, respectively, the build logs and the built packages.

== Customization ==

If you want to roll out your own packages or modify the existing ones, the sections below will provide some directions.

=== Adding your own packages to the build ===

If you want to add your own package to the build process, you just have to edit one simple file, packages-fremantle.ini. Just add an entry at the end of the file depending on how your package is organized.

* If all the contents of your package are contained in a single SVN or GIT repository, you have a "native" package. If you're using SVN, the lines below are enough:

[new-package]
 svn_url=https://svnrepository.com/new-package/trunk
 native=yes

If you're using git, just change "svn_url" to "git_url" and use the appropriate repository address (git://...). Note also that the flag "native=yes" must be present. Just change "new-package" to a string identifying your package and you're set.

* If your package has Debian or Ubuntu as upstream and only the packaging is specific for Maemo, you'll have to specify the location of all the files needed in addition to the repository where the packaging is located. See below an example for pyclutter:

[pyclutter]
 source_url=http://ftp.de.debian.org/debian/pool/main/p/pyclutter/pyclutter_0.8.0.orig.tar.gz
 diff_url=http://ftp.de.debian.org/debian/pool/main/p/pyclutter/pyclutter_0.8.0-1.diff.gz
 dsc_url=http://ftp.de.debian.org/debian/pool/main/p/pyclutter/pyclutter_0.8.0-1.dsc
 svn_url=https://garage.maemo.org/svn/pymaemo/packages/pyclutter/trunk/debian

In this example the source, .diff.gz and .dsc files are taken from Debian, and the Maemo-specific packaging is taken from the (former) PyMaemo repository. pymaemo-tools will assemble the package prior to build, as explained in the Overview section.

=== Modifying PyMaemo packages ===

The PyMaemo packages are all in Gitorious now, allowing easy customization of any package you desire. The high-level steps for the process are listed below.

* Create a clone of the the repository at Gitorious for the package you want to modify, and git-clone it;
* Modify the packages-fremantle.ini repository section of the package to point to the repository you just cloned;
** Use the full path to the directory you cloned in git_url
* Modify the package at will, and then build it using the same command tools - pymaemo-tools will use your local repository for building;
** Erase the prepared files of your package from $BASE/workdir prior to the building proper;
* When you are satisfied with the results, push your local changes to your Gitorious clone, and file a merge request.

As said before, there are two types of packages: native and taken from upstream.  If you want to modify a native package, you can do anything you want, as the entire package is contained in the repository. However, if the package is taken from upstream, the only changes you can make will be located in the Maemo packaging - you'll have to use patches to actually modify any upstream file in build time.

== Tips ==

=== Create Debian repository with one line ===

If you want to quickly make a Debian repository for easy installation, 
run the following command at $BASE/pymaemo-tools/workdir/fremantle_<target>/repo:

$ apt-ftparchive packages . | gzip -9c > Packages.gz

Now you have to expose the packages' path to the Web server and add the repository
in the target machine accordingly.

=== Tracking build in real time ===

If you want to accompany the build log of any package in real time, you can just use the tail command in the following log files:

* Prep and setup: 
 $ tail -F $BASE/workdir/fremantle_<target>/repo/root.log
* Build: 
 $ tail -F $BASE/workdir/fremantle_<target>/repo/build.log

Please note that all contributions to maemo.org wiki may be edited, altered, or removed by other contributors. If you do not want your writing to be edited mercilessly, then do not submit it here.
You are also promising us that you wrote this yourself, or copied it from a public domain or similar free resource (see maemo.org wiki:Copyrights for details). Do not submit copyrighted work without permission!

Summary:

Cancel | Editing help (opens in new window)

Retrieved from "http://wiki.maemo.org/PyMaemo/How_to_build"

Personal tools

Navigation

Views

Editing PyMaemo/How to build

@@ Line 1: / Line 1: @@
+<b style="color: red">DRAFT</b>
+= How to build PyMaemo packages=
+== Introduction ==
 To build PyMaemo packages from the source, you'll need:
 * Maemo 5 SDK
 * Rootstraps for X86 and ARMEL targets
-* pymaemo-tools and its dependencies (listed on the README file)
+* grep-dctrl
+* pymaemo-tools
 The scripts from pymaemo-tools are used to download packages' sources and build them using sbdmock, one at a time. sbdmock, in turn, uses the SDK and the rootstraps to create a clean environment for building every package. More information about sbdmock can be obtained [[Building_packages_with_sbdmock|here]], although pymaemo-tools uses a slightly modified of sbdmock - see pymaemo-tools README if you want to know which modifications were made.
@@ Line 37: / Line 44: @@
 Clone the pymaemo-tools project inside $BASE:
-  $ git clone git://gitorious.org/pymaemo/pymaemo-tools.git
+  $ git clone [git repo]
 This will create the directory pymaemo-tools under $BASE.
-Edit the <code>fremantle-i386.cfg</code> and <code>fremantle-arm.cfg</code> under $BASE/pymaemo-tools/sbdmock, putting the rootstrap path correspondent to each in the following key:
+Edit the fremantle_i386.cfg and fremantle_armel.cfg under $BASE/pymaemo-tools/sbdmock,
+putting the rootstrap path correspondent to each in the following key:
 * i386: config_opts['rootstrap'] = "$BASE/rootstraps/maemo-sdk-rootstrap_5.0_i386.tgz"
 * armel: config_opts['rootstrap'] = "$BASE/rootstraps/maemo-sdk-rootstrap_5.0_armel.tgz"
-If you do not use the default <code>FREMANTLE_ARMEL</code> and <code>FREMANTLE_X86</code> target names, you also need to change that on the .cfg files, in the <code>config_opts['sbtarget']</code> entry.
-You'll need the Nokia binaries repository for building some packages, just add the correspondent line to the config_opts['sources.list'] entry of the .cfg files:
- deb http://repository.maemo.org/ fremantle/<token> nokia-binaries
-As Maemo SDK needs some components from Nokia binaries repository, you probably already have a token in <code>/etc/apt/sources.list</code> inside Scratchbox. If you don't have a token, though, go to http://tablets-dev.nokia.com/eula/index.php and get one.
 == Building ==
@@ Line 57: / Line 57: @@
 For building all the packages for the X86 target, enter $BASE/pymaemo-tools and run:
-  $ ./build_packages.sh sbdmock:fremantle-i386 packages-fremantle.ini
+  $ ./build_packages.sh sbdmock:fremantle_i386 packages_fremantle.ini
-The same can be done to ARMEL target, just replacing "i386" with "arm". The file <code>packages_fremantle.ini</code> contains all data necessary for obtaining the sources.
+The same can be done to ARMEL target, just replacing "i386" with "armel". The file packages_fremantle.ini contains all data necessary for obtaining the sources.
 You can build individual packages too, specifying them as parameters. If you want to build only, let's say, pyopenssl and pycurl for the ARMEL target, run:
-  $ ./build_packages.sh sbdmock:fremantle-arm packages-fremantle.ini pyopenssl,pycurl
+  $ ./build_packages.sh sbdmock:fremantle_armel packages_fremantle.ini pyopenssl,pycurl
 Be advised that any PyMaemo dependency for these packages must be built first, as build_packages.sh will attempt to build only the packages provided at the command line.
-There are other options for the build; for more information, run build_packages.sh with no parameters or refer to the README file inside pymaemo-tools.
+There are other options for the build; for more information, run build_packages.sh
+with no parameters or refer to the README file inside pymaemo-tools.
-When the build finishes the resultant Debian packages will be placed at $BASE/pymaemo-tools/workdir/fremantle_<target>/repo, where <target> is i386 or armel,and the build logs placed in $BASE/pymaemo-tools/workdir/fremantle_<target>/logs. From that point on, they can be installed on the targets and the ARMEL ones can be copied to the device to be installed there.
+When the build finishes the resultant Debian packages will be placed at
+$BASE/pymaemo-tools/workdir/fremantle_<target>/repo, where <target> is i386 or armel,and the build logs placed in $BASE/pymaemo-tools/workdir/fremantle_<target>/logs.
+From that point on, they can be installed on the targets and the ARMEL ones
+can be copied to the device to be installed there.
 === Directories created ===
-* $BASE/pymaemo-tools/download_cache: all downloaded files are placed here, one directory by package, so you don't have to download everything again at every build. If the sources are updated, though, you will have to erase the corresponding entries on ./download_cache and ./workdir for allow them to be downloaded again and rebuilt.
+* $BASE/pymaemo-tools/download_cache: all downloaded files are placed here, one directory by package, so you don't have to download everything again in every build. If the sources are updated, though, you will have to erase the corresponding entries on download_cache for allow them to be downloaded again.
 * $BASE/pymaemo-tools/workdir: the generated files (prepared sources, logs, built packages) are placed under this directory, grouped by the name of the sbdmock config file used to build them. Inside each group, the logs and repo directories will contain, respectively, the build logs and the built packages.
-== Adding your own packages to the build ==
+== Customization ==
-If you want to add your own package to the build process, you just have to edit one file, <code>packages-fremantle.ini</code>. Just add an entry at the end of the file depending on how your package is organized.
+If you want to roll out your own packages or modify the existing ones, the sections below will provide some directions.
-* If all the files of your package are contained in a single SVN or Git repository, you just have to point to this repository, as the example below for python-conic:
+=== Adding your own packages to the build ===
- [python-conic]
- git_url=git://gitorious.org/pymaemo/python-conic.git
-If you're using svn, just change "git_url" to "svn_url" and use the appropriate repository URL.
+If you want to add your own package to the build process, you just have to edit one simple file, packages-fremantle.ini. Just add an entry at the end of the file depending on how your package is organized.
-* If your package has Debian or Ubuntu as upstream and only the packaging is specific for Maemo, you'll have to specify the location of the original .dsc file from upstream. Below is an example for pyclutter:
+* If all the contents of your package are contained in a single SVN or GIT repository, you have a "native" package. If you're using SVN, the lines below are enough:
- [pyclutter]
- dsc_url=http://repository.maemo.org/extras-devel/pool/fremantle/free/source/p/pyclutter/pyclutter_0.8.0-1maemo3.dsc
- git_url=git://gitorious.org/pymaemo/pyclutter.git
-In this example the .dsc file is used to get the .orig.gz and diff.gz from Debian, and the Maemo-specific packaging is taken from the PyMaemo repository. pymaemo-tools will assemble the package prior to build, as explained in the Overview section.
+ [new-package]
+ svn_url=https://svnrepository.com/new-package/trunk
+ native=yes
-Also, if your package is native (does not have a .orig.gz file), you have to specify this below the repository address. See http://people.debian.org/~mpalmer/debian-mentors_FAQ.html for a discussion about native and non-native packages on Debian. Below is an example of a native package:
+If you're using git, just change "svn_url" to "git_url" and use the appropriate repository address (git://...). Note also that the flag "native=yes" must be present. Just change "new-package" to a string identifying your package and you're set.
-  [python-support]
+* If your package has Debian or Ubuntu as upstream and only the packaging is specific for Maemo, you'll have to specify the location of all the files needed in addition to the repository where the packaging is located. See below an example for pyclutter:
-  dsc_url=http://repository.maemo.org/extras-devel/pool/fremantle/free/source/p/python-support/python-support_1.0.4maemo1.dsc
-  git_url=git://gitorious.org/pymaemo/python-support.git
+  [pyclutter]
-  native=yes
+  source_url=http://ftp.de.debian.org/debian/pool/main/p/pyclutter/pyclutter_0.8.0.orig.tar.gz
+ diff_url=http://ftp.de.debian.org/debian/pool/main/p/pyclutter/pyclutter_0.8.0-1.diff.gz
+  dsc_url=http://ftp.de.debian.org/debian/pool/main/p/pyclutter/pyclutter_0.8.0-1.dsc
+  svn_url=https://garage.maemo.org/svn/pymaemo/packages/pyclutter/trunk/debian
+In this example the source, .diff.gz and .dsc files are taken from Debian, and the Maemo-specific packaging is taken from the (former) PyMaemo repository. pymaemo-tools will assemble the package prior to build, as explained in the Overview section.
-== Modifying PyMaemo packages ==
+=== Modifying PyMaemo packages ===
-The PyMaemo packages are in Gitorious now, allowing the submission of modifications for any of them via merge requests. An overview of the entire process is listed below:
+The PyMaemo packages are all in Gitorious now, allowing easy customization of any package you desire. The high-level steps for the process are listed below.
-# Create a clone of the repository at Gitorious for the package you want to modify, and git-clone it;
+* Create a clone of the the repository at Gitorious for the package you want to modify, and git-clone it;
-# Modify the <code>packages-fremantle.ini</code> entry of the package to point to the full path of the repository directory;
+* Modify the packages-fremantle.ini repository section of the package to point to the repository you just cloned;
-# Modify the package and run <code>build_packages.sh</code> to build it;
+** Use the full path to the directory you cloned in git_url
-## Don't forget to erase your package files from $BASE/download_cache, $BASE/workdir and $BASE/workdir/fremantle_<target>/repo before the build;
+* Modify the package at will, and then build it using the same command tools - pymaemo-tools will use your local repository for building;
-# Install on Scratchbox and on the device, if possible, and run all available unit tests for the package - needless to say, your modifications must not introduce regressions of any type;
+** Erase the prepared files of your package from $BASE/workdir prior to the building proper;
-# Add unit tests to assert the funcionality of the new features added, whenever possible;
+* When you are satisfied with the results, push your local changes to your Gitorious clone, and file a merge request.
-# When you are satisfied with the results, push your local changes to your Gitorious clone and file a merge request.
-If you want to modify a package that lives entirely on the Git repository, you can do anything you want, as all the files are under your control. However, if the package is taken from upstream, the only changes you can make will be located in the packaging - you'll have to use patches to actually modify any upstream file in build time.
+As said before, there are two types of packages: native and taken from upstream.  If you want to modify a native package, you can do anything you want, as the entire package is contained in the repository. However, if the package is taken from upstream, the only changes you can make will be located in the Maemo packaging - you'll have to use patches to actually modify any upstream file in build time.
 == Tips ==
-=== Create a Debian repository with one line ===
+=== Create Debian repository with one line ===
-If you want to quickly make a Debian repository for easy installation, run the following command at $BASE/pymaemo-tools/workdir/fremantle_<target>/repo:
+If you want to quickly make a Debian repository for easy installation,
+run the following command at $BASE/pymaemo-tools/workdir/fremantle_<target>/repo:
   $ apt-ftparchive packages . | gzip -9c > Packages.gz
-Now you have to expose the packages' path to the Web server and add the repository in the target machine accordingly.
+Now you have to expose the packages' path to the Web server and add the repository
+in the target machine accordingly.
 === Tracking build in real time ===
@@ Line 134: / Line 139: @@
 * Build:
   $ tail -F $BASE/workdir/fremantle_<target>/repo/build.log
-[[Category:Python]]