feedc0de/qt-creator
1
0
Fork 0
forked from qt-creator/qt-creator
Code Pull Requests Activity

Doc: Collect links to platform-specific topics in one place

Browse Source 
Fixes: QTBUG-84223
Change-Id: I03eeb61f457ca624ade8591db2728962f4cc4021
Reviewed-by: Assam Boudjelthia <assam.boudjelthia@qt.io>
Reviewed-by: Venugopal Shivashankar <Venugopal.Shivashankar@qt.io>
This commit is contained in:
Leena Miettinen
2020-06-03 15:06:21 +02:00
parent 195cc8cd20
commit 93d5ed4073
8 changed files with 392 additions and 216 deletions
Download Patch File Download Diff File Expand all files Collapse all files

10
doc/qtcreator/src/external-resources/external-resources.qdoc
View File

@@ -25,16 +25,6 @@
**
****************************************************************************/
/*
This prevents autolinking of each occurrence of 'macOS'.
Explicit links will still work (\l macOS).
*/
/*!
\externalpage nolink
\title macOS
\internal
*/
/*!
\externalpage https://doc.qt.io/QtForMCUs/qtul-environment.html
\title Qt for MCUs - Supported Target Platforms

134
doc/qtcreator/src/linux-mobile/creator-embedded-platforms.qdoc Normal file
View File

@@ -0,0 +1,134 @@
/****************************************************************************
**
** Copyright (C) 2020 The Qt Company Ltd.
** Contact: https://www.qt.io/licensing/
**
** This file is part of the Qt Creator documentation.
**
** 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 The Qt Company. For licensing terms
** and conditions see https://www.qt.io/terms-conditions. For further
** information use the contact form at https://www.qt.io/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: https://www.gnu.org/licenses/fdl-1.3.html.
**
****************************************************************************/
/*!
\page creator-embedded-platforms.html
\previouspage creator-desktop-platforms.html
\nextpage creator-mobile-platforms.html
\title Embedded Platforms
You can develop applications for the following embedded platforms:
\list
\li \l {Bare Metal}
\li \l {Boot2Qt}
\li \l {Generic Remote Linux}
\li \l {Microcontroller Units (MCU)}
\li \l QNX
\endlist
You must install the tool chain for building applications for the targeted
embedded platform on the development PC and use the Qt Maintenance Tool to
install Qt libraries that are built for the platform. You can then add a
\l{glossary-buildandrun-kit}{kit} with the tool chain and the Qt version
for the device's architecture. When possible, the Maintenance Tool creates
suitable kits for you.
You can connect embedded devices to the development PC to run, debug, and
analyze applications built for them from \QC.
\section1 Bare Metal
You can run and debug applications on small devices that are not supported
by the generic remote Linux device plugin by using GDB or a hardware
debugger.
For more information about developing applications for Bare Metal devices,
see \l{Connecting Bare Metal Devices}.
\section1 Boot2Qt
The Boot2Qt stack can be made to run on a variety of hardware. For
\l{https://doc.qt.io/QtForDeviceCreation/index.html}{Qt for Device Creation}
license holders, tooling is provided to customize the contents of the stack
as well as to take it into desired production hardware.
Either Windows 7 or later or Ubuntu Linux 64-bit 12.04 LTS
or later is required to install and use Qt for Device Creation.
The following topics contain more information about developing applications
for Boot2Qt devices:
\list
\li \l{https://doc.qt.io/QtForDeviceCreation/qtee-supported-platforms.html}
{Reference Target Devices and Development Hosts}
\li \l{https://doc.qt.io/QtForDeviceCreation/b2qt-installation-guides.html}
{Installation Guides}
\li \l{Specifying Run Settings for Boot2Qt Devices}
\li \l{https://doc.qt.io/qtcreator/creator-overview-qtasam.html}
{Qt Creator Plugin for Qt Application Manager}
\li \l{https://doc.qt.io/QtForDeviceCreation/index.html}
{Qt for Device Creation}
\endlist
\section1 Generic Remote Linux
You must have a tool chain for building applications for embedded Linux
devices installed on the development PC.
The following topics contain more information about developing applications
for generic remote Linux devices:
\list
\li \l{Connecting Generic Remote Linux Devices}
\li \l{Deploying Applications to Generic Remote Linux Devices}
\li \l{Specifying Run Settings for Linux-Based Devices}
\li \l{Running on Generic Remote Linux Devices}
\li \l{https://doc.qt.io/qtcreator/creator-overview-qtasam.html}
{Qt Creator Plugin for Qt Application Manager}
\endlist
\section1 Microcontroller Units (MCU)
You need the GNU Arm Embedded GCC compiler, libraries, and other GNU tools
necessary for bare metal software development on devices based on the Arm
Cortex-M processors.
The following topics contain more information about developing applications
for MCUs:
\list
\li \l{Connecting MCUs}
\li \l{Running Applications on MCUs}
\li \l{https://doc.qt.io/QtForMCUs/index.html}{Qt for MCUs}
\endlist
\section1 QNX
The QNX Neutrino RTOS should provide a few additional command line tools
and services, as described in \l {Qt Creator Target Requirements}.
The following topics contain more information about developing applications
for QNX devices:
\list
\li \l{Connecting QNX Devices}
\li \l{Deploying Applications to QNX Neutrino Devices}
\li \l{Specifying Run Settings for QNX Devices}
\li \l{Running on QNX Devices}
\li \l{Qt for QNX}
\endlist
*/

