diff --git a/doc/images/qtcreator-maemo-deb-package.png b/doc/images/qtcreator-maemo-deb-package.png index 4983314d2c8..e6ad5f5df25 100644 Binary files a/doc/images/qtcreator-maemo-deb-package.png and b/doc/images/qtcreator-maemo-deb-package.png differ diff --git a/doc/images/qtcreator-maemo-deployment.png b/doc/images/qtcreator-maemo-deployment.png index d9f51d22a63..ac3365fd166 100644 Binary files a/doc/images/qtcreator-maemo-deployment.png and b/doc/images/qtcreator-maemo-deployment.png differ diff --git a/doc/maemodev.qdoc b/doc/maemodev.qdoc index f7cacda898f..a16aa74c4eb 100644 --- a/doc/maemodev.qdoc +++ b/doc/maemodev.qdoc @@ -160,20 +160,15 @@ To develop applications that use the Qt Mobility APIs, you must install the APIs on the devices. The APIs are not available in the Nokia N900 package manager, and therefore, you must install them from the command line as the - root user. To become the root user you must first install \c rootsh from the - application manager. + root user: \list 1 - \o On the device, install \c rootsh from the \gui {Application Manager}. - - \o In \gui Programs, select \c {X Terminal} to open a terminal window. - - \o To switch to the root user, enter the following command: - \c{sudo gainroot} + \o On the device, in \gui Programs, select \c {X Terminal} to open a + terminal window. \o To install Qt Mobility libraries, enter the following command: - \c{apt-get install libqtm-*} + \c{/usr/lib/mad-developer/devrootsh apt-get install libqtm-*} \o To confirm the installation, enter: \c Y @@ -232,46 +227,6 @@ your version of Microsoft Windows you may have to unplug and re-plug the Nokia N900 to reload the driver with its configuration accordingly. - \if defined(qcmanual) - \section1 Setting Up MADDE - - If you install \QSDK, the MADDE package is installed and - configured automatically on your development PC and you can omit this task. - - \list 1 - - \o Download the MADDE installer file for your platform from the - \l{http://wiki.maemo.org/MADDE}{MADDE} site. - - \o Execute the installer and follow the instructions. - - \o To see which targets are available, run \c{mad-admin list targets}. - - \o To install the target that starts with the string \bold fremantle, use the command: - \c{mad-admin create fremantle-qt-xxx} - - \o In Qt Creator, register the MADDE tool chain: - - \image qtcreator-screenshot-toolchain.png - - \list a - - \o Select \gui Tools > \gui Options... > \gui Qt4 > \gui{Qt Versions}. - - \o Click \inlineimage qtcreator-windows-add.png, - to add a new Qt version. - - The \gui{qmake Location} is the qmake - executable in \c{/targets//bin}. - - \endlist - - \endlist - - When you have installed the target, you have a toolchain and a sysroot - environment for cross-compiling. - \endif - \section1 Configuring Connections in Qt Creator To be able to run and debug applications on the Maemo emulator and @@ -312,10 +267,8 @@ the Qt Creator Manual. \endif - \if defined(qcmanual) - - To configure connections between Qt Creator and the Maemo emulator or + To configure connections between Qt Creator and the Maemo device: \list 1 @@ -344,7 +297,7 @@ \o In the \gui {The system running on the device} field, select the software platform of the device. - \o In the \gui {The type of device} field, select + \o In the \gui {The kind of device} field, select \gui {Hardware device}. \o In the \gui {The device's host name or IP address} field, enter @@ -356,6 +309,8 @@ \endlist + \if defined(qcmanual) + \o To test applications on the Maemo emulator (QEMU) separately, you must create a connection to it from the development PC. If you installed \QSDK, the connection is created automatically and you can omit this @@ -375,7 +330,7 @@ \o In the \gui {The system running on the device} field, select the software platform to emulate. - \o In the \gui {The type of device} field, select + \o In the \gui {The kind of device} field, select \gui {Emulator (Qemu)}. \o Click \gui Next. @@ -384,6 +339,7 @@ connection. \endlist + \endif \o To specify build and run settings: @@ -394,7 +350,8 @@ \o Click \gui Projects to open the projects mode. - \o In the \gui{Build Settings} section, choose the MADDE Qt version. + \o In the \gui{Build Settings} section, choose the MADDE Qt version + that was registered by the installation program. \image qtcreator-screenshot-build-settings.png @@ -414,75 +371,6 @@ \endlist - \else - - The \QSDK installation program configured a default connection - to the Maemo emulator. - - \list 1 - - \o To deploy applications and run them remotely, specify parameters - for accessing devices: - - \list a - - \o Connect your device to the development PC via a USB cable or - a WLAN. For a USB connection, you are prompted to select the mode - to use. Choose \gui{PC suite mode}. - - \note If you experience connection problems due to a USB port issue, - switch to a different port or use WLAN to connect to the device. - - \o Select \gui Tools > \gui Options... > \gui Maemo > - \gui{Maemo Device Configurations > Add}, and add a new configuration for a - \gui {Remote device}. - - \image qtcreator-screenshot-devconf.png - - \o In the \gui {Host name} field, enter the IP address from the - \gui usb0 or \gui wlan0 field in Mad Developer. - - \o Specify the other settings in the same way as for a Maemo emulator - connection. - - \o Click \gui Test to test the connection. - - \o Click \gui OK to close the dialog. - - \endlist - - \o To specify build and run settings: - - \list a - - \o Open a project for an application you want to develop for your - Nokia N900. - - \o Click \gui Projects to open the projects mode. - - \o In the \gui{Build Settings} section, choose the MADDE Qt version - that was registered by the installation program. - - \image qtcreator-screenshot-build-settings.png - - \o In the \gui{Run Settings} section, click \gui Add to add a new - run configuration. - - \o Set a name and select the device configuration. - - \image qtcreator-screenshot-run-settings.png - - \note You can either add separate run settings for both the Maemo - emulator connection and the device connection or select the - \gui {Device configuration} before you run the application. - - \o Click the \gui Run button to build and run the application. - - \endlist - - \endlist - \endif - \if defined(qcmanual) \section2 Testing with User Data @@ -495,11 +383,8 @@ \o On the device, in \gui Programs, select \c {X Terminal} to open a terminal window. - \o To switch to the root user, enter the following command: - \c{sudo gainroot} - \o To specify the password, enter the following command: - \c {passwd user} + \c{/usr/lib/mad-developer/devrootsh passwd user} \o In Qt Creator, Select \gui Tools > \gui Options... > \gui Maemo > \gui{Maemo Device Configurations}. diff --git a/doc/qtcreator.qdoc b/doc/qtcreator.qdoc index 802f7824d0b..9eca55cd5b3 100644 --- a/doc/qtcreator.qdoc +++ b/doc/qtcreator.qdoc @@ -433,14 +433,14 @@ \section2 Maemo Emulator - The Maemo emulator emulates the Nokia N900 device environment. You can test + The Maemo 5 emulator emulates the Nokia N900 device environment. You can test applications in conditions practically identical to running the application - on a Nokia N900 device with the software update release 1.2 (V10.2010.19-1). + on a Nokia N900 device with the software update release 1.3 (V20.2010.36-2). However, it is faster to test on a real device connected to the development PC. The Maemo Emulator is installed as part of the \QSDK. After it is - installed and configured, you can start it from Qt Creator. + installed, you can start it from Qt Creator. \section1 Deploying @@ -4254,7 +4254,7 @@ \section2 Specifying Run Settings for Symbian Devices Qt Creator automatically detects Symbian devices that are connected to - the development PC with an USB cable. + the development PC with a USB cable. If only one device is detected, the application is deployed to it and run on it. If multiple devices are connected to the PC, make sure that the correct device is selected in the @@ -4285,10 +4285,21 @@ a device configuration in the Maemo run settings for your project. You can also pass command line arguments to your application. - \image qtcreator-screenshot-run-settings.png "Run settings for Maemo devices" + \image qtcreator-screenshot-run-settings-maemo.png "Run settings for Maemo devices" + + To run and debug applications on Maemo devices, you must create connections + from the development PC to the devices. Click \gui {Manage device + configurations} to create connections. For more information, see + \l {Configuring Connections in Qt Creator}. + + By default, Qt Creator runs the remote gdbserver daemon on the device for + debugging. However, if the sysroot does not match that of the device, you + can run remote gdb, instead. Select the \gui {Run remote gdb} option in + \gui {Debugging details}. Select the \gui {Set debugger} link to specify + settings for gdb. When you run the application on the \gui{Maemo} target, Qt Creator generates - a debian installation package in the build directory by default. You can deliver + a Debian installation package in the build directory by default. You can deliver the installation package to users for installation on Maemo devices that are of the same type and run the same firmware as the connected device. For more information, see \l{Deploying Applications to Maemo Devices}. @@ -4354,42 +4365,63 @@ You can specify settings for deploying applications to Maemo devices in the project .pro file. You can view the settings in the \gui {Run Settings}. + \image qtcreator-maemo-deployment.png "Deploy to device" + The files to be installed are listed in the - \gui {Deploy to Device} step, the \gui {Files to install} field. The + \gui {Deploy to Device} step, the \gui {Files to install for subproject} + field. The \gui {Local File Path} field displays the location of the file on the development PC. The \gui {Remote Directory} field displays the folder where the file is installed on the device. + Text in red color indicates that the information is missing. Select the + text to edit it and add the missing information. - \image qtcreator-maemo-deployment.png "Deploy to device" + You can use desktop files to display icons on the home screen of the + device. To add desktop files to the project file, select \gui {Add Desktop + File}. To specify the icon file to display, select \gui {Add Launcher + Icon...}. To remove desktop files and icons, delete the definitions from + the project file. - If you develop your own libraries, Qt Creator needs to be able to access them - during compilation. When you install MADDE, an instance of the device file + If you develop your own libraries, Qt Creator needs to be able to find + them when you compile projects depending on them. When you install MADDE, + an instance of the device file system, called sysroot, is installed to the development PC. Libraries are copied to sysroot if the \gui {Also deploy to sysroot} check box is selected. \section1 Creating Debian Installation Packages When you run the application on the \gui{Maemo} target, Qt Creator generates - a debian installation package in the build directory by default. You can deliver + a Debian installation package in the build directory by default. You can deliver the installation package to users for installation on Maemo devices that are of the same type and run the same firmware as the connected device. \image qtcreator-maemo-deb-package.png "Create installation package" - The name of the installation package is displayed in the \gui {Create Package} - field in the \gui {Run Settings}. You can change the version number in the \gui {Version number} field. + The name of the installation package is displayed in the \gui {Package name} + field in the \gui {Create Package} step. You can change the version number + in the \gui {Package version} field. - Qt Creator provides templates for a set of files that must be included - in debian packages. To edit the files, select a file in \gui {Adapt debian - file} and click \gui Edit. The file opens in the text editor. + You can specify information that users see on a delivery channel, such as + Ovi Store. You can specify a short description of the application, package + name, and application icon. - The debian control file contains an application icon in encoded form. To add the - application icon to the file, select it in the \gui {Package manager icon} field. + The Debian control file contains an application icon in encoded form. To add the + application icon to the file, select it in the \gui {Icon to be displayed + in Package Manager} field. For more information about icon files and adding them manually, see \l{ http://wiki.maemo.org/Packaging#Displaying_an_icon_in_the_Application_Manager_next_to_your_package}{Displaying an icon in the Application Manager next to your package}. \note Qt Creator automates this process for you. + Qt Creator provides templates for a set of files that must be included + in Debian packages. When you create a Maemo target for a project, Qt Creator + asks whether packaging files are to be added to the project and to version + control. If you plan to edit the packaging files, add them to version + control. + + To edit the files, select a file in \gui {Adapt Debian + file} and click \gui Edit. The file opens in the text editor. + */ @@ -5087,7 +5119,7 @@ \o mainwindow.cpp \o mainwindow.ui \o mainwindow.h - \o templates for debian deployment files + \o templates for Debian deployment files \endlist @@ -5210,7 +5242,7 @@ You also need to test the application on real devices. Before you can start testing on Symbian devices, you must connect them to the development - PC by using an USB cable and install the necessary software on them. + PC by using a USB cable and install the necessary software on them. \list 1 @@ -5230,7 +5262,7 @@ The Maemo emulator emulates the Nokia N900 device environment. You can test applications in conditions practically identical to running the application - on a Nokia N900 device with the software update release 1.2 (V10.2010.19-1). + on a Nokia N900 device with the software update release 1.3 (V20.2010.36-2). For more information, see \l{Using the Maemo Emulator}. @@ -6801,6 +6833,7 @@ of Qt Creator, respectively), which is freely available for download from the \l{http://msdn.microsoft.com/en-us/default.aspx} + {Microsoft Developer Network}. The Qt Creator help browser does not allow you to download files, and therefore, you must copy the above links to a browser. @@ -8917,9 +8950,9 @@ \title Using the Maemo Emulator - The Maemo emulator emulates the Nokia N900 device environment. You can test + The Maemo 5 emulator emulates the Nokia N900 device environment. You can test applications in conditions practically identical to running the application - on a Nokia N900 device with software update release 1.2 (V10.2010.19-1). + on a Nokia N900 device with software update release 1.3 (V20.2010.36-2). You can test user interaction by using the keypad and touch emulation. @@ -8928,7 +8961,7 @@ instead. For more information, see the \l{http://doc.qt.nokia.com/qtsimulator/index.html}{Qt Simulator Manual}. - The Maemo emulator is installed and configured as part of the \QSDK + The Maemo 5 emulator is installed and configured as part of the \QSDK package. You can also install and configure the MADDE environment and Maemo emulator separately. For more information, see \l{Setting Up Development Environment for Maemo}. @@ -8936,34 +8969,32 @@ \section1 Starting the Maemo Emulator The \gui {Start Maemo Emulator} button is visible if you have a project - open in Qt Creator for which you have added the Maemo build target - and if you have configured a connection between Qt Creator and the Maemo - Emulator. + open in Qt Creator for which you have added the Maemo build target. - To start the Maemo emulator: - - \list 1 - - \o Click + To start the Maemo emulator, click \inlineimage qtcreator-maemo-emulator-button.png "Start Maemo Emulator button" . - \o Select \gui {Mad Developer} on the Maemo emulator, to start the Mad Developer - application - - \o If you have not deployed an SSH key to protect the connection between - Qt Creator and the Maemo emulator, select \gui {Developer Password} to generate - a password. - - \o In Qt Creator, enter the password in the connection settings: - \gui {Tools > Options... > Projects > Maemo Device Configurations}. - - \endlist - Test your application on the Maemo emulator as on a device. For a list of keyboard shortcuts that you can use to emulate Nokia N900 keys and functions, see \l {Emulating Nokia N900 Keys}. + \section1 Rendering Graphics + + The Maemo emulator supports OpenGL to improve graphics rendering. Hardware + acceleration produces better results than software rendering. By default, + Qt Creator automatically detects, whether hardware acceleration is + supported on the development PC and tries to use it. However, sometimes + the results of the automatic detection are not reliable, and + hardware acceleration might be selected even if it is actually not + available on the development PC. This causes the emulator to crash. + + If the Maemo emulator crashes, you are asked whether you want to try + software rendering, instead. + + To specify the OpenGL mode, select \gui {Tools > Options... > Maemo > Qemu + Settings}. + \section1 Emulating Nokia N900 Keys The following table summarizes the keyboard shortcuts that you can use