Doc: Started organizing Symbian platform deployment information.

Reviewed-by: Trust Me

3 files changed, 78 insertions, 35 deletions

diff --git a/doc/src/deployment/deployment.qdoc b/doc/src/deployment/deployment.qdoc
index 51974af..286c080 100644
--- a/doc/src/deployment/deployment.qdoc
+++ b/doc/src/deployment/deployment.qdoc
@@ -1472,8 +1472,10 @@
 /*!
     \page deployment-symbian.html
     \contentspage Deploying Qt Applications
+    \ingroup qtsymbian
+    \title Deploying an Application on the Symbian Platform
 
-    \title Deploying an Application on the Symbian platform
+    \section1 Overview
 
     Applications are deployed to Symbian devices in signed \c .sis package files.
     The \c .sis file content is controlled with \c .pkg files. The \c .pkg file contains a set
@@ -1483,10 +1485,17 @@
     to end-users some changes are needed. This document describes what changes are
     typically needed and how to implement them.
 
+    \section1 Requirements
+
+    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 Static Linking
 
-    Qt for the Symbian platform does currently not support static linking of
-    Qt libraries.
+    Qt for the Symbian platform does not currently support static linking of
+    Qt libraries with application binaries. You will need to build shared
+    libraries as described below and link your application with them.
 
     \section1 Shared Libraries
 
@@ -1532,7 +1541,7 @@
     S60 3rd edition FP1, S60 3rd edition FP2 and S60 5th edition devices.
 
     Now we are ready to compile the application and create the application
-    deployment file. Run \c qmake to create Symbian specific makefiles, resources (\.rss)
+    deployment file. Run \c qmake to create Symbian specific makefiles, resources (\c .rss)
     and deployment packaging files (\c .pkg). And do build to create the
     application binaries and resources.
 
@@ -1562,4 +1571,14 @@
     For more information about creating a \c .sis file and installing it to device see also
     \l {The Symbian platform - Introduction to Qt#Installing your own applications}{here}.
 
+    \section1 Further Reading
+
+    This document aims to cover the common case for developers who want to
+    deploy Qt applications on devices using the Smart Installer. It does not
+    aim to cover every possible way of installing applications, Qt and other
+    dependencies on a device.
+
+    A wider selection of deployment methods is described in the
+    \l{Deploying a Qt Application article} on the Symbian Foundation
+    Developer Wiki.
 */
diff --git a/doc/src/external-resources.qdoc b/doc/src/external-resources.qdoc
index 249c10a1..6f22f00 100644
--- a/doc/src/external-resources.qdoc
+++ b/doc/src/external-resources.qdoc
@@ -427,3 +427,13 @@
     \externalpage http://opensource.org/licenses/bsd-license.php
     \title New and Modified BSD Licenses
 */
+
+/*!
+    \externalpage http://developer.symbian.org/wiki/index.php/Platform_Security_%28Fundamentals_of_Symbian_C%2B%2B%29#Self-Signed_Applications
+    \title Symbian Platform Security
+*/
+
+/*!
+    \externalpage http://developer.symbian.org/wiki/index.php/Deploying_a_Qt_Application
+    \title Deploying a Qt Application article
+*/
diff --git a/doc/src/platforms/symbian-introduction.qdoc b/doc/src/platforms/symbian-introduction.qdoc
index 6ffc568..9563a8e 100644
--- a/doc/src/platforms/symbian-introduction.qdoc
+++ b/doc/src/platforms/symbian-introduction.qdoc
@@ -83,12 +83,12 @@
 
     \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
+    \section1 Installing Qt and Running Demos
 
     Follow the instructions found in \l{Installing Qt on 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.
@@ -96,7 +96,7 @@
     Follow the instructions found in \l{Installing Qt on 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}.
     In general, the difference between developing a
@@ -109,12 +109,19 @@
     \snippet doc/src/snippets/code/doc_src_symbian-introduction.qdoc 0
 
     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
     \row \o \c debug-winscw  \o Build debug binaries for the emulator (default).
@@ -144,19 +151,30 @@
     To work on your project in Carbide, simply import the \c .pro file
     by right clicking on the project explorer and executing "Import...".
 
-    \section2 Smart Installer
+    \section1 Running Applications from the Command Line
 
-    The Smart Installer makes sure that deployed applications have all the Qt dependencies
-    they need to run on a device.
+    The application can be launched on the emulator using \c{make run} command.
 
-    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.
+    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.
 
-    \section1 Installing your own applications
+    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.
     By default the \c sis target will create signed \c .sis file for last build
@@ -214,23 +232,19 @@
 
     \snippet doc/src/snippets/code/doc_src_symbian-introduction.qdoc 5
 
-    \section1 Running applications from command line
+    \section1 Deployment and the Smart Installer
 
-    The application can be launched on the emulator using \c{make run} command.
+    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 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.
+    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.
 
-    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
+    More information about deployment can be found in the
+    \l{Deploying an Application on the Symbian Platform} document.
 */