91
doc/qtcreator/src/overview/creator-only/creator-desktop-platforms.qdoc Normal file
View File

@@ -0,0 +1,91 @@
/****************************************************************************
**
** Copyright (C) 2020 The Qt Company Ltd.
** Contact: https://www.qt.io/licensing/
**
** This file is part of the Qt Creator documentation.
**
** 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 The Qt Company. For licensing terms
** and conditions see https://www.qt.io/terms-conditions. For further
** information use the contact form at https://www.qt.io/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: https://www.gnu.org/licenses/fdl-1.3.html.
**
****************************************************************************/
/*!
\page creator-desktop-platforms.html
\previouspage creator-os-supported-platforms.html
\nextpage creator-embedded-platforms.html
\title Desktop Platforms
\QC is available in binary packages for the following operating systems:
\list
\li \l Linux
\li \l macOS
\li \l Windows
\endlist
You can use \QC to build, run, debug, and analyze applications on these
platforms.
\section1 Linux
(K)Ubuntu Linux 16.04 (64-bit) or later is supported.
To build Qt applications using \QC on Linux, you usually need the
following:
\list
\li g++
\li make
\li libglib2.0-dev
\li libSM-dev
\li libxrender-dev
\li libfontconfig1-dev
\li libxext-dev
\li libfreetype6-dev
\li libx11-dev
\li libxcursor-dev
\li libxfixes-dev
\li libxft-dev
\li libxi-dev
\li libxrandr-dev
\li libgl-dev and libglu-dev if you use Qt OpenGL (deprecated
in Qt 5) or Qt GUI OpenGL functions
\endlist
\section1 macOS
\macos 10.13 or later is supported with the Xcode tools for your \macos
version available in the Mac App Store.
\section1 Windows
Windows 7 or later is supported.
\note Some \QC plugins rely on Direct3D (part of DirectX). You might
have to manually enable support for it if you are running Windows in a
Virtual Machine. For more information, see
\l{http://www.virtualbox.org/manual/ch04.html#guestadd-3d}
{Hardware 3D acceleration (OpenGL and Direct3D 8/9)} and
\l{http://pubs.vmware.com/workstation-10/index.jsp?topic=%2Fcom.vmware.ws.using.doc%2FGUID-EA588485-718A-4FD8-81F5-B6E1F04C5788.html}
{Prepare the Host System to Use DirectX 9 Accelerated Graphics}.
\section1 Compiling from Source
To build \QC from the source, see the requirements and instructions in the
readme file that is located in the source repository.
*/

97
doc/qtcreator/src/overview/creator-only/creator-mobile-platforms.qdoc Normal file
View File

@@ -0,0 +1,97 @@
/****************************************************************************
**
** Copyright (C) 2020 The Qt Company Ltd.
** Contact: https://www.qt.io/licensing/
**
** This file is part of the Qt Creator documentation.
**
** 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 The Qt Company. For licensing terms
** and conditions see https://www.qt.io/terms-conditions. For further
** information use the contact form at https://www.qt.io/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: https://www.gnu.org/licenses/fdl-1.3.html.
**
****************************************************************************/
/*!
\page creator-mobile-platforms.html
\previouspage creator-embedded-platforms.html
\nextpage creator-project-other.html
\title Mobile Platforms
You can develop applications for the following mobile platforms:
\list
\li \l Android
\li \l iOS
\li \l {Universal Windows Platform (UWP)}
\endlist
You must install the tool chain for building applications for the targeted
mobile platform on the development PC and use the Qt Maintenance Tool to
install Qt libraries that are built for the platform. You can then add a
\l{glossary-buildandrun-kit}{kit} with the tool chain and the Qt version
for the device's architecture. When possible, the Maintenance Tool creates
suitable kits for you.
You can connect mobile devices to the development PC and select the
appropriate kit to build, run, debug, and analyze applications from \QC.
\section1 Android
Starting from Qt 5.14.0, the Qt for Android package contains all the
architectures (ABIs) installed as one. You can let \QC automatically
create kits for installed Qt version and tool chains.
The following topics contain more information about developing applications
for Android devices:
\list
\li \l{Connecting Android Devices}
\li \l{Deploying Applications to Android Devices}
\li \l{Running on Multiple Platforms}
\li \l{Creating a Mobile Application}
\li \l{Debugging on Android Devices}
\li \l{Qt for Android}
\endlist
\section1 iOS
To be able to use \QC on \macos, you must install Xcode, and therefore
you should already have the tool chain for building applications for
iOS. \QC automatically detects the tool chain and creates the necessary
kits to build applications for and run them on configured iOS devices.
The following topics contain more information about developing applications
for iOS devices:
\list
\li \l{Connecting iOS Devices}
\li \l{Running on Multiple Platforms}
\li \l{Creating a Mobile Application}
\li \l{Qt for iOS}
\endlist
\section1 Universal Windows Platform (UWP)
Microsoft Windows 10 introduced the Universal Windows Platform (UWP),
which provides a common application platform on every device that runs
Windows 10, as a successor to Windows Runtime (WinRT) introduced by
Windows 8. The UWP core APIs are the same on all Windows devices, and
therefore applications that only use the core APIs will run on any
Windows 10 device, such as a desktop PC, or Xbox One.
For more information about developing applications for UWP, see
\l{Qt for UWP}.
*/

