forked from qt-creator/qt-creator
Doc: Fix method to ignore Boot2Qt for auto-linking
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:
@@ -4,6 +4,7 @@ url = http://doc.qt.io/$IDE_ID
|
|||||||
|
|
||||||
#Words to ignore for auto-linking
|
#Words to ignore for auto-linking
|
||||||
ignorewords += \
|
ignorewords += \
|
||||||
|
Boot2Qt \
|
||||||
macOS \
|
macOS \
|
||||||
WebChannel \
|
WebChannel \
|
||||||
WebSocket \
|
WebSocket \
|
||||||
|
@@ -460,7 +460,7 @@
|
|||||||
|
|
||||||
\list 1
|
\list 1
|
||||||
\li Perf events may be globally disabled on your system. The
|
\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
|
a custom configuration you need to make sure that the file
|
||||||
\c {/proc/sys/kernel/perf_event_paranoid} contains a value smaller
|
\c {/proc/sys/kernel/perf_event_paranoid} contains a value smaller
|
||||||
than \c {2}. For maximum flexibility in recording traces you can
|
than \c {2}. For maximum flexibility in recording traces you can
|
||||||
|
@@ -33,22 +33,22 @@
|
|||||||
You can connect \l{Boot2Qt} devices to the development PC to run, debug,
|
You can connect \l{Boot2Qt} devices to the development PC to run, debug,
|
||||||
and analyze applications built for them from \QC.
|
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
|
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.
|
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
|
you must add devices and select them in the \QC
|
||||||
\l{glossary-buildandrun-kit}{kit}.
|
\l{glossary-buildandrun-kit}{kit}.
|
||||||
|
|
||||||
\section1 Enabling the Boot2Qt Plugin
|
\section1 Enabling the Boot2Qt Plugin
|
||||||
|
|
||||||
To enable the \Boot2Qt plugin:
|
To enable the Boot2Qt plugin:
|
||||||
|
|
||||||
\list 1
|
\list 1
|
||||||
\li Select \uicontrol Help > \uicontrol {About Plugins} >
|
\li Select \uicontrol Help > \uicontrol {About Plugins} >
|
||||||
\uicontrol {Device Support} > \uicontrol \Boot2Qt to
|
\uicontrol {Device Support} > \uicontrol Boot2Qt to
|
||||||
enable the plugin.
|
enable the plugin.
|
||||||
\li Select \uicontrol {Restart Now} to restart \QC and load the plugin.
|
\li Select \uicontrol {Restart Now} to restart \QC and load the plugin.
|
||||||
\endlist
|
\endlist
|
||||||
@@ -93,7 +93,7 @@
|
|||||||
|
|
||||||
\section1 Flashing Boot2Qt Devices
|
\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
|
\uicontrol Tools > \uicontrol {Flash Boot to Qt Device} and follow the
|
||||||
instructions of the wizard.
|
instructions of the wizard.
|
||||||
|
|
||||||
@@ -101,7 +101,7 @@
|
|||||||
|
|
||||||
\section1 Configuring Connections
|
\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:
|
specify build and run settings for the device:
|
||||||
|
|
||||||
\list 1
|
\list 1
|
||||||
@@ -109,19 +109,19 @@
|
|||||||
connect it with a USB connection.
|
connect it with a USB connection.
|
||||||
\li Select \uicontrol Tools > \uicontrol Options > \uicontrol Kits >
|
\li Select \uicontrol Tools > \uicontrol Options > \uicontrol Kits >
|
||||||
\uicontrol {Qt Versions} > \uicontrol Add to add the Qt version
|
\uicontrol {Qt Versions} > \uicontrol Add to add the Qt version
|
||||||
for \Boot2Qt.
|
for Boot2Qt.
|
||||||
\li Select \uicontrol Tools > \uicontrol Options > \uicontrol Kits >
|
\li Select \uicontrol Tools > \uicontrol Options > \uicontrol Kits >
|
||||||
\uicontrol Compilers > \uicontrol Add to add the compiler for
|
\uicontrol Compilers > \uicontrol Add to add the compiler for
|
||||||
building the applications.
|
building the applications.
|
||||||
\li Select \uicontrol Tools > \uicontrol {Flash Boot to Qt Device}
|
\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
|
\li To deploy applications and run them remotely on devices, specify
|
||||||
parameters for connecting to the devices over the network (\QC
|
parameters for connecting to the devices over the network (\QC
|
||||||
automatically detects devices connected with USB):
|
automatically detects devices connected with USB):
|
||||||
\list 1
|
\list 1
|
||||||
\li Select \uicontrol Tools > \uicontrol Options >
|
\li Select \uicontrol Tools > \uicontrol Options >
|
||||||
\uicontrol Devices > \uicontrol Devices > \uicontrol Add >
|
\uicontrol Devices > \uicontrol Devices > \uicontrol Add >
|
||||||
\uicontrol \Boot2Qt > \uicontrol {Finish}.
|
\uicontrol Boot2Qt > \uicontrol {Finish}.
|
||||||
\image qtcreator-devices-boot2qt.png "Boot2Qt Network Device Setup wizard"
|
\image qtcreator-devices-boot2qt.png "Boot2Qt Network Device Setup wizard"
|
||||||
\li In the \uicontrol {Device name} field, enter a name for
|
\li In the \uicontrol {Device name} field, enter a name for
|
||||||
the connection.
|
the connection.
|
||||||
@@ -139,7 +139,7 @@
|
|||||||
\li Select \uicontrol Tools > \uicontrol Options > \uicontrol Kits >
|
\li Select \uicontrol Tools > \uicontrol Options > \uicontrol Kits >
|
||||||
\uicontrol Add to add a kit for building applications for the
|
\uicontrol Add to add a kit for building applications for the
|
||||||
device. Select the Qt version, compiler, and device that you
|
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:
|
\li To specify build settings:
|
||||||
\list 1
|
\list 1
|
||||||
\li Open a project for an application you want to develop for the
|
\li Open a project for an application you want to develop for the
|
||||||
|
@@ -28,7 +28,7 @@
|
|||||||
|
|
||||||
\section1 Specifying Run Settings for Boot2Qt Devices
|
\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
|
must create connections from the development host to the device and add the
|
||||||
device configurations to \l{glossary-buildandrun-kit}{kits}. Select
|
device configurations to \l{glossary-buildandrun-kit}{kits}. Select
|
||||||
\uicontrol {Manage Kits} to add devices to kits. For more information, see
|
\uicontrol {Manage Kits} to add devices to kits. For more information, see
|
||||||
|
Reference in New Issue
Block a user