Editing Packaging a Qt application

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.
Latest revision Your text
Line 1: Line 1:
-
{{main|Packaging}}
+
= Packaging a Qt application for Maemo=
 +
== Finding your package in debian ==
 +
If you want to port a Qt package to Maemo, you should check and see if it is already packaged for debian and use that package if you can - this will save you time and effort. You can search in debian's [http://www.debian.org/distrib/packages Package Tracking System (PTS)] to see if it is there. There is a search system on the PTS page, under the "distribution" drop-down, select 'any', this will search throughout debian's repositories to find the package. Debian has more than 20,000 packages just in its stable distribution so your application is likely already packaged.
-
Packaging a Qt application for Maemo is very similar to packaging any other application, so this document only contains information on Qt-specific packaging issues.
+
If you find the package already exists in debian, you can get the source, including the packaging source, with apt-get. To do this, you'll have to edit your /etc/apt/sources.list, you can follow this recipe;
-
== Creating a Maemo package from a qmake project ==
+
<pre>
 +
$ echo “deb http://ftp.it.debian.org/debian/ unstable main contrib non-free” >> /etc/apt/source.list
 +
$ apt-get update
 +
$ apt-cache search "application name"
 +
$ apt-get source "application name"
 +
</pre>
 +
 
 +
''To learn more about the /etc/apt/sources.list you can do a 'man sources.list' if you are running debian or a debian based GNU/Linux distro.''
-
In order to create a new package for Maemo, from a qmake project, you will need to:
+
== Porting the debian package to a Maemo package ==
-
* Rename the source directory to <code>Package-Version</code> (for example myapp-0.1 for an application ‘myapp’ with a version of ‘0.1’)
+
If your application has been already packaged for debian, you can begin your maemo packaging with this section. Once you have the source of the debian package, you will need to make some modifications to that package for it to build under Maemo. For the complete Maemo Package Policy, use [http://maemo.org/forrest-images/pdf/maemo-policy.pdf this link] to a pdf.
-
* Create a ‘src’ directory in <code>Package-Version/</code>
+
-
* Copy all the files to the <code>src/</code> directory
+
-
* Rename <code>src/appname.pro</code> to <code>src/src.pro</code>
+
-
Please make sure that the directory name is <package-version> format and in small case letters.
+
 +
In order to create a new package for maemo, you'll need to:
 +
* Rename the upstream source directory in Package-Version (eg: myapp-0.1)
 +
* Create “src” directory in Package-Version/
 +
* Copy all the files in the src/
 +
* Rename src/appname.pro in src/src.pro
<pre>
<pre>
$mv myapp myapp-0.1
$mv myapp myapp-0.1
Line 20: Line 30:
</pre>
</pre>
-
Append the following chunk to end of your <code>src/src.pro</code>. The chunk adds an install section to your qmakefile   
+
Append the following chunk to end of your src/src.pro . The chunk adds install section to your qmakefile   
<pre>
<pre>
-
unix {
+
  unix {
-
  #VARIABLES
+
    #VARIABLES
-
  isEmpty(PREFIX) {
+
    isEmpty(PREFIX) {
-
    PREFIX = /usr
+
        PREFIX = /usr/local
   }
   }
-
  BINDIR = $$PREFIX/bin
+
BINDIR = $$PREFIX/bin
-
  DATADIR =$$PREFIX/share
+
DATADIR =$$PREFIX/share
-
  DEFINES += DATADIR=\\\"$$DATADIR\\\" PKGDATADIR=\\\"$$PKGDATADIR\\\"
+
DEFINES += DATADIR=\"$$DATADIR\" PKGDATADIR=\"$$PKGDATADIR\"
-
  #MAKE INSTALL
+
#MAKE INSTALL
-
  INSTALLS += target desktop service iconxpm icon26 icon48 icon64
+
INSTALLS += target desktop iconxpm icon26 icon40 icon64
   target.path =$$BINDIR
   target.path =$$BINDIR
Line 42: Line 52:
   desktop.files += $${TARGET}.desktop
   desktop.files += $${TARGET}.desktop
-
   service.path = $$DATADIR/dbus-1/services
+
   iconxpm.path = $$DATADIR/pixmap
-
   service.files += $${TARGET}.service
+
  iconxpm.files += ../data/maemo/$${TARGET}.xpm
 +
 
 +
   icon26.path = $$DATADIR/icons/hicolor/26x26/apps
 +
  icon26.files += ../data/26x26/$${TARGET}.png
 +
 
 +
  icon40.path = $$DATADIR/icons/hicolor/48x48/apps
 +
  icon40.files += ../data/48x48/$${TARGET}.png
   icon64.path = $$DATADIR/icons/hicolor/64x64/apps
   icon64.path = $$DATADIR/icons/hicolor/64x64/apps
Line 51: Line 67:
-
*Create a <code>myapp-0.1/myapp.pro</code> file like this:
+
*Create a myapp-0.1/myapp.pro file like this:
<pre>
<pre>
QMAKEVERSION = $$[QMAKE_VERSION]
QMAKEVERSION = $$[QMAKE_VERSION]
Line 70: Line 86:
dh_make --createorig --single -e maintainer@email.org -c gpl
dh_make --createorig --single -e maintainer@email.org -c gpl
</pre>
</pre>
 +
 +
== Having a look inside the debian/ dir ==
 +
At this point the directory my-app contains
 +
* the source directory ( src/ )
 +
* the debian directory (debian/)
 +
 +
Inside the debian dir we have the files needed for the creation of the debian package
 +
* Changelog  - Application's change log
 +
* Compat  - Debian helper compatibly version
 +
* Control - Describes the packages to be made
 +
* Copyright - Copyright text
 +
* Rules - A binary makefile containing the rules to build the package
 +
 +
== Maemo Packaging Policy ==
 +
Maemo packages follow the Debian Policy, but there are some items where Maemo:
 +
* Is more strict (it is an embedded distribution)
 +
* Is more relaxed
 +
**Only a target device (Nokia Internet Tablet)
 +
**Only a specified UI (Hildon)
 +
**Only one user.
 +
*Differs from Debian because Maemo has different:
 +
**Objectives
 +
**Maintainers
 +
**Infrastructure
 +
 +
==Editing the Control file ==
 +
Basically it specifies for each package (source or binary) a name, some dependencies, a description etc...
 +
For a Maemo package these fields are very important:
 +
* [http://wiki.maemo.org/Task:Package_categories#Translations Section]: Only the packages in the user segment are showed by App Installer.
 +
* Maintainer: This field MUST be changed if the upstream package is modified
 +
* XB-Maemo-Icon26: It contains the PNG icon encoded in base64 visible in the Application Installer
 +
 +
If you need to encode your icon as base64, there are [http://wiki.maemo.org/Maemo_packaging#Displaying_an_icon_in_the_Application_Manager_next_to_your_package instructions here.]
 +
 +
<pre>
 +
Source: my-application
 +
Section: user/valid_subsection
 +
Priority: optional
 +
Maintainer: name surname <xxxxxxx.xxxxxx@maemo.org>
 +
XSBC-Original-Maintainer: name surname <yyyyy.yyyyy@debian.org>
 +
Build-Depends: debhelper (>= 5), libqt4-dev, OTHERS_BUILD DEPENDECIES
 +
Standards-Version: 3.7.3
 +
 +
Package: my-application
 +
Architecture: any
 +
Depends: ${shlibs:Depends}, ${misc:Depends}
 +
Description: A simple test application
 +
A very simple application with a short description.
 +
Which spans multiple lines actually.
 +
XB-Maemo-Icon-26:
 +
iVBORw0KGgoAAAANSUhEUgAAABoAAAAaCAYAAACpSkzOAAAABmJLR0QA/wD/AP+g
 +
vaeTAAAACXBIWXMAAAsTAAALEwEAmpwYAAAAB3RJTUUH1gURDQoYya0JlwAAAU9J
 +
REFUSMftlL1KA0EUhb/NZl/ggnHQxsJUxt5CUucVJCCkDfgyKdIGG5/A0s5HEBtJ
 +
EdDAQGBgmw0YJmMzgXXYza5CtNkDW9zZw5z7c+ZCgwb/Ai3i9sVl/Bq8RIs4LRK1
 +
gJDsKvJyNXmJMuYTsMoY1zpgozaABdYArQNPZQ1kfyGU7SpqVwxzAMwABWhgpIwp
 +
4vWBB+AUWAI3ypjnfEXtPU4bLKx9vErTeCeiRSYF+fTn1j5dp2myE9EiU+DSi3wX
 +
ymeqRQAmZ3EcA5E/fgO6BULT8zhOcrwXoJdrXRa2Lgps2y2odAUcBUIXQdz78YyC
 +
SldAp8b7+bXrIv91qjZBietqCc2DjbAt4b2WxJkyZljVujlwp0U0cPxuLcAIuC+4
 +
dKxFlsDJarvdAGP/b6hFnDImYs+uG3hbO2AB3Jbsur63tQM+fFx3bzZocEB8AdV2
 +
gJBZgKTwAAAAAElFTkSuQmCC
 +
 +
Package: my-application-dbg
 +
Section: devel
 +
Architecture: any
 +
Depends: my-application (= ${binary:Version})
 +
Description: Debug symbols for a simple test application
 +
Debug symbols for a very simple application, which allow
 +
tracing and debugging.
 +
</pre>
 +
 +
Valid subsections are:
 +
* accessories
 +
* communication
 +
* games
 +
* multimedia
 +
* office
 +
* other
 +
* programming
 +
* support
 +
* themes
 +
* tools
== Editing the rules file ==
== Editing the rules file ==
-
The rules file generated by <code>dh_make</code>, found in <code>debian/rules</code> will be modified in order to look like this one. We are using qmake, so there is no <code>configure</code> script to run. If you copy and paste the following file, notice the empty space at the beginning of the lines these are TAB characters, they are not multiple space characters. If you copy and paste the following chunk, you most propably get space's instead of tabs if this is true then the file will not work.
+
The rules file generated by dh_make will be modified in order to look like this one.
 +
We are using qmake, so we haven't a configure file to run.  
 +
If you cut-and-paste following file, notify that empty space beginning of lines it TAB characters, it is not multiple space characters. If you cut-and-paste  
 +
the following chunk, you most propably get spaces instead tabs and the file does not wok
<pre>
<pre>
Line 131: Line 231:
</pre>
</pre>
-
== Editing the control file ==
+
== Editing the Changelog file ==
-
The control file generated by <code>dh_make</code>, found in <code>debian/control</code> will be modified substantially. Please refer to the general packaging guide for Maemo for details.
+
It is the log of the changes for a specified application version. It's important file because it sets the binary/binaries and the source packages version and revision.
 +
If an upstream package is re-packaged or modified for maemo, the Maemo revision string should be appended to the upstream revision.
 +
So if in Debian the package name was something like "Myapp-0.4-2" in maemo this package will be called "Myapp-0.4-2maemo0".
 +
The number after the "maemo" string is a progressive number.
-
For Qt applications you need to make sure to add <code>libqt4-dev</code> as an additional entry in the field <code>Build-Depends</code>.
+
==  Application menu icon & position ==
 +
The Maemo application menu detects automatically an app that provides a .desktop file in /usr/share/application/hildon . If you don't have desktop file, create one in the src directory.
-
== Example ==
+
<pre>
-
You can download the [http://maemo.org/packages/view/qt-maemo-example/ source package of qt-maemo-example] from the [[extras-devel]] repository as follows, if you have source packages enabled in your <code>/etc/apt/sources.list</code> file:
+
[Desktop Entry]
 +
Encoding=UTF-8
 +
Version=0.1
 +
Type=Application
 +
Name=myapp
 +
Exec=/usr/bin/myapp
 +
Icon=myapp
 +
X-HildonDesk-ShowInToolbar=true
 +
X-Osso-Type=application/x-executable
 +
</pre>
-
  apt-get source qt-maemo-example
+
 
 +
Maemo menu structure is completely different from Debian:
 +
* An unmodified Debian package installs the proper .desktop in /usr/share/applications
 +
* Applications that use the debian menu are displayed in the extra menu
 +
 
 +
In order to show our application in the correct Maemo menu:
 +
* debian/myapp.install moves the .desktop file and icons in the right directory
 +
<pre>
 +
src/*.desktop usr/share/applications/hildon
 +
src/*.png usr/share/icons/hicolor/26x26/apps
 +
</pre>
 +
 
 +
* debian/postinst should call maemo-select-menu-location utility to permit the user to choose the menu location.  '''This works only in Diablo, it doesn't work in Fremantle.'''
 +
<pre>
 +
#!/bin/sh
 +
maemo-select-menu-location myapp.desktop
 +
</pre>
 +
 
 +
== Checking Maemo Packages ==
 +
Lintian dissects Debian packages and reports bugs and policy violations.
 +
It contains automated checks for many aspects of Debian policy as well as some checks for common errors.
 +
Unfortunately it doesn't check conformance to the additional Maemo policy.
 +
 
 +
Currently Maemo is creating [http://maemian.garage.maemo.org/ Maemian] to check its policy.
 +
 
 +
== Building the binary and the source package ==
 +
To build only binary package/s
 +
<pre>
 +
$dpkg-buildpackage -rfakeroot -b
 +
</pre>
 +
we can install these binary package with dpkg:
 +
<pre>
 +
$dpkg -i myapp.deb
 +
</pre>
 +
 
 +
To build the source package and to sign it with your gpg key (ABCDEF12)
 +
<pre>
 +
dpkg-buildpackage -rfakeroot -sa -S -kABCDEF12
 +
</pre>
 +
At this point, if you have tested your package and it works fine you can [http://wiki.maemo.org/Uploading_to_Extras upload it in extras/extras-devel].
 +
 
 +
= Example =
 +
You can download the source package of qt-maemo-example from the extras-devel repository just running if you have source packages enabled in your sources file;
 +
 
 +
''apt-get source qt-maemo-example''
This command will download the:
This command will download the:
-
* unmodified source (.orig.tar.gz)
+
- unmodified source (.orig.tar.gz)
-
* debian dsc file (.dsc)
+
 
-
* diff file (.diff)
+
- debian dsc file (.dsc)
 +
 
 +
- diff file (.diff)
 +
 
 +
and after it will launch automatically dpkg -x file.dsc in order to uncompress the orig.tar.gz and apply the changes.
 +
 
 +
= Useful Links =
 +
[http://qt4.garage.maemo.org Qt4Maemo at garage]
-
and will then automatically launch <code>dpkg -x file.dsc</code> in order to decompress the orig.tar.gz and apply the changes.
+
[http://standards.freedesktop.org/desktop-entry-spec/desktop-entry-spec-0.9.4.html Desktop entry spec 0.9.4]
-
== Useful Links ==
+
= Debhelper 7 =
 +
Debhelper 7 is not available in fremantle.
 +
Debian packages that requires level 7 needs some changes:
 +
eg:
 +
* debian/compat:  7 -> 5
 +
* debian/control: Build-Depends: debhelper (>= 7) -> debhelper (>= 5)
 +
* And maybe comment out a few dh_* calls from debian/rules, which might not exist on level 5
-
* [[Packaging Qt Creator Apps for Maemo Extras]]
+
Now things might get complex if the packaging already uses some new
-
* [[Qt-Maemo|Qt for Maemo]]
+
features of level 7, like those CDBS-like helper rules. In such cases,
-
* [[Packaging|Packaging guide for Maemo]]
+
looking at versions prior to the compatibility level upgrade might
-
* [http://doc.qt.nokia.com/qt-maemo-4.6/maemo5-with-qt-introduction.html#deploying-your-applications Deploying your Maemo 5 Qt application] Qt documentation
+
help doing the downgrade (and most Debian packages are kept in public
 +
SCMs like svn.debian.org).
-
[[Category:Packaging]]
+
[[Category:Development]]
[[Category:Qt]]
[[Category:Qt]]

Learn more about Contributing to the wiki.


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!


Cancel | Editing help (opens in new window)

Templates used on this page:

Retrieved from "http://wiki.maemo.org/Packaging_a_Qt_application"