2
doc/qtcreator/src/overview/creator-only/creator-mobile-targets.qdoc
View File

@@ -114,7 +114,7 @@
You can use the experimental Qt Application Manager plugin
(commercial only) to deploy, run, and debug applications on the
local Linux PC, remote generic SSH Linux targets, or
\l{Boot2Qt Devices}{Boot2Qt devices}.
\l{Boot2Qt}{Boot2Qt devices}.
\endlist
\endif
*/

153
doc/qtcreator/src/overview/creator-only/creator-supported-platforms.qdoc
View File

@@ -1,6 +1,6 @@
/****************************************************************************
**
** Copyright (C) 2019 The Qt Company Ltd.
** Copyright (C) 2020 The Qt Company Ltd.
** Contact: https://www.qt.io/licensing/
**
** This file is part of the Qt Creator documentation.
@@ -23,17 +23,10 @@
**
****************************************************************************/
// **********************************************************************
// NOTE: the sections are not ordered by their logical order to avoid
// reshuffling the file each time the index order changes (i.e., often).
// Run the fixnavi.pl script to adjust the links to the index order.
// **********************************************************************
/*!
\previouspage creator-advanced.html
\page creator-os-supported-platforms.html
\nextpage creator-project-other.html
\nextpage creator-desktop-platforms.html
\title Supported Platforms
@@ -41,91 +34,73 @@
applications for multiple desktop, embedded, and mobile device platforms,
as well as web browsers (experimental).
The following table summarizes operating system support for developing
applications.
\table
\header
\li {1,2} Target Platform
\li {3,1} Development Platform
\header
\li \l Linux
\li \l macOS
\li \l Windows
\row
\li \l Android
\li \image ok
\li \image ok
\li \image ok
\row
\li \l{Bare Metal}
\li \image ok
\li \image ok
\li \image ok
\row
\li \l Boot2Qt
\li \image ok
\li \image ok
\li \image ok
\row
\li \l{Generic Remote Linux}
\li \image ok
\li \image ok
\li \image ok
\row
\li \l iOS
\li
\li \image ok
\li
\row
\li \l{Microcontroller Units (MCU)}{MCUs}
\li
\li
\li \image ok
\row
\li \l QNX
\li \image ok
\li \image ok
\li \inlineimage ok
\row
\li \l{Universal Windows Platform (UWP)}{UWP}
\li
\li
\li \image ok
\row
\li \l{Building Applications for the Web}{WebAssembly}
\li \image ok
\li \image ok
\li \image ok
\endtable
\QC automatically runs scheduled checks for updates based on the settings
specified in \uicontrol Tools > \uicontrol Options \uicontrol Environment >
\uicontrol Update.
\section1 Development Platforms
\QC is available in binary packages for the following operating systems:
For more information on the requirements for each platform, see:
\list
\li Windows 7 or later
\note Some \QC plugins rely on Direct3D (part of DirectX). You might
have to manually enable support for it if you are running Windows in a
Virtual Machine. For more information, see
\l{http://www.virtualbox.org/manual/ch04.html#guestadd-3d}
{Hardware 3D acceleration (OpenGL and Direct3D 8/9)} and
\l{http://pubs.vmware.com/workstation-10/index.jsp?topic=%2Fcom.vmware.ws.using.doc%2FGUID-EA588485-718A-4FD8-81F5-B6E1F04C5788.html}
{Prepare the Host System to Use DirectX 9 Accelerated Graphics}.
\li (K)Ubuntu Linux 16.04 (64-bit) or later
To build Qt applications using \QC on Linux, you usually need the
following:
\list
\li g++
\li make
\li libglib2.0-dev
\li libSM-dev
\li libxrender-dev
\li libfontconfig1-dev
\li libxext-dev
\li libfreetype6-dev
\li libx11-dev
\li libxcursor-dev
\li libxfixes-dev
\li libxft-dev
\li libxi-dev
\li libxrandr-dev
\li libgl-dev and libglu-dev if you use Qt OpenGL (deprecated
in Qt 5) or Qt GUI OpenGL functions
\li \l {Desktop Platforms}
\li \l {Embedded Platforms}
\li \l {Mobile Platforms}
\endlist
\li \macos 10.13 or later with the following:
\list
\li Xcode tools for your \macos version available on the
Mac App Store.
\endlist
\endlist
\section2 Developing for Boot2Qt Devices
Either Windows 7 or later or Ubuntu Linux 64-bit 12.04 LTS or later is
required to install and use Qt for Device Creation. For more information
about the requirements for the development host, see the
\l{https://doc.qt.io/QtForDeviceCreation/b2qt-installation-guides.html}
{Installation Guides} in the
\l{https://doc.qt.io/QtForDeviceCreation/index.html}{Qt for Device Creation}
documentation.
\section1 Compiling from Source
To build \QC from the source, see the requirements and instructions in the
readme file that is located in the source repository.
\include creator-target-platforms.qdocinc target platforms
*/

