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.

Learn more about Contributing to the wiki.

= Packaging a Qt application for Maemo=

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.

== 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 upstream source directory to <code>Package-Version</code> (for example myapp-0.1 for an application myapp with a version of 0.1)
* Create “src” directory in Package-Version/
* Copy all the files to the <code>src/</code> directory
* Rename <code>src/appname.pro</code> to <code>src/src.pro</code>
<pre>
$mv myapp myapp-0.1
$cd myapp-0.1
$mkdir src
$cp * src
$mv src/appname.pro src/src.pro
</pre>

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/local
  }
BINDIR = $$PREFIX/bin
DATADIR =$$PREFIX/share

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

#MAKE INSTALL

INSTALLS += target desktop iconxpm icon26 icon48 icon64

target.path =$$BINDIR

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

iconxpm.path = $$DATADIR/pixmap
  iconxpm.files += ../data/maemo/$${TARGET}.xpm

icon26.path = $$DATADIR/icons/hicolor/26x26/apps
  icon26.files += ../data/26x26/$${TARGET}.png

icon48.path = $$DATADIR/icons/hicolor/48x48/apps
  icon48.files += ../data/48x48/$${TARGET}.png

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>
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
</pre>
*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)
<pre>
export DEBFULLNAME="maintainer first name and last name"
dh_make --createorig --single -e maintainer@email.org -c gpl
</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

== Editing the rules file ==
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>
#!/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
</pre>

== 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.

<pre>
[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>

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>

= 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:

- unmodified source (.orig.tar.gz)

- 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 =

* [[Qt-Maemo|Qt for Maemo]]
* [[Packaging|Packaging guide for Maemo]]
* [http://standards.freedesktop.org/desktop-entry-spec/desktop-entry-spec-latest.html Desktop entry specification]

= Debhelper 7 =

A backport of Debhelper 7 for fremantle is available in extras-devel.
It works transparently and can coexist with debhelper 5 in the SDK.
It even works on autobuilder, if you specify the correct build-dependency debhelper7.
Read the mails about [http://www.mail-archive.com/maemo-developers@maemo.org/msg23779.html debhelper7]
and [http://www.mail-archive.com/maemo-developers@maemo.org/msg23749.html cdbs-dh7].

Alternatively, you can try to use debhelper 5 in some cases:

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

Now things might get complex if the packaging already uses some new
features of level 7, like those CDBS-like helper rules. In such cases,
looking at versions prior to the compatibility level upgrade might
help doing the downgrade (and most Debian packages are kept in public
SCMs like svn.debian.org).

[[Category:Development]]
[[Category:Qt]]

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)

Templates used on this page:

Template:Main (view source) (protected)

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

Personal tools

Navigation

Views

Editing Packaging a Qt application

@@ Line 1: / Line 1: @@
+= Packaging a Qt application for Maemo=
 {{main|Packaging}}
@@ Line 6: / Line 8: @@
 In order to create a new package for Maemo, from a qmake project, you will need to:
-* Rename the source directory to <code>Package-Version</code> (for example myapp-0.1 for an application ‘myapp’ with a version of ‘0.1’)
+* Rename the upstream source directory to <code>Package-Version</code> (for example myapp-0.1 for an application myapp with a version of 0.1)
-* Create a ‘src’ directory in <code>Package-Version/</code>
+* Create “src” directory in Package-Version/
 * 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.
 <pre>
 $mv myapp myapp-0.1
@@ Line 23: / Line 23: @@
 <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 icon48 icon64
    target.path =$$BINDIR
@@ Line 42: / Line 42: @@
    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
+  icon48.path = $$DATADIR/icons/hicolor/48x48/apps
+  icon48.files += ../data/48x48/$${TARGET}.png
    icon64.path = $$DATADIR/icons/hicolor/64x64/apps
@@ Line 70: / Line 76: @@
 dh_make --createorig --single -e maintainer@email.org -c gpl
 </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
 == 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>
@@ Line 131: / Line 154: @@
 </pre>
-== Editing the control file ==
+== Application menu icon & position ==
-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.
+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.
-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>.
+<pre>
+[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>
-== Example ==
+Maemo menu structure is completely different from Debian:
-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:
+* An unmodified Debian package installs the proper .desktop in /usr/share/applications
+* Applications that use the debian menu are displayed in the extra menu
-  apt-get source qt-maemo-example
+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>
+= 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:
-* unmodified source (.orig.tar.gz)
+- unmodified source (.orig.tar.gz)
-* debian dsc file (.dsc)
-* diff file (.diff)
-and will then automatically launch <code>dpkg -x file.dsc</code> in order to decompress the orig.tar.gz and apply the changes.
+- debian dsc file (.dsc)
-== Useful Links ==
+- 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 =
-* [[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
+* [http://standards.freedesktop.org/desktop-entry-spec/desktop-entry-spec-latest.html Desktop entry specification]
+= Debhelper 7 =
+A backport of Debhelper 7 for fremantle is available in extras-devel.
+It works transparently and can coexist with debhelper 5 in the SDK.
+It even works on autobuilder, if you specify the correct build-dependency debhelper7.
+Read the mails about [http://www.mail-archive.com/maemo-developers@maemo.org/msg23779.html debhelper7]
+and [http://www.mail-archive.com/maemo-developers@maemo.org/msg23749.html cdbs-dh7].
+Alternatively, you can try to use debhelper 5 in some cases:
+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
+Now things might get complex if the packaging already uses some new
+features of level 7, like those CDBS-like helper rules. In such cases,
+looking at versions prior to the compatibility level upgrade might
+help doing the downgrade (and most Debian packages are kept in public
+SCMs like svn.debian.org).
-[[Category:Packaging]]
+[[Category:Development]]
 [[Category:Qt]]