Packaging a Qt application

(Packaging a Qt Application)
(Useful Links: add link)
 
(78 intermediate revisions not shown)
Line 1: Line 1:
-
= Packaging a Qt Application =
+
{{main|Packaging}}
-
== Looking for a debian package of your Application ==
+
 
-
If you want to port  a popular Qt application probably it is already packaged for debian.
+
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.
-
You can try to get the package source in a couple of different ways:
+
 
-
* Adding a debian src repository in your /etc/apt/source.list file
+
== 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
+
In order to create a new package for Maemo, from a qmake project, you will need to:
-
$apt-get update
+
* Rename the source directory to <code>Package-Version</code> (for example myapp-0.1 for an application ‘myapp’ with a version of ‘0.1’)
-
$apt-cache search app_name
+
* Create a ‘src’ directory in <code>Package-Version/</code>
-
$apt-get source app_name
+
* Copy all the files to the <code>src/</code> directory
-
</pre>
+
* Rename <code>src/appname.pro</code> to <code>src/src.pro</code>
-
* Checking http://packages.debian.org, downloading the following files and running ''dpkg-source -x app_name.dsc'' to decompress the upstream source and to apply the changes available in the diff.gz file.
+
Please make sure that the directory name is <package-version> format and in small case letters.
-
** upstream source file (.tar.gz)
+
-
** package changes    (.diff.gz)
+
-
** meta-data information file (.dsc)
+
-
== Creating a Debian package for a new Qt Application ==
 
-
If your application has been already packaged, you can jump this section.
 
-
If your application is quite younger and you need to package it by yourself,
 
-
in order to creating a new package, you 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 30: Line 19:
$mv src/appname.pro src/src.pro
$mv src/appname.pro src/src.pro
</pre>
</pre>
-
*Create a myapp-0.1/myapp.pro file like this:
+
 
 +
Append the following chunk to end of your <code>src/src.pro</code>. The chunk adds an install section to your qmakefile 
 +
 
 +
<pre>
 +
unix {
 +
  #VARIABLES
 +
  isEmpty(PREFIX) {
 +
    PREFIX = /usr
 +
  }
 +
  BINDIR = $$PREFIX/bin
 +
  DATADIR =$$PREFIX/share
 +
 
 +
  DEFINES += DATADIR=\\\"$$DATADIR\\\" PKGDATADIR=\\\"$$PKGDATADIR\\\"
 +
 
 +
  #MAKE INSTALL
 +
 
 +
  INSTALLS += target desktop service iconxpm icon26 icon48 icon64
 +
 
 +
  target.path =$$BINDIR
 +
 
 +
  desktop.path = $$DATADIR/applications/hildon
 +
  desktop.files += $${TARGET}.desktop
 +
 
 +
  service.path = $$DATADIR/dbus-1/services
 +
  service.files += $${TARGET}.service
 +
 
 +
  icon64.path = $$DATADIR/icons/hicolor/64x64/apps
 +
  icon64.files += ../data/64x64/$${TARGET}.png
 +
}
 +
</pre>
 +
 
 +
 
 +
*Create a <code>myapp-0.1/myapp.pro</code> file like this:
<pre>
<pre>
QMAKEVERSION = $$[QMAKE_VERSION]
QMAKEVERSION = $$[QMAKE_VERSION]
Line 46: Line 67:
**Some example files (*.EX *.ex)
**Some example files (*.EX *.ex)
<pre>
<pre>
 +
export DEBFULLNAME="maintainer first name and last name"
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 need 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 makefile containing the rules to build all kinds of packages
 
-
 
-
== 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 rules file ==
== Editing the rules file ==
-
The rules file generated by dh_make will be modified in order to look like this one.
+
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.
-
We are using qmake, so we haven't a configure file to run.  
+
<pre>
<pre>
Line 121: Line 118:
         dh_installman
         dh_installman
         dh_link
         dh_link
-
         dh_strip
+
         dh_strip --dbg-package=my-application-dbg
         dh_compress
         dh_compress
         dh_fixperms
         dh_fixperms