116
doc/qtcreator/src/overview/creator-only/creator-target-platforms.qdocinc
View File

@@ -1,116 +0,0 @@
/****************************************************************************
**
** Copyright (C) 2020 The Qt Company Ltd.
** Contact: https://www.qt.io/licensing/
**
** This file is part of the Qt Creator documentation.
**
** 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 The Qt Company. For licensing terms
** and conditions see https://www.qt.io/terms-conditions. For further
** information use the contact form at https://www.qt.io/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: https://www.gnu.org/licenses/fdl-1.3.html.
**
****************************************************************************/
/*!
//! [target platforms]
\section1 Target Platforms
You can develop applications for the following platforms:
\list
\li Desktop
\li \l{Connecting Android Devices}{Android}
\li \l{Connecting Bare Metal Devices}{Bare Metal}
\li Boot2Qt
\li \l{Connecting Generic Remote Linux Devices}{Generic Remote Linux}
\li \l{Connecting iOS Devices}{iOS}
\li \l{Connecting MCUs}{Microcontroller Units (MCU)} (commercial only)
\li \l{Connecting QNX Devices}{QNX}
\li \l{Qt for UWP}{Universal Windows Platform (UWP)}
\li \l{Building Applications for the Web}{WebAssembly}
\endlist
\section2 Boot2Qt Devices
The Boot2Qt stack can be made to run on a variety of hardware. For
Qt for Device Creation license holders, tooling is provided to customize the
contents of the stack as well as to take it into desired production
hardware.
For more information about the supported device groups and reference devices,
see \l{https://doc.qt.io/QtForDeviceCreation/qtee-supported-platforms.html}
{Reference Target Devices and Development Hosts} in the
\l{https://doc.qt.io/QtForDeviceCreation/index.html}{Qt for Device Creation}
documentation.
\note Since \QC 4.9, only Boot2Qt version 5.9 and later are supported.
To develop for earlier Boot2Qt versions, use \QC 4.8.
\section2 Mobile Devices
The following table summarizes operating system support for developing
applications for mobile device platforms.
\table
\header
\li {1,2} Target Platform
\li {3,1} Development Platform
\header
\li Linux
\li \macos
\li Windows
\row
\li Android
\li \image ok
\li \image ok
\li \image ok
\row
\li Generic Remote Linux
\li \image ok
\li \image ok
\li \image ok
\row
\li iOS
\li
\li \image ok
\li
\row
\li MCUs
\li
\li
\li \image ok
\row
\li QNX
\li \image ok
\li \image ok
\li \inlineimage ok
*
\row
\li UWP
\li
\li
\li \image ok
\row
\li WebAssembly
\li \image ok
\li \image ok
\li \image ok
\endtable
* See \l{Running on QNX Devices} for limitations.
//! [target platforms]
*/

5
doc/qtcreator/src/qtcreator-toc.qdoc
View File

@@ -244,6 +244,11 @@
\li \l{Advanced Use}
\list
\li \l{Supported Platforms}
\list
\li \l {Desktop Platforms}
\li \l {Embedded Platforms}
\li \l {Mobile Platforms}
\endlist
\li \l{Using Other Build Systems}
\list
\li \l{Setting Up CMake}