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

Doc: Update info about previewing on Boot2Qt devices

Browse Source 
- macOS is supported since Qt 6.5, so just link to the
  Boot2Qt docs.
- Some writing style changes.
- Change the product name macro back to \QC, as the info
  applies to both products.
- Move the link targets for Boot2Qt docs to external-resources.qdoc,
  so that they can be maintained in one place.

Change-Id: Id749dbd58465106108a542db9822080942e12f1b
Reviewed-by: Samuli Piippo <samuli.piippo@qt.io>
Reviewed-by: Eike Ziller <eike.ziller@qt.io>
This commit is contained in:
Leena Miettinen
2024-03-27 10:24:56 +01:00
parent 68492d9dcc
commit 87fb3358d1
7 changed files with 33 additions and 40 deletions
Download Patch File Download Diff File Expand all files Collapse all files

4
doc/qtcreator/src/analyze/cpu-usage-analyzer.qdoc
View File

@@ -430,8 +430,8 @@
The Performance Analyzer can read Perf data files generated in either frame
pointer or dwarf mode. However, to generate the files correctly, numerous
preconditions have to be met. All system images for the
\l{https://doc.qt.io/Boot2Qt/qtdc-supported-platforms.html}
{Boot2Qt:Supported Target Devices and Development Hosts} are correctly set
\l{Support Levels for Target Hardware}{supported embedded platforms}
are correctly set
up for profiling in the dwarf mode. For other devices, check whether Perf
can read back its own data in a sensible way by checking the output of
\c {perf report} or \c {perf script} for the recorded Perf data files.

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

@@ -1,6 +1,14 @@
// Copyright (C) 2022 The Qt Company Ltd.
// SPDX-License-Identifier: LicenseRef-Qt-Commercial OR GFDL-1.3-no-invariants-only
/*!
\externalpage https://doc.qt.io/Boot2Qt/index.html
\title Boot2Qt: Documentation
*/
/*!
\externalpage https://doc.qt.io/Boot2Qt/b2qt-requirements-x11.html#setting-up-usb-access-to-embedded-devices
\title Boot2Qt: Setting Up USB Access to Embedded Devices
*/
/*!
\externalpage https://doc.qt.io/qt/qtqml-index.html
\title Qt Qml

5
doc/qtcreator/src/linux-mobile/b2qtdev.qdoc
View File

@@ -47,8 +47,7 @@
\note On Ubuntu Linux, the development user account must have access to the
plugged-in devices. To grant them access to the device via USB, create a new
\c udev rule, as described in
\l{https://doc.qt.io/Boot2Qt/b2qt-requirements-x11.html#setting-up-usb-access-to-embedded-devices}
{Boot2Qt: Setting Up USB Access to Embedded Devices}.
\l{Boot2Qt: Setting Up USB Access to Embedded Devices}.
You can edit the settings later in \preferences >
\uicontrol Devices > \uicontrol Devices.
@@ -149,4 +148,6 @@
application files to the device. For more information, see
\l{Boot2Qt Run Settings}.
\endlist
\sa {Boot2Qt: Setting Up USB Access to Embedded Devices}
*/

8
doc/qtcreator/src/linux-mobile/creator-embedded-platforms.qdoc
View File

@@ -46,17 +46,11 @@
tools to customize the contents of the stack and to take it into
production hardware.
You need either Windows 10 64-bit or later or Ubuntu Linux 64-bit 20.04 LTS
or later to install and use Boot2Qt.
The following topics have more information about developing applications
for Boot2Qt devices:
\list
\li \l{https://doc.qt.io/Boot2Qt/qtdc-supported-platforms.html}
{Boot2Qt: Supported Target Devices and Development Hosts}
\li \l{https://doc.qt.io/Boot2Qt/b2qt-installation-guides.html}
{Boot2Qt: Installation Guides}
\li \l{Boot2Qt: Documentation}
\li \l{Connecting Boot2Qt Devices}
\li \l{Boot2Qt Run Settings}
\li \l{Deploying to Boot2Qt}

11
doc/qtcreator/src/projects/creator-only/creator-projects-build-run-tutorial.qdoc
View File

@@ -28,8 +28,7 @@
To run an example application on a Boot2Qt device, you must set up
Boot2Qt on the development host and create connections
between the host and devices. For more information, see
\l{https://doc.qt.io/Boot2Qt/b2qt-installation-guides.html}
{Boot2Qt: Installation Guides}
\l{Boot2Qt: Documentation}.
If you have \l{Qt Design Studio Manual}{\QDS} installed, you can open
\QDS examples from \QC in \QDS.
@@ -70,9 +69,8 @@
If build errors occur, check that you have a Qt version, a
\l{Add compilers}{compiler}, and the necessary kits installed. If
you are building for an \l{Connecting Android Devices}{Android device}
or \l{Connecting iOS Devices}{iOS device}, check that you set up the
development environment correctly.
you are building for an Android or iOS device, check that you set up
the development environment correctly.
The \uicontrol Build progress bar on the toolbar turns green when
you build the project successfully. The application opens on the
@@ -80,4 +78,7 @@
\endlist
\sa {Add compilers}, {Add kits}, {Add Qt versions},
{Connecting Android Devices}, {Connecting iOS Devices},
{Compile Output}, {Boot2Qt: Documentation}, {Qt Design Studio Manual}
*/

4
doc/qtcreator/src/projects/creator-only/creator-projects-kits.qdoc
View File

@@ -27,9 +27,7 @@
\list
\li \l{Connecting Android Devices}{Android}
\li \l{Connecting Bare Metal Devices}{Bare Metal}
\li \l{https://doc.qt.io/Boot2Qt/b2qt-installation-guides.html}
{Boot2Qt} (commercial only)
\li \l{Emulator}{Boot2Qt Emulator} (commercial only)
\li \l{Boot2Qt: Documentation}{Boot2Q} (commercial only)
\li \l{Adding Docker Devices}{Docker} (experimental)
\li \l{Connecting iOS Devices}{iOS}
\li iOS Simulator

33
doc/qtcreator/src/qtquick/qtquick-live-preview-devices.qdoc
View File

@@ -11,10 +11,10 @@
\endif
\title Previewing on Devices
To preview UIs on Android devices, you need to enable USB debugging on them
To preview UIs on Android devices, enable USB debugging on them
and connect them to your system with a USB cable.
To preview UIs on Boot2Qt devices, you need to connect the devices to your
To preview UIs on Boot2Qt devices, connect the devices to your
system with a USB cable, or a wired or wireless connection, depending on
the device, and configure connections to them. The necessary kits have been
predefined and you only need to enable them for your current project.
@@ -23,8 +23,8 @@
necessary files to a location in a device where you want to run the
executable at.
\note To preview on a wirelessly connected device, select \preferences > \uicontrol Devices
and connect the device.
\note To preview on a wirelessly connected device, go to \preferences >
\uicontrol Devices and connect the device.
To preview a UI on a device:
@@ -47,16 +47,16 @@
\section2 Previewing on Android Devices
The USB debugging feature on Android devices enables creating connections
to the devices from \QDS and running the preview utility on them.
With the USB debugging feature on Android devices, you can create connections
to the devices from \QC and run the preview utility on them.
Debugging is enabled in different ways on different Android devices.
Debugging is turned on in different ways on different Android devices.
Look for \uicontrol {USB Debugging} under \uicontrol {Developer Options}.
On some devices \uicontrol {Developer Options} is hidden and becomes visible
On some devices, \uicontrol {Developer Options} is hidden and becomes visible
when you tap the \uicontrol {Build number} field in \uicontrol Settings >
\uicontrol About several times.
After you have enabled debugging, connect the Android device to the system
After you turn on debugging, connect the Android device to the system
with a USB cable.
The first time you preview a UI on devices, the preview utility
@@ -66,17 +66,8 @@
\section2 Previewing on Boot2Qt Devices
You can preview UIs on Boot2Qt devices. For a list of supported devices, see
\l{https://doc.qt.io/Boot2Qt/qtdc-supported-platforms.html}
{Boot2Qt: Supported Target Devices and Development Hosts}.
You can preview UIs on supported Boot2Qt devices that you configure as
instructed in the Boot2Qt documentation.
You must configure the device as instructed in the
\l{https://doc.qt.io/Boot2Qt/b2qt-installation-guides.html}
{Boot2Qt: Installation Guides}.
\note At the time of this writing, \macos is not supported as a development
host for Boot2Qt. This means that you cannot preview UIs on
devices if you are using \QC on \macos. For more information, see
\l {https://doc.qt.io/Boot2Qt/qtdc-supported-platforms.html#supported-development-hosts}
{Boot2Qt: Supported Development Hosts}.
\sa {Boot2Qt: Documentation}, {Support Levels for Target Hardware}
*/