diff --git a/dist/changelog/changes-14.0.0.md b/dist/changelog/changes-14.0.0.md index 7fe40fd9554..97fe1bb68dd 100644 --- a/dist/changelog/changes-14.0.0.md +++ b/dist/changelog/changes-14.0.0.md @@ -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 diff --git a/doc/qtcreator/images/qtcreator-preferences-devices-remote-linux.webp b/doc/qtcreator/images/qtcreator-preferences-devices-remote-linux.webp index 4b97b88b7a2..565d63ad6df 100644 Binary files a/doc/qtcreator/images/qtcreator-preferences-devices-remote-linux.webp and b/doc/qtcreator/images/qtcreator-preferences-devices-remote-linux.webp differ diff --git a/doc/qtcreator/src/debugger/creator-only/creator-debugger.qdoc b/doc/qtcreator/src/debugger/creator-only/creator-debugger.qdoc index cdfc9ac8fb5..6880c27b5a2 100644 --- a/doc/qtcreator/src/debugger/creator-only/creator-debugger.qdoc +++ b/doc/qtcreator/src/debugger/creator-only/creator-debugger.qdoc @@ -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} */ /*! diff --git a/doc/qtcreator/src/linux-mobile/creator-projects-how-to-run-generic-linux.qdoc b/doc/qtcreator/src/linux-mobile/creator-projects-how-to-run-generic-linux.qdoc index 241b0ce2f34..aeb17305cf8 100644 --- a/doc/qtcreator/src/linux-mobile/creator-projects-how-to-run-generic-linux.qdoc +++ b/doc/qtcreator/src/linux-mobile/creator-projects-how-to-run-generic-linux.qdoc @@ -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} */ diff --git a/doc/qtcreator/src/linux-mobile/linuxdev.qdoc b/doc/qtcreator/src/linux-mobile/linuxdev.qdoc index e0ec120b85b..6691ca4b2c4 100644 --- a/doc/qtcreator/src/linux-mobile/linuxdev.qdoc +++ b/doc/qtcreator/src/linux-mobile/linuxdev.qdoc @@ -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} */