diff --git a/doc/src/linux-mobile/creator-deployment-madde.qdoc b/doc/src/linux-mobile/creator-deployment-madde.qdoc new file mode 100644 index 00000000000..f41c65fac46 --- /dev/null +++ b/doc/src/linux-mobile/creator-deployment-madde.qdoc @@ -0,0 +1,97 @@ +/**************************************************************************** +** +** This file is part of Qt Creator +** +** Copyright (c) 2011 Nokia Corporation and/or its subsidiary(-ies). +** +** Contact: Nokia Corporation (info@qt.nokia.com) +** +** +** GNU Free Documentation License +** +** Alternatively, this file may be used under the terms of the GNU Free +** Documentation License version 1.3 as published by the Free Software +** Foundation and appearing in the file included in the packaging of this +** file. +** +** If you have questions regarding the use of this file, please contact +** Nokia at info@qt.nokia.com. +** +****************************************************************************/ + +// ********************************************************************** +// NOTE: the sections are not ordered by their logical order to avoid +// reshuffling the file each time the index order changes (i.e., often). +// Run the fixnavi.pl script to adjust the links to the index order. +// ********************************************************************** + +/*! + \contentspage index.html + \previouspage creator-deployment-symbian.html + \page creator-deployment-maemo.html + \nextpage creator-publishing-to-maemo-extras.html + + \title Deploying Applications to Maemo or MeeGo Harmattan Devices + + You can specify settings for deploying applications to Maemo 5 and MeeGo + Harmattan 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 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 red text to edit it and add the missing information. + + 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, \QC 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{Maemo5} or \gui Harmattan target, + \QC generates a Debian installation package in the build directory by + default. You can deliver the installation package to users for installation + on 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 {Package name} + field in the \gui {Create Package} step. You can change the version number + in the \gui {Package version} field. + + You can specify information that users see on a delivery channel, such as + Ovi Store or Maemo.org. 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 {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 \QC automates this process for you. + + \QC provides templates for a set of files that must be included in Debian + packages. When you create a \gui Maemo5 or \gui Harmattan target for a + project, \QC 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. + +*/ diff --git a/doc/src/linux-mobile/creator-madde-emulator.qdoc b/doc/src/linux-mobile/creator-madde-emulator.qdoc new file mode 100644 index 00000000000..aac7a3ec31b --- /dev/null +++ b/doc/src/linux-mobile/creator-madde-emulator.qdoc @@ -0,0 +1,190 @@ +/**************************************************************************** +** +** This file is part of Qt Creator +** +** Copyright (c) 2011 Nokia Corporation and/or its subsidiary(-ies). +** +** Contact: Nokia Corporation (info@qt.nokia.com) +** +** +** GNU Free Documentation License +** +** Alternatively, this file may be used under the terms of the GNU Free +** Documentation License version 1.3 as published by the Free Software +** Foundation and appearing in the file included in the packaging of this +** file. +** +** If you have questions regarding the use of this file, please contact +** Nokia at info@qt.nokia.com. +** +****************************************************************************/ + +// ********************************************************************** +// NOTE: the sections are not ordered by their logical order to avoid +// reshuffling the file each time the index order changes (i.e., often). +// Run the fixnavi.pl script to adjust the links to the index order. +// ********************************************************************** + +/*! + \contentspage index.html + \previouspage creator-editor-external.html + \page creator-maemo-emulator.html + \nextpage creator-mime-types.html + + \title Using Maemo or MeeGo Harmattan Emulator + + The Maemo 5 (Fremantle) and MeeGo Harmattan emulator are installed as part + of the \QSDK. After they are installed, you can start them from \QC. + + 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.3 + (V20.2010.36-2). + + The MeeGo Harmattan emulator emulates the Nokia N9 device environment. + + With the emulators, you can test how your application reacts to hardware + controls, such as the power button, and to the touch screen. + + To test the application UI, user interaction with the application, and + functionality that uses the mobility APIs, use the Qt Simulator, + instead. For more information, see the + \l{http://doc.qt.nokia.com/qtsimulator/index.html}{Qt Simulator Manual}. + + The difference between Qt Simulator and the emulators is that when you + compile your application binary for Qt Simulator, it is compiled against a + host library. The binary run on the emulator is compiled for the actual + device, using the Maemo 5 or Harmattan tool chain. + + \section1 Starting the Emulator + + The \gui {Start MeeGo Emulator} button is visible if you have a project + open in \QC for which you have added the Maemo or MeeGo Harmattan + build target. It starts the Maemo or MeeGo Harmattan emulator, depending + on the selected target. + + To start the emulator, click + \inlineimage qtcreator-maemo-emulator-button.png "Start MeeGo Emulator button" + . + + Test your application on the emulator as on a device. For a list of + keyboard shortcuts that you can use to emulate keys and functions, see + \l {Emulating Device Keys}. + + \section1 Rendering Graphics + + The emulators support OpenGL to improve graphics rendering. Hardware + acceleration produces better results than software rendering. By default, + \QC 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 emulator crashes, you are asked whether you want to try software + rendering, instead. + + To specify the OpenGL mode, select \gui {Tools > Options > Linux Devices + > Maemo Qemu Settings}. + + \section1 Emulating Device Keys + + The following table summarizes the keyboard shortcuts that you can use + to emulate device keys and functions. + + \table + \header + \o Device Key + \o Keyboard Shortcut + \row + \o \list + \o Alphabet keys + \o Comma (,) + \o Period (.) + \o Space + \o Arrow keys + \o Enter + \o Backspace + \endlist + \o Respective keys on the development PC keyboard. + \row + \o Shift + \o Left Shift key (Maemo 5) + + Shift (Harmattan) + \row + \o Ctrl + \o Left Ctrl key (Maemo 5) + + Ctrl (Harmattan) + \row + \o Mode + \o Left Alt key (Maemo 5) + + Alt (Harmattan) + \row + \o Power + \o Esc + \row + \o Keypad slider open and close + \o F1 + \row + \o Keypad lock (Maemo 5 only) + \o F2 + \row + \o Camera lens open and close (Maemo 5 only) + \o F3 + \row + \o Camera focus + \o F4 + \row + \o Camera take picture + \o F5 + + \note The actual camera functionality is not emulated. + \row + \o Stereo headphones connect and disconnect (Maemo 5 only) + \o F6 + \row + \o Volume down + \o F7 + \row + \o Volume up + \o F8 + \row + \o Accelerometer x axis, negative + \o 1 + \row + \o Accelerometer x axis, positive + \o 2 + \row + \o Accelerometer z axis, negative + \o 4 + \row + \o Accelerometer z axis, positive + \o 5 + \row + \o Accelerometer y axis, negative + \o 7 + \row + \o Accelerometer y axis, positive + \o 8 + + \endtable + + \note Each press of the accelerometer key turns the acceleration by 50 + percent. + + \section1 Closing the Emulator + + To close the emulator, click the X at the top right corner of the device + emulator view. The emulator interprets this as a press of the power button + and displays the text \e {Shutting down} in the emulator window title pane. + The emulator closes shortly after this. + + You can also select the \gui {Start MeeGo Emulator} button to close the + emulator. This is a faster way to close the emulator, because it does not + wait for the operating system running on the emulated machine to shut down, + but this also means that it is less safe. + +*/ diff --git a/doc/src/linux-mobile/creator-projects-running-generic-linux.qdocinc b/doc/src/linux-mobile/creator-projects-running-generic-linux.qdocinc new file mode 100644 index 00000000000..3d5ff214a77 --- /dev/null +++ b/doc/src/linux-mobile/creator-projects-running-generic-linux.qdocinc @@ -0,0 +1,35 @@ + \section1 Running on Generic Linux Devices + + \list 1 + + \o Build and run the application for \l{Running on Qt Simulator} + {Qt Simulator}. + + \o Build and run the application for a device: + + \list 1 + + \o Specify a connection to the device. For more information, see + \l{Connecting Generic Linux Devices}. + + \o Click the \gui Run button. + + \endlist + + \endlist + + \QC uses the compiler specified in the project build settings + (tool chain) to build the application. + + \QC generates an installation package, installs it on the + device, and executes the selected application. The application views are + displayed on the device. Command-line output is visible in the \QC + \gui {Application Output} view. + + Choose \gui {Projects > Desktop > Run} to view the settings for deploying + the application on the connected device and creating the installation + package. For more information, see + \l{Specifying Run Settings for Generic Linux Devices}. + + Debugging works transparently if GDB server is installed on the device and + it is compatible with the GDB on the host. diff --git a/doc/src/linux-mobile/creator-projects-running-madde.qdocinc b/doc/src/linux-mobile/creator-projects-running-madde.qdocinc new file mode 100644 index 00000000000..947f5d7274e --- /dev/null +++ b/doc/src/linux-mobile/creator-projects-running-madde.qdocinc @@ -0,0 +1,41 @@ + \section1 Running on Maemo or MeeGo Harmattan + + \list 1 + + \o Build and run the application for \l{Running on Qt Simulator} + {Qt Simulator}. + + \o Build and run the application for + \l{Using Maemo or MeeGo Harmattan Emulator} + {the Maemo or MeeGo Harmattan emulator}. + + \o Alternatively, you can build and run the application for a device: + + \list 1 + + \o Configure the device and specify a connection to it. For more + information, see \l{Connecting Maemo Devices} and + \l{Connecting MeeGo Harmattan Devices}. + + \o Connect the device to the development PC. + + \o Click the \gui Run button. + + \endlist + + \endlist + + \QC uses the compiler specified in the MADDE tool chain to build the + application. + + \QC generates an installation package, installs it on the device, and + executes the selected application. The application views are displayed on + the device. Command-line output is visible in the \QC + \gui {Application Output} view. + + Choose \gui Projects > Maemo Run} to view the settings for deploying the + application on the connected device and creating the installation package. + For more information, see + \l{Specifying Run Settings for Maemo and MeeGo Harmattan Devices}. + + Debugging also works transparently. diff --git a/doc/src/linux-mobile/creator-projects-settings-run-generic-linux.qdocinc b/doc/src/linux-mobile/creator-projects-settings-run-generic-linux.qdocinc new file mode 100644 index 00000000000..dd4903b7360 --- /dev/null +++ b/doc/src/linux-mobile/creator-projects-settings-run-generic-linux.qdocinc @@ -0,0 +1,17 @@ + \section2 Specifying Run Settings for Generic Linux Devices + + To run an application on a generic Linux device (without MADDE support), + create and select a device configuration in the Desktop run settings for + your project. You can also pass command line arguments to your application. + + \image qtcreator-run-settings-linux-devices.png "Run settings for Generic Linux devices" + + In addition, you must create a connection from the development PC to the + device. Click \gui {Manage device configurations} to create connections. + For more information, see \l {Connecting Generic Linux Devices}. + + When you run the application on the \gui Desktop target, \QC + generates an installation package in the build directory. The name of the + directory is displayed in the \gui {Create tarball} step. \QC copies + the tarball to devices by using the SSH file transfer protocol (SFTP) and + extracts it. diff --git a/doc/src/linux-mobile/creator-projects-settings-run-madde.qdocinc b/doc/src/linux-mobile/creator-projects-settings-run-madde.qdocinc new file mode 100644 index 00000000000..31e6753de9a --- /dev/null +++ b/doc/src/linux-mobile/creator-projects-settings-run-madde.qdocinc @@ -0,0 +1,21 @@ + \section2 Specifying Run Settings for Maemo and MeeGo Harmattan Devices + + To run an application on a Maemo or MeeGo Harmattan device, create and + select a device configuration in the Maemo 5 or Harmattan run settings for + your project. + You can also pass command line arguments to your application. + + \image qtcreator-screenshot-run-settings-maemo.png "Run settings for Maemo devices" + + To run and debug applications on Maemo or MeeGo Harmattan 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 to Maemo Devices} and + \l{Configuring Connections to Harmattan Devices}. + + When you run the application on the \gui{Maemo5} or \gui Harmattan target, + \QC generates a Debian installation package in the build directory by + default. You can deliver the installation package to users for installation + on 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 or MeeGo Harmattan Devices}. diff --git a/doc/src/linux-mobile/creator-publish-maemo-extras-devel.qdoc b/doc/src/linux-mobile/creator-publish-maemo-extras-devel.qdoc new file mode 100644 index 00000000000..2c622fd311c --- /dev/null +++ b/doc/src/linux-mobile/creator-publish-maemo-extras-devel.qdoc @@ -0,0 +1,92 @@ +/**************************************************************************** +** +** This file is part of Qt Creator +** +** Copyright (c) 2011 Nokia Corporation and/or its subsidiary(-ies). +** +** Contact: Nokia Corporation (info@qt.nokia.com) +** +** +** GNU Free Documentation License +** +** Alternatively, this file may be used under the terms of the GNU Free +** Documentation License version 1.3 as published by the Free Software +** Foundation and appearing in the file included in the packaging of this +** file. +** +** If you have questions regarding the use of this file, please contact +** Nokia at info@qt.nokia.com. +** +****************************************************************************/ + +// ********************************************************************** +// NOTE: the sections are not ordered by their logical order to avoid +// reshuffling the file each time the index order changes (i.e., often). +// Run the fixnavi.pl script to adjust the links to the index order. +// ********************************************************************** + +/*! + \contentspage index.html + \previouspage creator-deployment-maemo.html + \page creator-publishing-to-maemo-extras.html + \nextpage creator-publish-ovi.html + + \title Publishing Maemo Applications to Extras-devel + + Extras is the primary repository for Maemo applications where most + community software can be found. You can browse the applications available + in Extras at \l{http://maemo.org/downloads/Maemo5/}{Maemo Downloads}. + + You can publish both free and commercial applications to Extras. Free + applications must be open source and pass through a QA process. + Commercial applications are usually closed, binary only, and the publisher + is responsible for assuring their quality and security. + + You can upload free applications as Debian packages to + \l{http://wiki.maemo.org/Extras-devel}{Extras-devel} at Maemo.org to share + new updates to your application and to start the community QA process. + You need a \l{https://garage.maemo.org/}{Garage} account for the uploads, + but the package itself does not need to be hosted in the Garage. + + You can use the \gui {Publish for Fremantle Extras-devel Free Repository} + wizard to create a source archive and, optionally, upload it to a build + server for compiling and packaging. The package is then moved to the + Extras-devel repository. From there on, you must follow the standard + Maemo processes to get the application published to Extras. + + The wizard checks that the package contains all the information that is + required to publish applications on Extras: package description and + Package Manager icon. For more information about entering this information, + see \l{Creating Debian Installation Packages}. + + To use the publishing wizard: + + \list 1 + + \o Select the \gui {Maemo5} build target for your project. + + \o Choose \gui {Build > Publish Project}. + + \o Select \gui {Publish for Fremantle Extras-devel Free Repository}, + and then select \gui {Start Wizard}. + + \o Select the Qt version and device type to build against and click + \gui Next. + + To create a source archive without uploading it to the build + server, select the \gui {Only create source package, do not upload} + check box. + + \o In the \gui {Garage account name} field, enter your login name, or + select \gui {Get an account} to create a new account. + + \image qtcreator-publish-maemo-extras.png "Upload Settings dialog" + + You can also select \gui {Request upload rights} to use the Maemo + Extras Assistant to validate your Garage account. + + \o Select \gui Commit to publish the application. + + \endlist + +*/ diff --git a/doc/src/linux-mobile/creator-publish-ovi-maemo.qdoc b/doc/src/linux-mobile/creator-publish-ovi-maemo.qdoc new file mode 100644 index 00000000000..df9713d6c7f --- /dev/null +++ b/doc/src/linux-mobile/creator-publish-ovi-maemo.qdoc @@ -0,0 +1,71 @@ +/**************************************************************************** +** +** This file is part of Qt Creator +** +** Copyright (c) 2011 Nokia Corporation and/or its subsidiary(-ies). +** +** Contact: Nokia Corporation (info@qt.nokia.com) +** +** +** GNU Free Documentation License +** +** Alternatively, this file may be used under the terms of the GNU Free +** Documentation License version 1.3 as published by the Free Software +** Foundation and appearing in the file included in the packaging of this +** file. +** +** If you have questions regarding the use of this file, please contact +** Nokia at info@qt.nokia.com. +** +****************************************************************************/ + +// ********************************************************************** +// NOTE: the sections are not ordered by their logical order to avoid +// reshuffling the file each time the index order changes (i.e., often). +// Run the fixnavi.pl script to adjust the links to the index order. +// ********************************************************************** + +/*! + \contentspage index.html + \previouspage creator-publish-ovi-symbian.html + \page creator-publish-ovi-maemo.html + \nextpage creator-publish-ovi-meego.html + + \title Publishing Qt Content for Maemo Devices + + The applications that you publish on Ovi Store, must meet the testing + criteria listed in + \l{http://www.developer.nokia.com/info/sw.nokia.com/id/9cd1eb18-821b-4228-a0a3-36b049c5d608/Maemo_5_Application_OVI_Store_Entry_Requirements.pdf.html} + {Maemo 5 Applications: Ovi Store Entry Requirements}. + + Make sure that your application passes the following most commonly + failed test cases: + + \list + + \o Package filename must include the application name and version + number using three digits. For example: myapplication_1_0_1.deb + + \o Application files must be installed to the opt folder on the ext3 + partition. + + \o Debian packages must be given the category user/hidden. + + \o Application cannot crash or hang during use. + + \o The application must handle different memory situations correctly. + + \endlist + + You set the application name and installation folder in the + \gui {Run Settings} for the project. For more information, see + \l{Deploying Applications to Maemo or MeeGo Harmattan Devices}. \QC + specifies the correct category settings by default when it creates the + Debian directory and the necessary files. + + You can test the application on Qt Simulator and Maemo emulator to make + sure that it does not crash or hang and to check how it handles different + memory situations. Before you submit the application to Ovi Publishing, you + must also fully test it on a Maemo device. + +*/ diff --git a/doc/src/linux-mobile/creator-publish-ovi-meego.qdoc b/doc/src/linux-mobile/creator-publish-ovi-meego.qdoc new file mode 100644 index 00000000000..6a235e92952 --- /dev/null +++ b/doc/src/linux-mobile/creator-publish-ovi-meego.qdoc @@ -0,0 +1,44 @@ +/**************************************************************************** +** +** This file is part of Qt Creator +** +** Copyright (c) 2011 Nokia Corporation and/or its subsidiary(-ies). +** +** Contact: Nokia Corporation (info@qt.nokia.com) +** +** +** GNU Free Documentation License +** +** Alternatively, this file may be used under the terms of the GNU Free +** Documentation License version 1.3 as published by the Free Software +** Foundation and appearing in the file included in the packaging of this +** file. +** +** If you have questions regarding the use of this file, please contact +** Nokia at info@qt.nokia.com. +** +****************************************************************************/ + +// ********************************************************************** +// NOTE: the sections are not ordered by their logical order to avoid +// reshuffling the file each time the index order changes (i.e., often). +// Run the fixnavi.pl script to adjust the links to the index order. +// ********************************************************************** + +/*! + \contentspage index.html + \previouspage creator-publish-ovi-maemo.html + \page creator-publish-ovi-meego.html + \nextpage creator-remote-compiler.html + + \title Publishing Qt Content for MeeGo Harmattan Devices + + You cannot publish applications that are built with the beta version of the + MeeGo Harmattan tool chain to Ovi Store. + + However, you can prepare for publishing by making sure that your application + meets the + \l{http://www.developer.nokia.com/info/sw.nokia.com/id/44affcd1-ceba-4aca-8b65-670ce2cbbd1e/MeeGo_1_2_Harmattan_Applications_Ovi_Store_Entry_Requirements.html} + {MeeGo 1.2 Harmattan Applications: Ovi Store Entry Requirements}. + +*/ diff --git a/doc/linuxdev-keys.qdocinc b/doc/src/linux-mobile/linuxdev-keys.qdocinc similarity index 57% rename from doc/linuxdev-keys.qdocinc rename to doc/src/linux-mobile/linuxdev-keys.qdocinc index 29d9e077abb..d904d91fc78 100644 --- a/doc/linuxdev-keys.qdocinc +++ b/doc/src/linux-mobile/linuxdev-keys.qdocinc @@ -1,23 +1,23 @@ \section2 Generating SSH Keys If you do not have an SSH public and private key pair, you can generate it - in Qt Creator. You can specify key length and the key algorithm, RSA or DSA. + in \QC. You can specify key length and the key algorithm, RSA or DSA. If you only use the keys to protect connections to the emulator or device, you can use the default values. \list 1 - \o Select \gui {Tools > Options... > Linux Devices > Device - Configurations > Generate SSH Key...}. + \o Select \gui {Tools > Options > Linux Devices > Device + Configurations > Generate SSH Key}. \o Click \gui {Generate SSH Key}. \image qtcreator-ssh-key-configuration.png "SSH Key Configuration dialog" - \o Click \gui {Save Public Key...} to select the location to save the + \o Click \gui {Save Public Key} to select the location to save the public key. - \o Click \gui {Save Private Key...} to specify the location to save the + \o Click \gui {Save Private Key} to specify the location to save the private key. \o Click \gui Close to close the dialog. diff --git a/doc/linuxdev-processes.qdocinc b/doc/src/linux-mobile/linuxdev-processes.qdocinc similarity index 78% rename from doc/linuxdev-processes.qdocinc rename to doc/src/linux-mobile/linuxdev-processes.qdocinc index 387dbc308e1..856040efd15 100644 --- a/doc/linuxdev-processes.qdocinc +++ b/doc/src/linux-mobile/linuxdev-processes.qdocinc @@ -1,8 +1,8 @@ \section2 Managing Device Processes You can view processes running on devices and kill them. Select - \gui {Tools > Options... > Linux Devices > Device Configurations > - Remote Processes...}. + \gui {Tools > Options > Linux Devices > Device Configurations > + Remote Processes}. You can filter the processes by name in the \gui {List of Remote Processes} dialog. diff --git a/doc/linuxdev.qdoc b/doc/src/linux-mobile/linuxdev.qdoc similarity index 82% rename from doc/linuxdev.qdoc rename to doc/src/linux-mobile/linuxdev.qdoc index 8a0eea50541..66c654767b9 100644 --- a/doc/linuxdev.qdoc +++ b/doc/src/linux-mobile/linuxdev.qdoc @@ -29,35 +29,35 @@ \title Connecting Generic Linux Devices You can connect generic Linux devices to the development PC to build, run, - debug, and analyze applications on them from Qt Creator. + debug, and analyze applications on them from \QC. If you have the tool chain for building applications for generic Linux devices (with no MADDE support) installed on the development PC, you can add - it to Qt Creator. + it to \QC. To be able to run and debug applications on generic Linux devices, you must - create device configurations and select them in the Qt Creator run + create device configurations and select them in the \QC run settings. You use a wizard to create the connections. You can edit the settings later - in \gui {Tools > Options... > Linux Devices > Device Configurations}. + in \gui {Tools > Options > Linux Devices > Device Configurations}. \image qtcreator-linux-device-configurations.png "Device Configurations dialog" - You can protect the connections between Qt Creator and a device by using + You can protect the connections between \QC and a device by using either a password or an SSH key. If you do not have an SSH key, you can - create it in Qt Creator. For more information, see \l {Generating SSH Keys}. + create it in \QC. For more information, see \l {Generating SSH Keys}. - To configure connections between Qt Creator and generic Linux devices: + To configure connections between \QC and generic Linux devices: \list 1 \o Make sure that your device can be reached via an IP address. - \o Select \gui {Tools > Options... > Qt4 > Add} to add the Qt version + \o Select \gui {Tools > Options > Qt4 > Add} to add the Qt version for the generic Linux. - \o Select \gui {Tools > Options... > Tool Chains > Add} to add the tool + \o Select \gui {Tools > Options > Tool Chains > Add} to add the tool chain for building the applications. \o To deploy applications and run them remotely on devices, specify @@ -65,7 +65,7 @@ \list 1 - \o Select \gui {Tools > Options... > Linux Devices > Device + \o Select \gui {Tools > Options > Linux Devices > Device Configurations > Add > Generic Linux Device}. \image qtcreator-screenshot-devconf-linux.png "Connection Data wizard" @@ -117,12 +117,12 @@ \endlist - When you run the project, Qt Creator creates an installation package in + When you run the project, \QC creates an installation package in the build directory. The name of the directory is displayed in the \gui {Create tarball} step. The \gui {Deploy tarball via SFTP upload using device} step specifies - that Qt Creator uploads the tarball to the device and extracts it. + that \QC uploads the tarball to the device and extracts it. You can add custom deploy steps and remove the default step if it is incompatible with your steps. To only create a tarball and not copy the files to the device, diff --git a/doc/src/linux-mobile/madde-emulator-overview.qdocinc b/doc/src/linux-mobile/madde-emulator-overview.qdocinc new file mode 100644 index 00000000000..570446803b1 --- /dev/null +++ b/doc/src/linux-mobile/madde-emulator-overview.qdocinc @@ -0,0 +1,16 @@ + \section2 Maemo and MeeGo Harmattan Emulator + + The Maemo 5 (Fremantle) and MeeGo Harmattan emulator are installed as part + of the \QSDK. After they are installed, you can start them from \QC. + + 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.3 + (V20.2010.36-2). + + The Harmattan emulator emulates the Nokia N9 device environment. + + With the emulators, you can test how your application reacts to hardware + controls, such as the power button, and to the touch screen. Usually, + it is faster to test on a real device connected to the development PC than + to use the emulators. diff --git a/doc/maemodev.qdoc b/doc/src/linux-mobile/maemodev.qdoc similarity index 94% rename from doc/maemodev.qdoc rename to doc/src/linux-mobile/maemodev.qdoc index 4fe2a79c9e7..fb5fe07bfa1 100644 --- a/doc/maemodev.qdoc +++ b/doc/src/linux-mobile/maemodev.qdoc @@ -78,7 +78,7 @@ \endlist - \note The only supported build system for Maemo 5 in Qt Creator is qmake. + \note The only supported build system for Maemo 5 in \QC is qmake. \section1 Setting Up Connectivity in Maemo Devices @@ -140,7 +140,7 @@ \o Select \gui{Developer Password} to generate a password for a freshly created user called \bold developer. The password stays valid for as long as the password generation dialog is open. You enter the password when - you configure the connection in Qt Creator. + you configure the connection in \QC. \image qtcreator-mad-developer-screenshot.png \endlist @@ -223,12 +223,12 @@ To be able to run and debug applications on the Maemo emulator and devices, you must set up connections to the emulator and - devices in the Qt Creator build and run settings. If you install \QSDK, the + devices in the \QC build and run settings. If you install \QSDK, the connection to the emulator is configured automatically and you only need to configure a connection to the device. You use a wizard to create the connections. You can edit the settings later - in \gui {Tools > Options... > Linux Devices > Device Configurations}. + in \gui {Tools > Options > Linux Devices > Device Configurations}. \image qtcreator-maemo-device-configurations.png "Maemo Device Configurations dialog" @@ -236,7 +236,7 @@ protects real user data on the device from getting corrupted during testing. If you write applications that use Qt Mobility APIs, you might want to test them with real user data. To create a connection as a user, specify - the \gui Username and \gui Password in Qt Creator. For more information, see + the \gui Username and \gui Password in \QC. For more information, see \if defined(qcmanual) \l{Testing with User Data on Maemo Devices}. \else @@ -245,12 +245,12 @@ \endif - You can protect the connections between Qt Creator and + You can protect the connections between \QC and a device by using either a password or an SSH key. If you use a password, you - must generate it in the connectivity tool and enter it in Qt Creator every time + must generate it in the connectivity tool and enter it in \QC every time you start the connectivity tool. - If you do not have an SSH key, you can create it in Qt Creator. + If you do not have an SSH key, you can create it in \QC. Encrypted keys are not supported. For more information, see \if defined(qcmanual) @@ -271,7 +271,7 @@ \endif - To configure connections between Qt Creator and a + To configure connections between \QC and a device: \list 1 @@ -288,7 +288,7 @@ \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 > Options... > Linux Devices > Device + \o Select \gui {Tools > Options > Linux Devices > Device Configurations > Add}, and add a new configuration for a hardware device. @@ -324,7 +324,7 @@ \list a - \o In Qt Creator, select \gui {Tools > Options... > Linux + \o In \QC, select \gui {Tools > Options > Linux Devices > Device Configurations > Add} to add a new configuration. @@ -392,7 +392,7 @@ \o To specify the password, enter the following command: \c{/usr/lib/mad-developer/devrootsh passwd user} - \o In Qt Creator, select \gui {Tools > Options... Linux Devices > + \o In \QC, select \gui {Tools > Options Linux Devices > Device Configurations}. \o Specify the username \c user and the password in the device @@ -411,7 +411,7 @@ \header \o IP Address and Network on Device \o USB Network on Development PC - \o Host Name in Qt Creator Build Settings + \o Host Name in \QC Build Settings \row \o 172.30.7.15 255.255.255.0 diff --git a/doc/meegodev.qdoc b/doc/src/linux-mobile/meegodev.qdoc similarity index 93% rename from doc/meegodev.qdoc rename to doc/src/linux-mobile/meegodev.qdoc index 79ee3360bbc..bbfe39c4634 100644 --- a/doc/meegodev.qdoc +++ b/doc/src/linux-mobile/meegodev.qdoc @@ -51,10 +51,10 @@ \note \QSDK does not contain the tool chains for building applications for other MeeGo devices than MeeGo Harmattan. You can try to run applications - from Qt Creator on other MeeGo devices, but it has not been extensively + from \QC on other MeeGo devices, but it has not been extensively tested, and the instructions might not always apply. - \note The only supported build system for Harmattan in Qt Creator is qmake. + \note The only supported build system for Harmattan in \QC is qmake. \section1 Setting Up Connectivity in Harmattan Devices @@ -105,7 +105,7 @@ \gui {Connectivity Details} displays the IP address and developer password. The address 192.168.2.15 is used by default. You must enter the password in - Qt Creator. For more information, see + \QC. For more information, see \l{Configuring Connections to Harmattan Devices}. \section1 Setting Up Network Connectivity on Development PC @@ -235,13 +235,13 @@ \section1 Configuring Connections to Harmattan Devices To be able to run and debug applications on the emulator and devices, you - must set up connections to the emulator and devices in the Qt Creator build + must set up connections to the emulator and devices in the \QC build and run settings. If you install \QSDK, the connection to the emulator is configured automatically and you only need to configure a connection to the device. You use a wizard to create the connections. You can edit the settings later - in \gui {Tools > Options... > Linux Devices > Device Configurations}. + in \gui {Tools > Options > Linux Devices > Device Configurations}. \image qtcreator-meego-device-configurations.png "MeeGo Device Configurations dialog" @@ -249,7 +249,7 @@ protects real user data on the device from getting corrupted during testing. If you write applications that use Qt Mobility APIs, you might want to test them with real user data. To create a connection as a user, specify the - \gui Username and \gui Password in Qt Creator. For more information, see + \gui Username and \gui Password in \QC. For more information, see \if defined(qcmanual) \l{Testing with User Data on MeeGo Devices}. \else @@ -258,12 +258,12 @@ \endif - You can protect the connections between Qt Creator and a device by using + You can protect the connections between \QC and a device by using either a password or an SSH key. If you use a password, you must generate it - in the connectivity tool and enter it in Qt Creator every time you start the + in the connectivity tool and enter it in \QC every time you start the connectivity tool. - If you do not have an SSH key, you can create it in Qt Creator. Encrypted + If you do not have an SSH key, you can create it in \QC. Encrypted keys are not supported. For more information, see \if defined(qcmanual) \l{Generating SSH Keys}. @@ -283,7 +283,7 @@ \endif - To configure connections between Qt Creator and a device: + To configure connections between \QC and a device: \list 1 @@ -300,7 +300,7 @@ port issue, switch to a different port or use WLAN to connect to the device. - \o Select \gui {Tools > Options... > Linux Devices > Device + \o Select \gui {Tools > Options > Linux Devices > Device Configurations > Add}, and add a new configuration for a hardware device. @@ -338,7 +338,7 @@ \list a - \o In Qt Creator, select \gui {Tools > Options... > Linux + \o In \QC, select \gui {Tools > Options > Linux Devices > Device Configurations > Add} to add a new configuration. @@ -410,7 +410,7 @@ \o To specify the password, enter the following command: \c{/usr/lib/mad-developer/devrootsh passwd user} - \o In Qt Creator, select \gui {Tools > Options... Linux Devices > + \o In \QC, select \gui {Tools > Options Linux Devices > Device Configurations}. \o Specify the username \c user and the password in the device @@ -418,8 +418,8 @@ \endlist - \input linuxdev-keys.qdocinc - \input linuxdev-processes.qdocinc + \input linux-mobile/linuxdev-keys.qdocinc + \input linux-mobile/linuxdev-processes.qdocinc \endif @@ -434,7 +434,7 @@ \header \o IP Address and Network on Device \o USB Network on Development PC - \o Host Name in Qt Creator Build Settings + \o Host Name in \QC Build Settings \row \o 172.30.7.15 255.255.255.0