Doc: Describe the "Use SSH port forwarding for debugging" option

... in Preferences > Devices for a Remote Linux Device.

Add links between developing for remote Linux and debugging
remotely with GDB.

Task-number: QTCREATORBUG-30604
Change-Id: I149447ce5e30409452c203fecc41417822a3d8b2
Reviewed-by: hjk <hjk@qt.io>
This commit is contained in:
Leena Miettinen
2024-06-27 12:00:23 +02:00
parent e8c32fe472
commit b6f253548f
5 changed files with 23 additions and 5 deletions

View File

@@ -291,7 +291,8 @@ Platforms
### Remote Linux
* Added the option to use SSH port forwarding for debugging
* Added the `Use SSH port forwarding for debugging` option in `Preferences` >
`Devices` for a `Remote Linux Device`
* Improved the performance of the generic deployment method
* Fixed that the file size check that is performed before parsing C++ files
could freeze Qt Creator until finished for remote projects

Binary file not shown.

Before

Width:  |  Height:  |  Size: 13 KiB

After

Width:  |  Height:  |  Size: 13 KiB

View File

@@ -589,8 +589,24 @@
in GDB, see \l{https://sourceware.org/gdb/onlinedocs/gdb/Connecting.html}
{Debugging with GDB: Connecting to a Remote Target}.
\sa {Debug}{How To: Debug}, {GDB}, {Debugging},
{Debuggers}, {Debugger}, {Kits}
\section1 Use SSH port forwarding
To enable debugging on remote targets that cannot expose GDB server ports,
map the remote ports to local ports using SSH tunneling. \QC automatically
detects the local and remote ports.
To turn on SSH port forwarding:
\list 1
\li Go to \preferences > \uicontrol Devices.
\image qtcreator-preferences-devices-remote-linux.webp {Remote Linux device preferences}
\li In \uicontrol Device, select \uicontrol {Remote Linux Device}.
\li Select \uicontrol {Use SSH port forwarding for debugging}.
\li Select \uicontrol OK.
\endlist
\sa {Debug}{How To: Debug}, {Remote Linux}{How To: Develop for remote Linux},
{GDB}, {Debugging}, {Debuggers}, {Debugger}, {Kits}
*/
/*!

View File

@@ -35,5 +35,6 @@
it is compatible with the GDB on the host.
\sa {Remote Linux}{How To: Develop for remote Linux},
{Run on many platforms}, {Compilers}, {Embedded Platforms}, {Kits}
{Debug remotely with GDB}, {Run on many platforms}, {Compilers},
{Embedded Platforms}, {Kits}
*/

View File

@@ -138,6 +138,6 @@
\include qtcreator-add-linux-device.qdocinc {add linux device} {Remote Linux Device}
\sa {Remote Linux}{How To: Develop for remote Linux},
{Developing for Remote Linux Devices},
{Debug remotely with GDB}, {Developing for Remote Linux Devices},
{Remote Linux Deploy Configuration}
*/