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

Doc: Fix method to ignore Boot2Qt for auto-linking

Browse Source 
Removed the backslash from \Boot2Qt, and added Boot2Qt in ignorewords
in .qdocconf file. Created explicit links to the Boot2Qt topic in
this manual where needed.

Task-number: QTCREATORBUG-26278
Change-Id: Ieac851f711d7a2cd4d7ae034c3b81ab47c5fbc11
Reviewed-by: Topi Reiniö <topi.reinio@qt.io>
This commit is contained in:
Leena Miettinen
2021-11-23 10:44:37 +01:00
parent 6eec40264f
commit 60f2b81773
4 changed files with 14 additions and 13 deletions
Download Patch File Download Diff File Expand all files Collapse all files

1
doc/qtcreator/config/qtcreator-project.qdocconf
View File

@@ -4,6 +4,7 @@ url = http://doc.qt.io/$IDE_ID
#Words to ignore for auto-linking
ignorewords += \
Boot2Qt \
macOS \
WebChannel \
WebSocket \

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

@@ -460,7 +460,7 @@
\list 1
\li Perf events may be globally disabled on your system. The
preconfigured Boot2Qt images come with perf events enabled. For
preconfigured \l Boot2Qt images come with perf events enabled. For
a custom configuration you need to make sure that the file
\c {/proc/sys/kernel/perf_event_paranoid} contains a value smaller
than \c {2}. For maximum flexibility in recording traces you can

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

@@ -33,22 +33,22 @@
You can connect \l{Boot2Qt} devices to the development PC to run, debug,
and analyze applications built for them from \QC.
If you have a tool chain for building applications for \Boot2Qt devices
If you have a tool chain for building applications for Boot2Qt devices
installed on the development PC, you can add it to \QC. You can then
select a \l{glossary-buildandrun-kit}{kit} with the \uicontrol \Boot2Qt
select a \l{glossary-buildandrun-kit}{kit} with the \uicontrol Boot2Qt
device type to build applications for and run them on the devices.
To be able to run and debug applications on \Boot2Qt devices,
To be able to run and debug applications on Boot2Qt devices,
you must add devices and select them in the \QC
\l{glossary-buildandrun-kit}{kit}.
\section1 Enabling the Boot2Qt Plugin
To enable the \Boot2Qt plugin:
To enable the Boot2Qt plugin:
\list 1
\li Select \uicontrol Help > \uicontrol {About Plugins} >
\uicontrol {Device Support} > \uicontrol \Boot2Qt to
\uicontrol {Device Support} > \uicontrol Boot2Qt to
enable the plugin.
\li Select \uicontrol {Restart Now} to restart \QC and load the plugin.
\endlist
@@ -93,7 +93,7 @@
\section1 Flashing Boot2Qt Devices
To flash the \Boot2Qt image to an SD card with Flashing Wizard, select
To flash the Boot2Qt image to an SD card with Flashing Wizard, select
\uicontrol Tools > \uicontrol {Flash Boot to Qt Device} and follow the
instructions of the wizard.
@@ -101,7 +101,7 @@
\section1 Configuring Connections
To configure connections between \QC and a \Boot2Qt device and to
To configure connections between \QC and a Boot2Qt device and to
specify build and run settings for the device:
\list 1
@@ -109,19 +109,19 @@
connect it with a USB connection.
\li Select \uicontrol Tools > \uicontrol Options > \uicontrol Kits >
\uicontrol {Qt Versions} > \uicontrol Add to add the Qt version
for \Boot2Qt.
for Boot2Qt.
\li Select \uicontrol Tools > \uicontrol Options > \uicontrol Kits >
\uicontrol Compilers > \uicontrol Add to add the compiler for
building the applications.
\li Select \uicontrol Tools > \uicontrol {Flash Boot to Qt Device}
to flash the \Boot2Qt image to an SD card with Flashing Wizard.
to flash the Boot2Qt image to an SD card with Flashing Wizard.
\li To deploy applications and run them remotely on devices, specify
parameters for connecting to the devices over the network (\QC
automatically detects devices connected with USB):
\list 1
\li Select \uicontrol Tools > \uicontrol Options >
\uicontrol Devices > \uicontrol Devices > \uicontrol Add >
\uicontrol \Boot2Qt > \uicontrol {Finish}.
\uicontrol Boot2Qt > \uicontrol {Finish}.
\image qtcreator-devices-boot2qt.png "Boot2Qt Network Device Setup wizard"
\li In the \uicontrol {Device name} field, enter a name for
the connection.
@@ -139,7 +139,7 @@
\li Select \uicontrol Tools > \uicontrol Options > \uicontrol Kits >
\uicontrol Add to add a kit for building applications for the
device. Select the Qt version, compiler, and device that you
added above, and choose \uicontrol \Boot2Qt as the device type.
added above, and choose \uicontrol Boot2Qt as the device type.
\li To specify build settings:
\list 1
\li Open a project for an application you want to develop for the

2
doc/qtcreator/src/linux-mobile/creator-projects-settings-run-b2qt.qdocinc
View File

@@ -28,7 +28,7 @@
\section1 Specifying Run Settings for Boot2Qt Devices
To run and debug an application on a Boot2Qt device (commercial only), you
To run and debug an application on a \l Boot2Qt device (commercial only), you
must create connections from the development host to the device and add the
device configurations to \l{glossary-buildandrun-kit}{kits}. Select
\uicontrol {Manage Kits} to add devices to kits. For more information, see