Line 134: Line 131:
</pre>
</pre>
-
==Editing the Control file ==
+
== Editing the control file ==
-
Basically it specifies for each package (source or binary) a name, some dependencies, a description etc...
+
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.
-
For a Maemo package these fields are very important:
+
-
* 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
+
-
<pre>
+
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>.
-
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
+
== Example ==
-
Architecture: any
+
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:
-
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
+
-
</pre>
+
-
Valid subsections are:
+
apt-get source qt-maemo-example
-
* Accessories
+
-
* Comunications
+
-
* Games
+
-
* Multimedia
+
-
* Office
+
-
* Other
+
-
* Programming
+
-
* Support
+
-
* Themes
+
-
* Tools
+
-
== Editing the Changelog file ==
+
This command will download the:
-
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.
+
-
==  Application menu icon & position ==
+
* unmodified source (.orig.tar.gz)
-
The Maemo application menu detects automatically an app that provides a .desktop file in /usr/share/application/hildon
+
* debian dsc file (.dsc)
-
Maemo menu structure is completely different from Debian:
+
* diff file (.diff)
-
* 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:
+
and will then automatically launch <code>dpkg -x file.dsc</code> in order to decompress the orig.tar.gz and apply the changes.
-
* 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.  
+
-
<pre>
+
-
#!/bin/bash
+
-
maemo-select-menu-location myapp.desktop
+
-
</pre>
+
-
= Useful Links =
+
== Useful Links ==
-
[http://qt4.garage.maemo.org Qt4Maemo at garage]
+
-
[http://doc.trolltech.com/4.4/index.html Official Qt 4.4 Documentation]  
+
* [[Packaging Qt Creator Apps for Maemo Extras]]
 +
* [[Qt-Maemo|Qt for Maemo]]
 +
* [[Packaging|Packaging guide for Maemo]]
 +
* [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
-
[[Category:Development]]
+
[[Category:Packaging]]
 +
[[Category:Qt]]

Latest revision as of 09:11, 4 November 2010

Main article: Packaging


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.

Contents

[edit] Creating a Maemo package from a qmake project

In order to create a new package for Maemo, from a qmake project, you will need to:

  • Rename the source directory to Package-Version (for example myapp-0.1 for an application ‘myapp’ with a version of ‘0.1’)
  • Create a ‘src’ directory in Package-Version/
  • Copy all the files to the src/ directory
  • Rename src/appname.pro to src/src.pro

Please make sure that the directory name is <package-version> format and in small case letters.

$mv myapp myapp-0.1
$cd myapp-0.1
$mkdir src
$cp * src
$mv src/appname.pro src/src.pro

Append the following chunk to end of your src/src.pro. The chunk adds an install section to your qmakefile

unix {
  #VARIABLES
  isEmpty(PREFIX) {
    PREFIX = /usr
  }
  BINDIR = $$PREFIX/bin
  DATADIR =$$PREFIX/share

  DEFINES += DATADIR=\\\"$$DATADIR\\\" PKGDATADIR=\\\"$$PKGDATADIR\\\"

  #MAKE INSTALL

  INSTALLS += target desktop service iconxpm icon26 icon48 icon64

  target.path =$$BINDIR

  desktop.path = $$DATADIR/applications/hildon
  desktop.files += $${TARGET}.desktop

  service.path = $$DATADIR/dbus-1/services
  service.files += $${TARGET}.service

  icon64.path = $$DATADIR/icons/hicolor/64x64/apps
  icon64.files += ../data/64x64/$${TARGET}.png
}


  • Create a myapp-0.1/myapp.pro file like this:
QMAKEVERSION = $$[QMAKE_VERSION]
ISQT4 = $$find(QMAKEVERSION, ^[2-9])
isEmpty( ISQT4 ) {
error("Use the qmake include with Qt4.4 or greater, on Debian that is qmake-qt4");
}

TEMPLATE = subdirs
SUBDIRS  = src
  • Run dh_make to debianize the source archive, it creates:
    • An archive with the unchanged upstream source (orig.tar.gz)
    • Some basic files in the debian directory
    • Some example files (*.EX *.ex)
export DEBFULLNAME="maintainer first name and last name"
dh_make --createorig --single -e maintainer@email.org -c gpl

[edit] Editing the rules file

The rules file generated by dh_make, found in debian/rules will be modified in order to look like this one. We are using qmake, so there is no configure 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.

#!/usr/bin/make -f
APPNAME := my_app_name
builddir:
        mkdir -p builddir

builddir/Makefile: builddir
        cd builddir && qmake-qt4 PREFIX=/usr ../$(APPNAME).pro

build: build-stamp

build-stamp: builddir/Makefile
        dh_testdir
        # Add here commands to compile the package.
        cd builddir && $(MAKE)
        touch $@

clean:
        dh_testdir
        dh_testroot
        rm -f build-stamp
        # Add here commands to clean up after the build process.
        rm -rf builddir
        dh_clean
install: build
        dh_testdir
        dh_testroot
        dh_clean -k
        dh_installdirs

        # Add here commands to install the package into debian/your_appname
        cd builddir && $(MAKE) INSTALL_ROOT=$(CURDIR)/debian/$(APPNAME) install
# Build architecture-independent files here.
binary-indep: build install
# We have nothing to do by default.

# Build architecture-dependent files here.
binary-arch: build install
        dh_testdir
        dh_testroot
        dh_installdocs
        dh_installexamples
        dh_installman
        dh_link
        dh_strip --dbg-package=my-application-dbg
        dh_compress
        dh_fixperms
        dh_installdeb
        dh_shlibdeps
        dh_gencontrol
        dh_md5sums
        dh_builddeb

binary: binary-indep binary-arch
.PHONY: build clean binary-indep binary-arch binary install configure

[edit] Editing the control file

The control file generated by dh_make, found in debian/control will be modified substantially. Please refer to the general packaging guide for Maemo for details.

For Qt applications you need to make sure to add libqt4-dev as an additional entry in the field Build-Depends.

[edit] Example

You can download the source package of qt-maemo-example from the extras-devel repository as follows, if you have source packages enabled in your /etc/apt/sources.list file:

apt-get source qt-maemo-example

This command will download the:

  • unmodified source (.orig.tar.gz)
  • debian dsc file (.dsc)
  • diff file (.diff)

and will then automatically launch dpkg -x file.dsc in order to decompress the orig.tar.gz and apply the changes.

[edit] Useful Links