summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorFrederik Gladhorn <frederik.gladhorn@digia.com>2014-05-01 12:45:33 +0200
committerFrederik Gladhorn <frederik.gladhorn@digia.com>2014-05-01 12:45:34 +0200
commit40caefc3bdb0740f977e53d485aba5de46a65d62 (patch)
tree458a82bf694ef4d45b2467a0b088792d6892d64c
parentc66fd6f60269c8781cc2a573974463825d7ace70 (diff)
parente91d6f217d71e62a7e727b0da0b54b626370aba3 (diff)
downloadqtdoc-40caefc3bdb0740f977e53d485aba5de46a65d62.tar.gz
Merge remote-tracking branch 'origin/release' into stable
Change-Id: Ie6bbbdf2f9a1ef34deef9c38aa3d1bd10292aacf
-rw-r--r--doc/src/configure.qdoc6
-rw-r--r--doc/src/external-resources.qdoc16
-rw-r--r--doc/src/getting-started/installation.qdoc25
-rw-r--r--doc/src/platforms/android.qdoc87
-rw-r--r--doc/src/platforms/ios.qdoc68
-rw-r--r--doc/src/platforms/linux.qdoc33
-rw-r--r--doc/src/platforms/windows.qdoc5
-rw-r--r--doc/src/qtmodules.qdoc18
8 files changed, 145 insertions, 113 deletions
diff --git a/doc/src/configure.qdoc b/doc/src/configure.qdoc
index 3843888e..f3f63bfc 100644
--- a/doc/src/configure.qdoc
+++ b/doc/src/configure.qdoc
@@ -234,10 +234,12 @@
The following pages provide guidelines on how to configure Qt for specific
platform development:
\list
- \li \l{http://qt-project.org/wiki/Qt5ForAndroidBuilding}{Building Qt 5 for Android} Wiki page
- \li \l{Qt for iOS}{iOS}
+ \li \l{Building Qt 5 for Android} Wiki page
+ \li \l{Qt for iOS - Building from Source}
+ \li \l{Qt for WinRT#Building from source}{Qt for WinRT - Building from Source}
\li \l{Qt for BlackBerry} - a community-driven site for BlackBerry and
QNX devices
+ \li \l{Qt for Embedded Linux#Configuring for a Specific Device}{Qt for Embedded Linux - Building from Source}
\li \l{http://qt-project.org/wiki/Qt-RaspberryPi}{Qt for Raspberry Pi} - a community-driven site for
Raspberry devices
\li \l{http://qt-project.org/wiki/Category:Devices}{Devices} - a list of other devices and chipsets
diff --git a/doc/src/external-resources.qdoc b/doc/src/external-resources.qdoc
index 4fe4d781..1e031045 100644
--- a/doc/src/external-resources.qdoc
+++ b/doc/src/external-resources.qdoc
@@ -133,3 +133,19 @@
\externalpage http://engin.io
\title Enginio Data Storage
*/
+/*!
+ \externalpage http://qt-project.org/doc/qtcreator/creator-configuring.html
+ \title Configuring Qt Creator
+*/
+/*!
+ \externalpage http://qt-project.org/doc/qtcreator/creator-build-example-application.html
+ \title Building and Running Example
+*/
+/*!
+ \externalpage http://qt-project.org/doc/qtcreator/creator-mobile-app-tutorial.html
+ \title Creating a Mobile Application
+*/
+/*!
+ \externalpage http://qt-project.org/wiki/Qt5ForAndroidBuilding
+ \title Building Qt 5 for Android
+*/
diff --git a/doc/src/getting-started/installation.qdoc b/doc/src/getting-started/installation.qdoc
index 7cc80ea4..35bc91fb 100644
--- a/doc/src/getting-started/installation.qdoc
+++ b/doc/src/getting-started/installation.qdoc
@@ -77,6 +77,31 @@ visit the following page:
\li \l{Qt for Linux/X11 - Building from Source}
\endlist
+\section1 Embedded Linux
+
+\list
+\li \l{Qt for Embedded Linux#Configuring for a Specific Device}
+ {Qt for Embedded Linux - Building from Source}
+\endlist
+
+\section1 Android
+
+\list
+\li \l {Building Qt 5 for Android}{Qt for Android - Building from Source}
+\endlist
+
+\section1 iOS
+
+\list
+\li \l {Qt for iOS - Building from Source}
+\endlist
+
+\section1 WinRT
+
+\list
+\li \l {Qt for WinRT#Building from source}{Qt for WinRT - Building from Source}
+\endlist
+
\section1 Windows CE
\list
diff --git a/doc/src/platforms/android.qdoc b/doc/src/platforms/android.qdoc
index 9885ac8e..ea4b90d8 100644
--- a/doc/src/platforms/android.qdoc
+++ b/doc/src/platforms/android.qdoc
@@ -60,6 +60,7 @@ The following topics provide more details about how to use Qt for Android:
\li \l{Qt Creator: Deploying Applications to Android Devices}{Deploying to the Device}
\li \l{Publishing to Google Play}
\li \l{Platform and Compiler Notes - Android}{Platform Notes}
+ \li \l{Building Qt 5 for Android}{Building from Sources}
\li \l{Android GNU C++ run-time licensing}
\endlist
*/
@@ -109,86 +110,32 @@ to install:
\section1 Installing Qt for Android
-You can download the Qt 5 installers and sources from the \l Downloads page.
-For more information, visit the \l{Getting Started with Qt} page.
+The Qt 5 installers for different platforms are available from the \l Downloads
+page. Choose the one that is appropriate.
\note Enterprise packages are available from the \l{Try Qt Enterprise}
page. Qt for Android is also available as part of Qt Mobile Edition,
see \l{Qt Enterprise}{qt.digia.com} for details.
-You can also choose to build the binaries from the Qt sources, that is,
-cross-compile Qt 5.x for Android on \l{Qt for Linux/X11}{Linux (X11)}
-, \l{Qt for Windows}{Windows}, and \l{Qt for Mac OS X}{Mac OS X} platforms.
-If you chose to do so, follow these instructions:
+Once you have the installer, follow these steps:
\list 1
- \li Install the required tools, SDK, and the compiler toolchains listed in the
- \l{Requirements} section.
-
- \note Ensure that your build environment fulfills the requirement for the
- platform (\l{Qt for Linux/X11}{Linux}, \l{Qt for Mac OS X}{Mac OS X}, and
- \l{Qt for Windows}{Windows}) you have chosen.
- \li Set the following environment variables if your build platform is Windows:
- \list
- \li \c{ANDROID_NDK_HOST=windows} or \c{windows-x86-64} depending on
- which NDK you are using.
- \li \c{PATH=%JAVA_HOME%\bin;<MINGW_ROOT>\bin;%PATH%}
- \endlist
- \li Download the Qt 5 sources either from the
- \l{Opensource Downloads}{Downloads} page or from the Git
- repository.
-
- \note If you are downloading the sources from the Git repository, you
- must initialize your Git clone using the \c{perl init-repository} command
- to pull the latest sources for all the Qt 5.x modules. Ensure that you
- have perl v5.14 or later installed.
- \li Run the following command to configure the Qt 5.x sources to cross-compile
- Qt for Android:
-
- On Linux/X11 and Mac OS X:
-
- \code
- ./configure -developer-build -xplatform android-g++ -nomake tests -nomake examples -android-ndk <path/to/ndk> -android-sdk <path/to/sdk>
- -android-toolchain-version <e.g. 4.8> -skip qttranslations -skip qtwebkit -skip qtserialport -skip qtwebkit-examples
- \endcode
-
- On Windows:
-
- \code
- configure.bat -developer-build -platform win32-g++ -xplatform android-g++ -android-ndk <ANDROID_NDK_ROOT>
- -android-sdk <ANDROID_SDK> -opensource -confirm-license -nomake tests -nomake examples -skip qttranslations -skip qtwebkit -skip qtserialport -skip qtwebkit-examples
- \endcode
-
- \note If you want to use OpenSSL in your application, use the \c{-openssl}
- option with your \c configure command to build Qt binaries with runtime
- support for OpenSSL. For more information about how to add OpenSSL support
- to your application, see \l{Adding OpenSSL Support}.
- \li Start the build by using the \c {make} or \c{mingw32-make} (on Windows)
- utility with the \c{-j<N>} switch (used to speedup building).
+ \li Run the installer to begin installing Qt 5 on your development platform.
+ \li Select the components you need in the \uicontrol{Select Components}
+ screen and click \uicontrol Next.
+ \li After the installation is complete, the installer lets you open Qt Creator
+ and the README. Select to open Qt Creator and click \uicontrol Finish.
+ \li Select \uicontrol{Tools > Options > Android} in Qt Creator to add
+ the Android NDK and SDK paths. For more details, see
+ \l{Qt Creator: Connecting Android Devices}{Qt Creator Manual}.
\endlist
-The binaries are installed to the \e{qtbase/bin} directory by default for the
-developer builds. You can check the install paths using the \c{qmake -query}
-command.
-
-\section1 Configuring Qt Creator
-
-After installing the Qt for Android binaries either using the installer or by
-cross-compiling, Qt Creator must be configured to start developing your first
-Qt application for Android.
-
-\note You must install Qt Creator separately (either using the stand-alone
-or Qt 5 installer provided by Qt project, or by building it from the source)
-if you built the Qt 5.x binaries from the sources. Use the 3.0 git branch if
-you are building it from the source.
-
-See \l{Qt Creator: Connecting Android Devices}{Qt Creator Manual} for
-instructions to configure and test your setup by creating a simple
-Qt Quick application. You can also try running an example on the Android target
-to test the setup. Use the \c{android} keyword in the search field under the
-\gui{Examples} tab in Qt Creator \gui{Welcome} mode to list all the examples
-tested for Android.
+Now you can test your development setup by running the examples that came
+with the Qt 5 package installed earlier. You can browse the examples in
+Qt Creator \uicontrol Welcome mode. Use the \c android filter in the search
+field to list all the examples tested on Android.
+To develop a simple application from scratch, see \l{Creating a Mobile Application}.
*/
/*!
\page portingtoandroid.html
diff --git a/doc/src/platforms/ios.qdoc b/doc/src/platforms/ios.qdoc
index b3bea824..969855b6 100644
--- a/doc/src/platforms/ios.qdoc
+++ b/doc/src/platforms/ios.qdoc
@@ -54,21 +54,14 @@
\section2 Setting Up the Development Environment
- You have two options to set up the Qt development environment:
-
- \list 1
- \li through the \e{Qt Installers} - downloads and installs Qt
- \li through the \e{Qt sources}.
- \endlist
-
- You can download the Qt 5 installers and sources from the \l Downloads page.
- For more information, visit the \l{Getting Started with Qt} page.
+ You can download the Qt 5 installers from the \l Downloads page.
+ For more information, see \l{Getting Started with Qt}.
\note Qt Enterprise packages are available from the \l{Try Qt Enterprise}
page. Qt for iOS is also available as part of the Qt Mobile Edition,
see \l{Qt Enterprise}{qt.digia.com} for details.
- Regardless of which approach you choose, you first need to install
+ Before installing Qt, you first need to install
Xcode. You will find it in the App Store \l{Xcode}{here}. For
running Qt applications in the simulator that comes with Xcode,
this is all you need. However, for running applications on a
@@ -78,30 +71,10 @@
developer certificates and provisioning profiles. The easiest
solution is to use a profile that takes any App ID (a \c *).
- Before building Qt or any Qt applications, you should test that Xcode
+ Before building any Qt applications, you should test that Xcode
is set up correctly, for example, by running one of the standard
Xcode application templates on your device.
- \section3 Building From Source
-
- We assume that you have cloned the Qt 5 repositories (or obtained
- the Qt sources elsewhere) and followed the platform independent
- requirements for building Qt. The process of building Qt is found
- in the \l{Building Qt Sources} page.
-
- We can then build Qt. This is done from the Qt 5 top directory,
- like so:
-
- \badcode
- > ./configure -xplatform macx-ios-clang -release
- \endcode
-
- Then simply run \c{make}.
-
- \note A default build will include both simulator and device
- libraries. If you want to build for a single target, use the \c
- -sdk argument with either \c iphoneos or \c iphonesimulator.
-
\section2 Building Applications From the Command Line
As mentioned previously, the development workflow on iOS consists
@@ -155,9 +128,40 @@
The following topics provide more details about Qt for iOS:
\list
\li \l {Porting to iOS}{Porting a Qt Quick Application}
- \li \l {Platform Notes -iOS}{Platform Notes}
+ \li \l {Platform Notes - iOS}{Platform Notes}
+ \li \l {Qt for iOS - Building from Source}
\endlist
*/
+
+/*!
+ \page building-from-source-ios.html
+ \title Qt for iOS - Building from Source
+ \brief Provides instructions to build Qt from source for iOS platform.
+
+ Building \l {Qt for iOS} from sources requires \l Xcode with
+ command-line tools installed. This can be done within Xcode from
+ \gui Preferences > \gui Downloads > \gui Components >
+ \gui {Command Line Tools}.
+
+ Qt 5 sources can be obtained either by cloning the repositories or
+ downloading the source package(s).
+
+ We can then configure and build Qt. This is done from the Qt 5 top
+ directory:
+
+ \badcode
+ > ./configure -xplatform macx-ios-clang -release
+ \endcode
+
+ For other configure options, see \l{Qt Configure Options}.
+
+ Then, simply run \c{make}.
+
+ \note A default build will include both simulator and device
+ libraries. If you want to build for a single target, use the \c
+ -sdk argument with either \c iphoneos or \c iphonesimulator.
+*/
+
/*!
\page porting-to-ios.html
\title Porting to iOS
diff --git a/doc/src/platforms/linux.qdoc b/doc/src/platforms/linux.qdoc
index a44ce76d..62dfad90 100644
--- a/doc/src/platforms/linux.qdoc
+++ b/doc/src/platforms/linux.qdoc
@@ -32,8 +32,6 @@
\ingroup supportedplatform
Qt's support for different Linux platforms is extensive and mature.
- Before you get started, ensure that your development environment fulfills
- the \l{Qt for X11 Requirements}{requirements}.
\section1 Downloading and Installing Qt
@@ -49,6 +47,37 @@
\note Qt Enterprise packages are available from the \l{Try Qt Enterprise}
page.
+ \section2 Requirements for Development Host
+
+ The Qt installers for Linux assume that a C++ compiler, debugger,
+ make, and other development tools are provided by the host
+ operating system. In addition, building graphical Qt applications
+ requires OpenGL libraries and headers installed. Most Linux
+ distributions do not install all of these by default, but setting
+ up a development environment is still straightforward.
+
+ Use the following commands to install the basic requirements for
+ building Qt applications:
+
+ \section3 Debian/Ubuntu (apt-get)
+
+ \badcode
+ sudo apt-get install build-essential libgl1-mesa-dev
+ \endcode
+
+ \section3 Fedora/RHEL/CentOS (yum)
+
+ \badcode
+ sudo yum groupinstall "C Development Tools and Libraries"
+ sudo yum install mesa-libGL-devel
+ \endcode
+
+ \section3 openSUSE (zypper)
+
+ \badcode
+ sudo zypper install -t pattern devel_basis
+ \endcode
+
\section2 Building Qt 5 from Source
You can also build Qt 5 from the source package and configure it according
diff --git a/doc/src/platforms/windows.qdoc b/doc/src/platforms/windows.qdoc
index 637c2c48..30c8ab65 100644
--- a/doc/src/platforms/windows.qdoc
+++ b/doc/src/platforms/windows.qdoc
@@ -135,6 +135,11 @@
conversion warnings will break the build.
\endlist
+ Support for Secure Sockets Layer (SSL) communication is provided by the
+ \l {OpenSSL Toolkit}, which must be obtained separately. See
+ \l {Secure Sockets Layer (SSL) Classes} for instructions on building Qt with
+ SSL support.
+
\section2 Graphics Drivers
For \l{Qt Quick} 2.0 to work, a graphics driver that provides OpenGL 2.1 or
diff --git a/doc/src/qtmodules.qdoc b/doc/src/qtmodules.qdoc
index 70203c15..4102ad5a 100644
--- a/doc/src/qtmodules.qdoc
+++ b/doc/src/qtmodules.qdoc
@@ -76,7 +76,11 @@
\row
\li \l{Qt Quick Controls}
\li Reusable Qt Quick based UI controls to create classic desktop-style
- user interfaces
+ user interfaces.
+ \row
+ \li \l{Qt Quick Dialogs}
+ \li Types for creating and interacting with system dialogs from a
+ Qt Quick application.
\row
\li \l{Qt Quick Layouts}
\li Layouts are items that are used to arrange Qt Quick 2 based items in
@@ -136,6 +140,12 @@
\li
\li Classes for applications which use ActiveX and COM
\row
+ \li \l{Enginio Manual}{Enginio}
+ \li All
+ \li All
+ \li A Backend-as-a-Service solution to ease the backend development for
+ connected and data-driven applications.
+ \row
\li \l{Qt Android Extras}
\li All
\li \l{Qt for Android}{Android}
@@ -157,12 +167,6 @@
\li
\li Classes for inter-process communication over the D-Bus protocol.
\row
- \li \l{Enginio Manual}{Enginio}
- \li All
- \li All
- \li A Backend-as-a-Service solution to ease the backend development for
- connected and data-driven applications.
- \row
\li \l{Qt Graphical Effects}
\li All
\li