diff options
author | Frederik Gladhorn <frederik.gladhorn@digia.com> | 2013-11-26 10:53:18 +0100 |
---|---|---|
committer | Frederik Gladhorn <frederik.gladhorn@digia.com> | 2013-11-26 10:53:18 +0100 |
commit | de12f602fc3b1bd84e96be30e34804ae34e0d4de (patch) | |
tree | 5b6dabc72f88ded736b28a7f51ad38bfefdb52a1 | |
parent | a8717af5432071fe467253d2abb602dfcb7be248 (diff) | |
parent | 6bd151128ef2330a0a65c94b4434ae4bfb5623db (diff) |
Merge remote-tracking branch 'origin/release' into stable
Change-Id: Ifa14612862e83036dfe130f60d9524d8f02ff0d2
-rw-r--r-- | dist/changes-5.2.0 | 28 | ||||
-rw-r--r-- | doc/src/configure.qdoc | 72 | ||||
-rw-r--r-- | doc/src/external-resources.qdoc | 12 | ||||
-rw-r--r-- | doc/src/getting-started/gettingstarted.qdoc | 12 | ||||
-rw-r--r-- | doc/src/getting-started/installation.qdoc | 7 | ||||
-rw-r--r-- | doc/src/getting-started/installer-README.qdoc | 4 | ||||
-rw-r--r-- | doc/src/index.qdoc | 13 | ||||
-rw-r--r-- | doc/src/platforms/android.qdoc | 7 | ||||
-rw-r--r-- | doc/src/platforms/ios.qdoc | 9 | ||||
-rw-r--r-- | doc/src/platforms/linux.qdoc | 3 | ||||
-rw-r--r-- | doc/src/platforms/macosx.qdoc | 21 | ||||
-rw-r--r-- | doc/src/platforms/platform-notes-qtee.qdoc | 38 | ||||
-rw-r--r-- | doc/src/platforms/platform-notes.qdoc | 73 | ||||
-rw-r--r-- | doc/src/platforms/supported-platforms.qdoc | 31 | ||||
-rw-r--r-- | doc/src/platforms/wince-customization.qdoc | 12 | ||||
-rw-r--r-- | doc/src/platforms/wince-introduction.qdoc | 2 | ||||
-rw-r--r-- | doc/src/platforms/windows.qdoc | 3 |
17 files changed, 202 insertions, 145 deletions
diff --git a/dist/changes-5.2.0 b/dist/changes-5.2.0 new file mode 100644 index 000000000..8d6ec0bb0 --- /dev/null +++ b/dist/changes-5.2.0 @@ -0,0 +1,28 @@ +Qt 5.2 introduces many new features and improvements as well as bugfixes +over the 5.x series. For more details, refer to the online documentation +included in this distribution. The documentation is also available online: + + http://qt-project.org/doc/ + +The Qt version 5.2.x series is binary compatible with the 5.0.x and 5.1.x series. +Applications compiled for 5.1 and 5.0 will continue to run with 5.2. + +Some of the changes listed in this file include issue tracking numbers +corresponding to tasks in the Qt Bug Tracker: + + http://bugreports.qt-project.org/ + +Each of these identifiers can be entered in the bug tracker to obtain more +information about a particular change. + +**************************************************************************** +* General * +**************************************************************************** + +Documentation +------------- + +* Fixed several instances of missing information or incorrect information. + +* [QTBUG-32173] Added new pages and sections related to Qt 5.2 such as the iOS + and Android ports. diff --git a/doc/src/configure.qdoc b/doc/src/configure.qdoc index 41b6f64e3..3843888ec 100644 --- a/doc/src/configure.qdoc +++ b/doc/src/configure.qdoc @@ -43,46 +43,54 @@ are different, therefore the commands will vary. Also, on Windows systems, the configure script is called \e configure.bat. - \section1 Paths, Prefixes, and Shadow-Building - - Qt's default installation directory depends on the platform but can be - set with the \c -prefix option. Configure always prints the installation - directory when it finishes. - - \code - ./configure -prefix ~/home/user/Qt-5.1 + After running \c configure, build the sources with the \c make tool + belonging to the chosen toolchain. + + \section1 Source, Build, and Install Directories + + With configure, it is possible to configure Qt to install to a different + directory than the source directory or the build directory. The \e source + directory contains the source code and it is obtained from the source + package. The \e build directory is where the build related files such as + Makefiles, object files, and other intermediate files are stored. The \e + install directory is where the binaries and libraries are installed, for use + either by the system or by the application. + + It is often convenient to use a \e{shadow build}, when the build directory + is not the same as the source directory. This method allows the source + directory to be free from intermediate or generated files, and allows for + multiple simultaneous builds with different configurations. To shadow-build, + run \c configure from a separate directory: + + \code + mkdir ~/qt-build + cd ~/qt-build + ~/qt-source/configure \endcode - \e{Shadow building} is when the Makefiles and libraries are not built in the - same directory as the source directory. Shadow building keeps the source - directory contents free of generated Makefiles and other intermediate - compilation files. Note that the default installation directory is not - modified when shadow building. To shadow build, run configure in a clean - directory. + The Makefiles are at \e ~/qt-build and not in the source directory. + + After building, it may be necessary to install the libraries and binaries + into the install directory. The default for the installation directory + depends on the platform; \c configure's output mentions it. To modify the + installation directory, use the \c -prefix option: \code - mkdir ~/Qt-builds - cd ~/Qt-builds - ~/qt-source/configure + ./configure -prefix /opt/Qt-5.1 \endcode - Setting both the shadow build and prefix to a directory outside of the Qt - sources allows multiple Qt configurations to exist. For example, one - installation can contain a statically-linked Qt while another installation - contains a dynamically-linked Qt. + The installation directory serves as the parent directory of the \e bin, \e + lib, and other installed Qt subdirectories. - \code - cd ~/Qt-static - ~/qt/configure -prefix $PWD/qtbase -static + It is possible to set the install directory to the same directory as the + build directory (this is termed a \e non-prefix build). In this case, Qt can + be used straight out of the build directory, and \e must \e not be + installed. This is the default under Windows, and when Qt is configured with + the \c -developer-build option. - cd ~/Qt-dynamic - ~/qt/configure -prefix $PWD/qtbase -shared - \endcode - - It is also possible to set the shadow build directory and the installation - directory (set by the prefix option) to separate directories. This setup - will build Qt in a separate directory and install it into a different - directory. + \note When you are explicitly requesting a non-prefix configuration for a + top-level build of Qt (all modules at once), set the prefix to + \c{$builddir/qtbase}, not \c{$builddir}. \section1 Including and Excluding Qt Modules diff --git a/doc/src/external-resources.qdoc b/doc/src/external-resources.qdoc index 145e74953..4d0a382c0 100644 --- a/doc/src/external-resources.qdoc +++ b/doc/src/external-resources.qdoc @@ -113,3 +113,15 @@ \externalpage http://qt.digia.com/Try-Qt-Now/ \title Try Qt Enterprise */ +/*! + \externalpage http://qt.digia.com/ + \title Qt Enterprise +*/ +/*! + \externalpage https://sailfishos.org/ + \title Sailfish OS +*/ +/*! + \externalpage https://www.tizen.org/ + \title Tizen +*/ diff --git a/doc/src/getting-started/gettingstarted.qdoc b/doc/src/getting-started/gettingstarted.qdoc index e124b08fc..af0558be2 100644 --- a/doc/src/getting-started/gettingstarted.qdoc +++ b/doc/src/getting-started/gettingstarted.qdoc @@ -32,10 +32,14 @@ \section1 Downloading and Installing Qt - The \l{Opensource Downloads}{Downloads} page contains Qt download links, - where Qt and Qt Creator can be downloaded for different development - platforms. The Qt Enterprise packages are available from the - \l{Try Qt Enterprise} page. + Qt framework and tools can be installed using an online installer, + standalone binary installers or using source packages and building + yourself. The open-source version is found from the Qt Project + \l {Opensource Downloads}{Downloads} page, which contains download + links for Qt and Qt Creator for different development platforms. + + The commercial versions are available for free trial from + \l{Try Qt Enterprise}{Digia}. \section2 Installing with the Installation Program diff --git a/doc/src/getting-started/installation.qdoc b/doc/src/getting-started/installation.qdoc index f5a9d656d..0dc4efd59 100644 --- a/doc/src/getting-started/installation.qdoc +++ b/doc/src/getting-started/installation.qdoc @@ -162,13 +162,6 @@ in the \l{Qt for Windows CE Requirements} document. \li \l{Windows CE - Signing} \endlist - Information on feature and performance tuning for embedded builds can - be found on the following pages: - \list - \li \l{Fine-Tuning Features in Qt} - \li \l{Qt Performance Tuning} - \endlist - We hope you will enjoy using Qt. Good luck! */ diff --git a/doc/src/getting-started/installer-README.qdoc b/doc/src/getting-started/installer-README.qdoc index ac3415310..ed72f23ad 100644 --- a/doc/src/getting-started/installer-README.qdoc +++ b/doc/src/getting-started/installer-README.qdoc @@ -79,10 +79,10 @@ summarizes the available installers. \li Linux (32-bit and 64-bit) \li As provided by Ubuntu \row - \li Apple Mac OS X 10.7 and Mac OS X 10.8 + \li Apple Mac OS X (10.7 and later) \li Clang as provided by Apple \row - \li Apple Mac OS X 10.7 and Mac OS X 10.8 + \li Apple Mac OS X (10.7 and later) \li iOS 5.0 and later \row \li Microsoft Windows 7 (32-bit) ANGLE diff --git a/doc/src/index.qdoc b/doc/src/index.qdoc index 218178e3c..dd4634a64 100644 --- a/doc/src/index.qdoc +++ b/doc/src/index.qdoc @@ -60,6 +60,19 @@ tools easily enables developers to create applications for one platform and easily build and run to deploy on another platform. + Qt Framework and tools are available under both open-source and + commercial licenses. + + \list + \li \l{Qt Homepage}{Qt Open-source} + \li \l{Qt Enterprise} + \li \l{Qt Enterprise}{Qt Mobile} + \endlist + + The commercially licensed Qt Enterprise and Qt Mobile products + contain additional functionality and productivity tools. For + details, see \l{Qt Enterprise}{qt.digia.com}. + \section1 Getting Started \list \li \l{Getting Started with Qt} diff --git a/doc/src/platforms/android.qdoc b/doc/src/platforms/android.qdoc index 796b9b167..0a0874f93 100644 --- a/doc/src/platforms/android.qdoc +++ b/doc/src/platforms/android.qdoc @@ -66,6 +66,7 @@ The following topics provide more details about how to use Qt for Android: \title Getting Started with Qt for Android \brief Provides instructions to install and configure your development environment. +\section1 Requirements In order to use Qt for Android, you need the following: \list @@ -107,9 +108,13 @@ to install: You can install the binary package for Qt 5.1 or later to get Qt for Android. The \l{Qt Installation Program}{installer} containing the -binary packages are available for download from the +open-source binary packages are available for download from the \l{Opensource Downloads}{Qt project Downloads} page. +\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. diff --git a/doc/src/platforms/ios.qdoc b/doc/src/platforms/ios.qdoc index 457bbfc9b..b6586b51a 100644 --- a/doc/src/platforms/ios.qdoc +++ b/doc/src/platforms/ios.qdoc @@ -61,6 +61,10 @@ \li \l{Building Qt Sources}{Build from source} \endlist + \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 Xcode. You will find it in the App Store \l{Xcode}{here}. For running Qt applications in the simulator that comes with Xcode, @@ -79,8 +83,8 @@ 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 requirements are described - \l{General Qt Requirements}{here}. + 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: @@ -144,4 +148,3 @@ \l{https://qt-project.org/wiki/Mixing_C_and_ObjectiveC_Code}{here}. */ - diff --git a/doc/src/platforms/linux.qdoc b/doc/src/platforms/linux.qdoc index 81a4a810f..758968099 100644 --- a/doc/src/platforms/linux.qdoc +++ b/doc/src/platforms/linux.qdoc @@ -44,6 +44,9 @@ components you want to install and follow the instructions of the installation program to complete the installation. + \note Qt Enterprise packages are available from the \l{Try Qt Enterprise} + page. + The \l{Qt Installation Program} page contains the full installation procedure and the available installers for Linux distributions. diff --git a/doc/src/platforms/macosx.qdoc b/doc/src/platforms/macosx.qdoc index 17c0a7721..a311da1ab 100644 --- a/doc/src/platforms/macosx.qdoc +++ b/doc/src/platforms/macosx.qdoc @@ -50,6 +50,9 @@ runs like any executable on Mac OS X. With the installer, you can select the components you want. + \note Qt Enterprise packages are available from the \l{Try Qt Enterprise} + page. + The \l{Qt Installation Program} page contains the full installation procedure and the available installers. @@ -809,8 +812,8 @@ We assume that you already have installed Qt as frameworks, which is the default when installing Qt, in the /path/to/Qt - directory. For more information on how to build Qt, see the \l - Installation documentation. + directory. For more information on how to build Qt without Frameworks, + visit the \l{Qt for Mac OS X - Specific Issues} documentation. When installing, the identification name of the frameworks is set. This name is used by the dynamic linker (\c dyld) to find the libraries for your @@ -1056,14 +1059,12 @@ \snippet snippets/code/doc_src_deployment.qdoc 50 - Unlike the deployment processes on \l {Deploying an Application on - X11 Platforms}{X11} and \l {Deploying an Application on - Windows}{Windows}, compiler-specific libraries rarely have to - be redistributed with your application. But there are several ways to - deploy applications, as Qt can be configured, built, and installed in - several ways on Mac OS X. Typically your goals help determine how you - are going to deploy the application. The last sections describe a few - things that you must be aware of while deploying your application. + Compiler-specific libraries rarely have to be redistributed with your + application. But there are several ways to deploy applications, as Qt can be + configured, built, and installed in several ways on Mac OS X. Typically your + goals help determine how you are going to deploy the application. The last + sections describe a few things that you must be aware of while deploying + your application. \section2 Mac OS X Version Dependencies diff --git a/doc/src/platforms/platform-notes-qtee.qdoc b/doc/src/platforms/platform-notes-qtee.qdoc new file mode 100644 index 000000000..7d2d76df5 --- /dev/null +++ b/doc/src/platforms/platform-notes-qtee.qdoc @@ -0,0 +1,38 @@ +/**************************************************************************** +** +** Copyright (C) 2013 Digia Plc and/or its subsidiary(-ies). +** Contact: http://www.qt-project.org/legal +** +** This file is part of the documentation of the Qt Toolkit. +** +** $QT_BEGIN_LICENSE:FDL$ +** Commercial License Usage +** Licensees holding valid commercial Qt licenses may use this file in +** accordance with the commercial license agreement provided with the +** Software or, alternatively, in accordance with the terms contained in +** a written agreement between you and Digia. For licensing terms and +** conditions see http://qt.digia.com/licensing. For further information +** use the contact form at http://qt.digia.com/contact-us. +** +** GNU Free Documentation License Usage +** 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. Please review the following information to ensure +** the GNU Free Documentation License version 1.3 requirements +** will be met: http://www.gnu.org/copyleft/fdl.html. +** $QT_END_LICENSE$ +** +****************************************************************************/ + +/*! + \page platform-notes-qtee.html + \title Qt Enterprise Embedded + + Qt Enterprise Embedded, available under a commercial license, + supports Qt development on embedded Linux and embedded Android + devices. + + See \l http://qt.digia.com/Product/Qt-Enterprise-Embedded/ for + more information. +*/ diff --git a/doc/src/platforms/platform-notes.qdoc b/doc/src/platforms/platform-notes.qdoc deleted file mode 100644 index 492caca26..000000000 --- a/doc/src/platforms/platform-notes.qdoc +++ /dev/null @@ -1,73 +0,0 @@ -/**************************************************************************** -** -** Copyright (C) 2013 Digia Plc and/or its subsidiary(-ies). -** Contact: http://www.qt-project.org/legal -** -** This file is part of the documentation of the Qt Toolkit. -** -** $QT_BEGIN_LICENSE:FDL$ -** Commercial License Usage -** Licensees holding valid commercial Qt licenses may use this file in -** accordance with the commercial license agreement provided with the -** Software or, alternatively, in accordance with the terms contained in -** a written agreement between you and Digia. For licensing terms and -** conditions see http://qt.digia.com/licensing. For further information -** use the contact form at http://qt.digia.com/contact-us. -** -** GNU Free Documentation License Usage -** 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. Please review the following information to ensure -** the GNU Free Documentation License version 1.3 requirements -** will be met: http://www.gnu.org/copyleft/fdl.html. -** $QT_END_LICENSE$ -** -****************************************************************************/ - -/*! - \page platform-notes.html - \title Platform and Compiler Notes - \brief Information about the platforms on which Qt can be used. - - This page contains information about the platforms Qt is currently known - to run on, with links to platform-specific notes, including any known bugs - or incompatibilities. - - Information about the combinations of platforms and compilers - supported by Qt can be found on the \l{Supported Platforms} page. - - \list - \li \l{Platform and Compiler Notes - X11} - \tableofcontents{1 Platform and Compiler Notes - X11} - \li \l{Platform and Compiler Notes - Windows} - \tableofcontents{1 Platform and Compiler Notes - Windows} - \li \l{Platform and Compiler Notes - Mac OS X} - \tableofcontents{1 Platform and Compiler Notes - Mac OS X} - \li \l{Platform and Compiler Notes - QNX} - \tableofcontents{1 Platform and Compiler Notes - QNX} - \li \l{Platform and Compiler Notes - VxWorks} - \tableofcontents{1 Platform and Compiler Notes - VxWorks} - \li \l{Platform and Compiler Notes - Android} - \tableofcontents{1 Platform and Compiler Notes - Android} - \endlist - - \section1 General Compiler Notes - - \section2 Supported Features - - Qt can be compiled with any compiler that is compliant with the C++98 standard. C++11 - support is automatically enabled on compilers supporting it. - - Building Qt is currently being tested on the following list of compilers: - - \list - \li gcc 4.2.1 (Mac OS X only) - \li Apple clang 3.1 (Mac OS X / XCode 4) - \li gcc 4.5 and newer (Linux) - \li MSVC 2008 and newer - \li MinGW-builds GCC 4.7.2 - \li Intel CC (latest version) - \endlist - -*/ diff --git a/doc/src/platforms/supported-platforms.qdoc b/doc/src/platforms/supported-platforms.qdoc index d8beeb43c..3a9655759 100644 --- a/doc/src/platforms/supported-platforms.qdoc +++ b/doc/src/platforms/supported-platforms.qdoc @@ -53,20 +53,37 @@ \li \l{Qt for Mac OS X}{Mac OS X} \endlist - \section1 Embedded platforms + \section1 Embedded Platforms You can develop with Qt for the following embedded platforms: \list + \li \l{Qt Enterprise Embedded}{Embedded Android} \li Embedded Linux (DirectFB, EGLFS, KMS, and Wayland) \li \l{Windows CE - Introduction to using Qt}{Windows Embedded (Compact and Standard)} \li Real-Time Operating Systems, such as \l{QNX}, VxWorks and INTEGRITY \endlist - \section1 Mobile platforms - Qt 5 will support all leading mobile operating systems. There already exists work in progress support for: + \section1 Mobile Platforms + + You can develop with Qt for the following mobile platforms supported + by Digia: + \list \li \l{Qt for Android}{Android} \li \l{Qt for iOS}{iOS} + \endlist + + The following platforms also support Qt: + + \list \li \l{Qt for BlackBerry}{BlackBerry 10} + \li \l{Sailfish OS} + \endlist + + Work in progress ports of Qt exist for: + + \list + \li WinRT (including Windows Phone) + \li \l{Tizen} \endlist For more information about the Qt modules for mobile platforms, visit @@ -91,10 +108,18 @@ \li \l{http://sourceforge.net/projects/mingwbuilds/files/host-windows/releases/4.8.0/32-bit/threads-posix/dwarf/x32-4.8.0-release-posix-dwarf-rev1.7z}{MinGW-builds gcc 4.8.0 (32-bit)} \row \li Microsoft Windows 8 (32-bit and 64-bit) \li MSVC 2012 SP2 + \row \li Microsoft Windows 8.1 (32-bit and 64-bit) + \li MSVC 2012 SP2 \row \li Apple Mac OS X 10.7 "Lion", Cocoa (64-bit) \li Clang as provided by Apple \row \li Apple Mac OS X 10.8 "Mountain Lion", Cocoa (64-bit) \li Clang as provided by Apple + \row \li Apple Mac OS X 10.9 "Mavericks", Cocoa (64-bit) + \li Clang as provided by Apple + \row \li Apple iOS 6 + \li Clang as provided by Apple + \row \li Google Android 4.2 + \li As provided by Google (Android NDK 4.8) \endtable These reference configurations are run on the continuous integration (CI) diff --git a/doc/src/platforms/wince-customization.qdoc b/doc/src/platforms/wince-customization.qdoc index 19c908c32..6d76e43ae 100644 --- a/doc/src/platforms/wince-customization.qdoc +++ b/doc/src/platforms/wince-customization.qdoc @@ -104,17 +104,13 @@ However, it is possible to exclude features of Qt and create a version that compiles for the desired SDK. - Further information on stripping features can be found in the - \l{Fine-Tuning Features in Qt}{QFeatures} documentation. - - \section1 Making Qt Applications Start on a Custom Device Sometimes, a Windows CE device has been created with a configuration different from the corresponding SDK's configuration. In this case, symbols that were available at linking stage will be missing from the run-time libraries. - + Unfortunately, the operating system will not provide an error message that mentions which symbols are absent. Instead, a message box with the following message will appear: @@ -124,7 +120,7 @@ To identify the missing symbols, you need to create a temporary application that attempts to dynamically load the Qt for Windows CE libraries using \c LoadLibrary. The following code can be used for this: - + \snippet snippets/code/doc_src_wince-customization.cpp 9 Once you have compiled and deployed the application as well as the Qt @@ -132,7 +128,7 @@ ordinal number of the unresolved symbol. Search for parts of Qt that rely on these functions and disable them using - the \l{Fine-Tuning Features in Qt}{QFeatures} functionality. + the QFeatures functionality. In our experience, when Qt applications do not start on Windows CE, it is usually the result of missing symbols for the following classes or @@ -151,7 +147,7 @@ */ -/*! +/*! \page shadow builds-wince.html \ingroup qtce \title Windows CE - Using shadow builds diff --git a/doc/src/platforms/wince-introduction.qdoc b/doc/src/platforms/wince-introduction.qdoc index d3dccefca..4226f0b9c 100644 --- a/doc/src/platforms/wince-introduction.qdoc +++ b/doc/src/platforms/wince-introduction.qdoc @@ -52,8 +52,6 @@ \li \list \li \l {Qt for Windows CE Hardware Accelerated Graphics}{Hardware Accelerated Graphics} - \li \l {Qt Performance Tuning} - \li \l {Fine-Tuning Features in Qt} \endlist \endtable */ diff --git a/doc/src/platforms/windows.qdoc b/doc/src/platforms/windows.qdoc index 61f8021a3..a0913c701 100644 --- a/doc/src/platforms/windows.qdoc +++ b/doc/src/platforms/windows.qdoc @@ -48,6 +48,9 @@ components you want to install and follow the instructions of the installation program to complete the installation. + \note Qt Enterprise packages are available from the \l{Try Qt Enterprise} + page. + The \l{Qt Installation Program} page contains the full installation procedure and the available installers for the different Windows versions. |