Changeset 846 for trunk/doc/src/platforms/symbian-introduction.qdoc

Timestamp:

May 5, 2011, 5:36:53 AM (14 years ago)

Author:

Dmitry A. Kuminov

Message:

trunk: Merged in qt 4.7.2 sources from branches/vendor/nokia/qt.

Location:

trunk

Files:

• . (modified) (1 prop)
• doc/src/platforms/symbian-introduction.qdoc (modified) (14 diffs)

trunk/doc/src/platforms/symbian-introduction.qdoc

@@ -1 +1 @@
 /****************************************************************************
 **
-** Copyright (C) 2010 Nokia Corporation and/or its subsidiary(-ies).
+** Copyright (C) 2011 Nokia Corporation and/or its subsidiary(-ies).
 ** All rights reserved.
 ** Contact: Nokia Corporation (qt-info@nokia.com)
@@ -7 +7 @@
 ** This file is part of the documentation of the Qt Toolkit.
 **
-** $QT_BEGIN_LICENSE:LGPL$
+** $QT_BEGIN_LICENSE:FDL$
 ** Commercial Usage
 ** Licensees holding valid Qt Commercial licenses may use this file in
 ** accordance with the Qt Commercial License Agreement provided with the
-** Software or, alternatively, in accordance with the terms contained in
-** a written agreement between you and Nokia.
-**
-** GNU Lesser General Public License Usage
-** Alternatively, this file may be used under the terms of the GNU Lesser
-** General Public License version 2.1 as published by the Free Software
-** Foundation and appearing in the file LICENSE.LGPL included in the
-** packaging of this file.  Please review the following information to
-** ensure the GNU Lesser General Public License version 2.1 requirements
-** will be met: http://www.gnu.org/licenses/old-licenses/lgpl-2.1.html.
-**
-** In addition, as a special exception, Nokia gives you certain additional
-** rights.  These rights are described in the Nokia Qt LGPL Exception
-** version 1.1, included in the file LGPL_EXCEPTION.txt in this package.
-**
-** GNU General Public License Usage
-** Alternatively, this file may be used under the terms of the GNU
-** General Public License version 3.0 as published by the Free Software
-** Foundation and appearing in the file LICENSE.GPL included in the
-** packaging of this file.  Please review the following information to
-** ensure the GNU General Public License version 3.0 requirements will be
-** met: http://www.gnu.org/copyleft/gpl.html.
+** Software or, alternatively, in accordance with the terms contained in a
+** written agreement between you and Nokia.
+**
+** 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
@@ -44 +30 @@
     \title Qt for the Symbian platform
     \ingroup qt-embedded
-    \brief Documents related to Qt on the Symbian platform
+    \brief Documents related to Qt for the Symbian platform
 
     Qt for Symbian is a C++ framework for GUI and application development
@@ -57 +43 @@
      \list
         \o \l {Qt for the Symbian platform Requirements}
-        \o \l {Installing Qt on the Symbian platform from a Binary Package}
-        \o \l {Installing Qt on the Symbian platform}
+        \o \l {Installing Qt for the Symbian platform from a Binary Package}
+        \o \l {Installing Qt for the Symbian platform}
         \o \l {The Symbian platform - Introduction to Qt}{Introduction to using Qt}
     \endlist
@@ -64 +50 @@
     \list
         \o \l {Exception Safety with Symbian}
-        \o \l {Platform Notes - Symbian} {Qt for the Symbian platform - state of support}
+        \o \l {Platform and Compiler Notes - Symbian} {Qt for the Symbian platform - state of support}
         \o \l {qmake Platform Notes#Symbian platform} {Qt for Symbian extensions for qmake}
+        \o \l {Symbian Platform Security Requirements} {Symbian Platform Security Requirements}
     \endlist
     \o
@@ -75 +62 @@
 
 /*!
+    \page symbian-platform-security-requirements.html
+
+    \title Symbian Platform Security Requirements
+    \ingroup qtsymbian
+
+    On Symbian, processes that access media via the network must
+    have the \c NetworkServices platform security capability. If the client
+    process lacks this capability, operations will result in errors.
+    This failure is indicated by a state() of Phonon::ErrorState.
+
+    Platform security capabilities are added via the
+    \l{qmake-variable-reference.html#target-capability}{TARGET.CAPABILITY}
+    qmake variable.
+*/
+
+/*!
     \page symbian-with-qt-introduction.html
 
@@ -84 +87 @@
     \tableofcontents
 
-    \section1 Required tools
+    \section1 Required Tools
 
     See \l{Qt for the Symbian platform Requirements} to see what tools are
     required to use Qt for the Symbian platform.
 
-    \section1 Installing Qt and running demos
-
-    Follow the instructions found in \l{Installing Qt on the Symbian platform from a Binary Package}
+    \section1 Installing Qt and Running Demos
+
+    Follow the instructions found in \l{Installing Qt for the Symbian platform from a Binary Package}
     to learn how to install Qt using a binary package and how to build and run Qt demos.
 
-    Follow the instructions found in \l{Installing Qt on the Symbian platform} to learn how to install Qt using
+    Follow the instructions found in \l{Installing Qt for the Symbian platform} to learn how to install Qt using
     using source package and how to build and run the Qt demos.
 
-    \section1 Building your own applications
+    \section1 Building Your Own Applications
 
     If you are new to Qt development, have a look at \l{How to Learn Qt}.
@@ -110 +113 @@
 
     For more information on how to use qmake have a look at the \l
-    {qmake Tutorial}.
+    {qmake Tutorial}. In particular, see the
+    \l{qmake Platform Notes#Symbian platform}{qmake Platform Notes} for
+    details of Symbian-specific build settings.
 
     Now you can build the Qt for the Symbian platform application with
-    standard build tools. By default, running \c make will produce binaries for
-    the emulator. However, the Symbian platform comes with several alternative
-    build targets, as shown in the table below:
+    standard build tools.
+
+    \section2 Alternative Build Targets
+
+    By default, running \c make will produce binaries for the emulator.
+    However, the Symbian platform comes with several alternative
+    build targets that can be used to create binaries for target hardware
+    and deploy them on devices, as shown in the table below:
 
     \table
@@ -127 +137 @@
     \row \o \c run           \o Run the application on the emulator.
     \row \o \c runonphone    \o Run the application on a device.
+    \row \o \c deploy        \o Deploys the project into a device.
     \row \o \c sis           \o Create signed \c .sis file for project.
+    \row \o \c unsigned_sis  \o Create unsigned \c .sis file for project.
     \row \o \c installer_sis \o Create signed \l{Smart Installer}{smart installer}
                                 \c .sis file for project.
@@ -133 +145 @@
                                 missing dependencies in addition to
                                 just installing the application.
+                                Note: The application \c .sis contained in smart installer \c .sis
+                                will be recreated and signed with same certificates as
+                                smart installer \c .sis.
+    \row \o \c ok_installer_sis \o Otherwise similar to \c installer_sis target, except
+                                the application sis will not be recreated. This is useful
+                                when application \c .sis needs to be separately signed before
+                                including it into smart installer \c .sis.
+    \row \o \c unsigned_installer_sis \o Create unsigned \l{Smart Installer}{smart installer}
+                                         \c .sis file for project.
+                                         Note: The application \c .sis contained in smart installer
+                                         \c .sis will also be unsigned.
     \row \o \c stub_sis      \o Create a stub sis to allow upgradability of projects
                                 that are deployed in ROM
@@ -145 +168 @@
     by right clicking on the project explorer and executing "Import...".
 
-    \section2 Smart Installer
-
-    The Smart Installer makes sure that deployed applications have all the Qt dependencies
-    they need to run on a device.
-
-    Download the latest release of the Smart Installer from \l{http://get.qt.nokia.com/nokiasmartinstaller/},
-    and install it on top of the Qt package.
-
-    \section1 Installing your own applications
+    \section1 Running Applications from the Command Line
+
+    The application can be launched on the emulator using \c{make run} command.
+
+    The application can be launched on a device using \c{make runonphone} command.
+    When this command is invoked, a \c .sis file is first created as if \c{make sis}
+    command was invoked (see above for details).
+    \bold{Note:} Running the application on a device using this command requires
+    \c TRK application to be running on the device.
+
+    Additional environment variables that can be utilized with these commands are:
+    \table
+    \row \o \c QT_RUN_OPTIONS           \o Any command line parameters you wish to pass
+                                           to your application.
+    \row \o \c QT_RUN_ON_PHONE_OPTIONS  \o Options for runonphone application.
+                                           Execute \c runonphone from command line for
+                                           more information about available options.
+                                           \c{make runonphone} only.
+    \endtable
+
+    \section1 Installing Your Own Applications
 
     To install your own applications on hardware, you need a signed \c .sis file.
-    (Refer to the \l{http://developer.symbian.org/wiki/index.php/Platform_Security_%28Fundamentals_of_Symbian_C%2B%2B%29#Self-Signed_Applications}
-    {Platform Security Article} for more informations about self-signing.)
+    (Refer to the \l{Symbian Platform Security} article for more informations about self-signing.)
     The signed \c .sis file can be created with \c make \c sis target. \c sis target
     is only supported for executables or projects with \c DEPLOYMENT statements.
@@ -186 +220 @@
     \endtable
 
-    The suppported options for \c QT_SIS_OPTIONS:
+    The supported options for \c QT_SIS_OPTIONS:
 
     \target Supported options for QT_SIS_OPTIONS
@@ -192 +226 @@
     \row \o -i                  \o Install the package right away using PC suite.
     \row \o -p                  \o Only preprocess the template \c .pkg file.
-    \row \o -c=<file>           \o Read certificate information from a file.
+    \row \o -c <file>           \o Read certificate information from a file.
+    \row \o -u                  \o Preserves unsigned package.
+    \row \o -o                  \o Creates only unsigned package.
+    \row \o -s                  \o Generates stub sis for ROM.
+    \row \o -n <name>           \o Specifies the final sis name.
+    \row \o -g                  \o Treat gcce platform as armv5.
+    \row \o -d                  \o Skip automatic patching of the package when default certificate is used.
     \endtable
 
     Execute the \c{createpackage.pl} script without any
-    parameters for detailed information about options. By default no otions are given.
+    parameters for detailed information about options. By default no options are given.
 
     For example:
@@ -206 +246 @@
     \snippet doc/src/snippets/code/doc_src_symbian-introduction.qdoc 3
 
-    If you want to install the program immediately, make sure that the device
-    is connected to the computer in "PC Suite" mode, and run \c sis target
-    with the \c QT_SIS_OPTIONS=-i, like this:
+    If you want to install the program immediately after creating \c .sis file,
+    make sure that the device is connected to the computer in "PC Suite" mode,
+    and use \c deploy target instead of \c sis target:
 
     \snippet doc/src/snippets/code/doc_src_symbian-introduction.qdoc 5
 
-    \section1 Running applications from command line
-
-    The application can be launched on the emulator using \c{make run} command.
-
-    The application can be launched on a device using \c{make runonphone} command.
-    When this command is invoked, a \c .sis file is first created as if \c{make sis}
-    command was invoked (see above for details).
-    \bold{Note:} Running the application on a device using this command requires
-    \c TRK application to be running on the device.
-
-    Additional environment variables that can be utilized with these commands are:
-    \table
-    \row \o \c QT_RUN_OPTIONS           \o Any command line parameters you wish to pass
-                                           to your application.
-    \row \o \c QT_RUN_ON_PHONE_OPTIONS  \o Options for runonphone application.
-                                           Execute \c runonphone from command line for
-                                           more information about available options.
-                                           \c{make runonphone} only.
-    \endtable
+    \section1 Deployment and the Smart Installer
+
+    Although some Symbian devices may already have a version of Qt installed
+    on them, there needs to be a way to ensure that an appropriate version
+    of Qt is available for your application to use. Rather than deploy the
+    required Qt libraries with your application, the preferred way to
+    package Qt applications for deployment is to download and use the Smart
+    Installer.
+
+    The Smart Installer makes sure that deployed applications have all the
+    Qt dependencies they need to run on a device, performing the necessary
+    updates when the user installs the application.
+
+    More information about deployment can be found in the
+    \l{Deploying an Application on the Symbian Platform} document.
 */