summaryrefslogtreecommitdiff
path: root/doc/src
diff options
context:
space:
mode:
authorJerome Pasion <jerome.pasion@digia.com>2013-09-30 17:33:05 +0200
committerThe Qt Project <gerrit-noreply@qt-project.org>2013-10-01 14:25:16 +0200
commit869944c81b6fd07877f0a221b0725f9f1157ce76 (patch)
treeb234978bb7938cf540b80279468857e1fa057895 /doc/src
parentf8ca8303723b47b240a4dbd6e6d6fe5ea98069f3 (diff)
downloadqtdoc-869944c81b6fd07877f0a221b0725f9f1157ce76.tar.gz
Doc: Converted "installation" group to a regular page.
-regular page doesn't list the group members, allowing extra content to be listed and gives control on the layout of information -renamed "Installation" to "Building Qt Sources" as it is a more precise name -Added links to the "Building Qt Sources" page where it makes sense. Change-Id: I074bc5c17edf2bc096bcfc8f6d102b469929ede0 Reviewed-by: Leena Miettinen <riitta-leena.miettinen@digia.com> Reviewed-by: Nico Vertriest <nico.vertriest@digia.com> Reviewed-by: Martin Smith <martin.smith@digia.com>
Diffstat (limited to 'doc/src')
-rw-r--r--doc/src/getting-started/gettingstarted.qdoc2
-rw-r--r--doc/src/getting-started/installation.qdoc108
-rw-r--r--doc/src/platforms/linux.qdoc2
-rw-r--r--doc/src/platforms/macosx.qdoc2
-rw-r--r--doc/src/platforms/supported-platforms.qdoc10
-rw-r--r--doc/src/platforms/windows.qdoc1
6 files changed, 69 insertions, 56 deletions
diff --git a/doc/src/getting-started/gettingstarted.qdoc b/doc/src/getting-started/gettingstarted.qdoc
index 22627424..769ef838 100644
--- a/doc/src/getting-started/gettingstarted.qdoc
+++ b/doc/src/getting-started/gettingstarted.qdoc
@@ -47,7 +47,7 @@
Qt may also be installed from the sources. Simply download the sources
(available from the \l{Opensource Downloads}{Downloads} page) and follow the
instructions according to the development platform page here:
- \l Installation.
+ \l{Building Qt Sources}.
\section1 Exploring the Tools
diff --git a/doc/src/getting-started/installation.qdoc b/doc/src/getting-started/installation.qdoc
index 5318061c..d7616768 100644
--- a/doc/src/getting-started/installation.qdoc
+++ b/doc/src/getting-started/installation.qdoc
@@ -26,21 +26,75 @@
****************************************************************************/
/*!
-\group installation
-\title Installation
-\brief Installing Qt on supported platforms.
+\page build-sources.html
+\title Building Qt Sources
+\brief Building Qt from the source packages
-The installation procedure is different on each Qt platform. This page provides
-information on how to install Qt, as well as software and hardware requirements
-for using Qt on each of the supported platforms. Please follow the instructions
-for your platform from the following list.
+There are two ways to install Qt:
+\list 1
+\li through the \l{Qt Installation Program} - downloads and installs Qt
+\li through the \e{Qt sources}. You can download the Qt 5 sources from \l{http://qt-
+project.org/downloads}.
+\endlist
+
+This page lists the relevant information for installing Qt by building the Qt
+sources. The installation procedure is different on each Qt platform. This page
+collects the relevant information for the \l{Supported Platforms}.
+
+\section1 General Installation Information
+
+Building Qt revolves around using \c configure to configure Qt for a particular
+platform with a particular set of Qt features or modules. For more information,
+visit the following page:
+
+\list
+\li \l{Qt Configure Options}
+\endlist
+
+\section1 Windows
+
+\list
+\li \l{Qt for Windows - Requirements}
+\li \l{Qt for Windows - Building from Source}
+\endlist
+
+\section1 Mac OSX
+
+\list
+\li \l{Qt for Mac OS X - Requirements}
+\li \l{Qt for Mac OS X - Building from Source}
+\endlist
+
+\section1 Linux/X11
+
+\list
+\li \l{Qt for X11 Requirements}
+\li \l{Qt for Linux/X11 - Building from Source}
+\endlist
+
+\section1 Windows CE
+
+\list
+\li \l{Qt for Windows CE Requirements}
+\li \l{Installing Qt for Windows CE}
+\endlist
+
+\section1 OpenSSL (version 1.0.0 or later)
+
+Support for \l{SSL}{Secure Sockets Layer (SSL)} communication is provided by the
+\l{OpenSSL Toolkit}, which must be obtained separately.
+
+From Qt version 5.2 onwards, the officially supported version for OpenSSL is 1.0.0
+or later. Versions >= 0.9.7 and < 1.0.0 might work, but are not guaranteed to.
+
+More information about enabling SSL support can be found in the
+\l{Secure Sockets Layer (SSL) Classes} document.
*/
/*!
\page install-wince.html
\title Installing Qt for Windows CE
-\ingroup installation
\ingroup qtce
\brief How to install Qt for Windows CE.
\previouspage Installation
@@ -119,46 +173,8 @@ in the \l{Qt for Windows CE Requirements} document.
*/
/*!
- \page requirements.html
- \title General Qt Requirements
- \ingroup installation
- \brief Outlines the general requirements and dependencies needed to install Qt.
-
- This page describes the specific requirements of libraries and components on which
- Qt depends. For information about installing Qt, see the \l{Installation} page.
-
- For information about the platforms that Qt supports, see the \l{Supported Platforms}
- page.
-
- \section1 OpenSSL (version 1.0.0 or later)
-
- Support for \l{SSL}{Secure Sockets Layer (SSL)} communication is provided by the
- \l{OpenSSL Toolkit}, which must be obtained separately.
-
- From Qt version 5.2 onwards, the officially supported version for OpenSSL is 1.0.0
- or later. Versions >= 0.9.7 and < 1.0.0 might work, but are not guaranteed to.
-
- More information about enabling SSL support can be found in the
- \l{Secure Sockets Layer (SSL) Classes} document.
-
- \section1 Platform-Specific Requirements
-
- Each platform has its own specific set of dependencies. Please see the relevant
- page for more details about the components that are required to build and install
- Qt on your platform.
-
- \list
- \li \l{Qt for Mac OS X Requirements}
- \li \l{Qt for Windows CE Requirements}
- \li \l{Qt for Windows Requirements}
- \li \l{Qt for X11 Requirements}
- \endlist
-*/
-
-/*!
\page requirements-wince.html
\title Qt for Windows CE Requirements
- \ingroup installation
\brief Setting up the Windows CE environment for Qt.
\previouspage General Qt Requirements
diff --git a/doc/src/platforms/linux.qdoc b/doc/src/platforms/linux.qdoc
index 94535df5..b2973933 100644
--- a/doc/src/platforms/linux.qdoc
+++ b/doc/src/platforms/linux.qdoc
@@ -89,7 +89,6 @@
/*!
\page linux-requirements.html
\title Qt for X11 Requirements
- \ingroup installation
\brief Setting up the X11 environment for Qt.
\section1 Platform plugin dependencies
@@ -338,7 +337,6 @@
/*!
\page linux-building.html
\title Qt for Linux/X11 - Building from Source
- \ingroup installation
\brief How to configure and build Qt on Linux/X11 platforms.
Qt for X11 has some requirements that are given in more detail
diff --git a/doc/src/platforms/macosx.qdoc b/doc/src/platforms/macosx.qdoc
index b4dd7847..b0527470 100644
--- a/doc/src/platforms/macosx.qdoc
+++ b/doc/src/platforms/macosx.qdoc
@@ -171,7 +171,6 @@
/*!
\page macosx-requirements.html
\title Qt for Mac OS X - Requirements
- \ingroup installation
\brief Setting up the Mac OS X environment for Qt.
\previouspage General Qt Requirements
@@ -199,7 +198,6 @@
/*!
\page macosx-building.html
\title Qt for Mac OS X - Building from Source
- \ingroup installation
\brief How to install Qt on Mac OS X.
Qt for Mac OS X has some requirements that are given in more detail
diff --git a/doc/src/platforms/supported-platforms.qdoc b/doc/src/platforms/supported-platforms.qdoc
index 3e309f61..53570c63 100644
--- a/doc/src/platforms/supported-platforms.qdoc
+++ b/doc/src/platforms/supported-platforms.qdoc
@@ -130,14 +130,16 @@
are able to provide assistance with various different supported
platforms and configurations.
- \section1 Availability of Binary Installation Packages
+ \section1 Availability of Packages
The Qt Project provides binary Qt installation packages for all of the
reference platforms from \l{http://qt-project.org/downloads}. The site
- provides download links for all supported development platforms.
+ provides download links for all supported development platforms. The
+ \l{Qt Installation Program} page has more information about the installers.
- The \l{Qt Installation Program} page has more information about the
- installers.
+ Source packages are also found in the downloads page.
+ The \l{Building Qt Sources} page has more information about compiling
+ Qt from the source packages.
\section1 Deployment of Qt Applications
diff --git a/doc/src/platforms/windows.qdoc b/doc/src/platforms/windows.qdoc
index c61bfc08..7a1ee25f 100644
--- a/doc/src/platforms/windows.qdoc
+++ b/doc/src/platforms/windows.qdoc
@@ -741,7 +741,6 @@
/*!
\page windows-building.html
\title Qt for Windows - Building from Source
- \ingroup installation
\brief Configuring and building Qt for Windows.
This page describes the process of configuring and building