Skip to content

Commit b52ba2b

Browse files
Doc fix
1 parent 366f845 commit b52ba2b

File tree

2 files changed

+6
-4
lines changed

2 files changed

+6
-4
lines changed

documentation/ChangeLog.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@
66
▶ Recommended/tested CDT version is now 8.7
77
* Fixed #44: Debugging not working on Eclipse 4.5 Mars (CDT 8.7)
88
* Fixed #43: PATH of external tools bungled if original PATH not set (Windows)
9-
* Doc: added note about Cygwin GDB not being recommnended for debugging.
9+
* Doc: added note about Cygwin GDB not being recommended for debugging.
1010

1111
### 0.2.1
1212
* Added Content Assist preference page, with auto-activation options (#23).

documentation/UserGuide.md

Lines changed: 5 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -47,7 +47,11 @@ Alternatively, to automatically create and run a launch configuration (if a matc
4747

4848
Whenever a launch is requested, a build will be performed beforehand. This behavior can be configured under general Eclipse settings, or in the launch configuration.
4949

50-
### Debugging
50+
##### Debugging
51+
52+
| **Windows note:** _Using Cygwin GDB doesn't work very well, if at all. The recommended way to debug in Windows is to use the GDB of [mingw-w64](http://mingw-w64.org/), or the one of [TDM-GCC](http://tdm-gcc.tdragon.net/)._ |
53+
|----|
54+
5155
You can debug a Rust program by running a launch in debug mode. You will need a GDB debugger. To configure debug options (in particular, the path to the debugger to use), open the launch under 'Run' / 'Debug Configurations...', and then navigate to the 'Debugger' tab in the desired launch configuration:
5256

5357
<div align="center">
@@ -58,7 +62,5 @@ GDB debugger integration is achieved by using the CDT plugins. To configure glob
5862

5963
**Note that for debugging to work**, the program must be compiled with debug symbols information, and those debug symbols must be on a format that GDB understands. Otherwise you will get GDB error messages such "(no debugging symbols found)" or "file format not recognized".
6064

61-
**Windows note:** Using Cygwin GDB doesn't work very well, if at all. The recommended way to debug in Windows is to use the GDB of [mingw-w64](http://mingw-w64.org/), or the one of [TDM-GCC](http://tdm-gcc.tdragon.net/).
62-
6365
##### GDB Pretty printers
6466
RustDT will try to automatically set up the rust-gdb pretty printing scripts when launching in debug mode. GDB will be configured to load them from the `${RUST_ROOT}/lib/rustlib/etc` location, where `${RUST_ROOT}` is the directory of the Rust installation, as configured in the RustDT preferences.

0 commit comments

Comments
 (0)