Skip to content

Commit 936c24e

Browse files
committed
update debug/backtrace instructions
1 parent 20f4ff0 commit 936c24e

File tree

9 files changed

+33
-21
lines changed

9 files changed

+33
-21
lines changed

Debug.md

Lines changed: 33 additions & 21 deletions
Original file line numberDiff line numberDiff line change
@@ -2,35 +2,47 @@ To submit a bug report that concerns a crash to the Red Eclipse Team, it is help
22

33
## Windows (64 bit)
44

5-
You must download and install Code::Blocks for easiest building on Windows.
5+
You must download and install MSYS2 for easiest building on Windows.
66

7-
### Setting up Code::Blocks
7+
### Setting up MSYS2
88

9-
- Install TDM-GCC-64
10-
- You may need to set the Code::Blocks compiler to TDM-GCC-64, open Code::Blocks and go to `Settings -> Compiler -> Global Compiler Settings -> Toolchain Executables`. Paths may need changed depending on where you installed it.
11-
12-
<a href="images/debug/Win64dbg06.png" target="_blank"><img src="images/debug/Win64dbg06.png" width="512px"/></a>
9+
- Install MSYS2 from https://www.msys2.org/ and follow the instructions on that page
10+
- Then launch **MSYS2 MinGW x64** from the start menu
1311

1412
### Compiling Red Eclipse
1513

16-
- Open redeclipse.cbp in Code::Blocks as a project.
17-
- Select the debug build (redeclipse-amd64-dbg)
14+
In the MSYS2 prompt, change directory to the location that of Red Eclipse:
15+
```
16+
cd /c/Users/qreev/Documents/redeclipse
17+
```
18+
*(note: that MSYS2 is using "/" as the root directory, so that `C:\Users\qreev\Documents\redeclipse` would be written as `/c/Users/qreev/Documents/redeclipse`*
19+
20+
First you must compile with debug symbols:
21+
```
22+
make -Csrc clean && CXXFLAGS=-ggdb3 make -Csrc install
23+
```
24+
25+
<a href="images/debug/win_dbg1.png" target="_blank"><img src="images/debug/win_dbg1.png" width="512px"/></a>
1826

19-
<a href="images/debug/Win64dbg01.png" target="_blank"><img src="images/debug/Win64dbg01.png" width="512px"/></a>
20-
- Press the Build button.
27+
Then run with GDB:
28+
```
29+
gdb src/redeclipse_windows.exe
30+
```
2131

22-
<a href="images/debug/Win64dbg02.png" target="_blank"><img src="images/debug/Win64dbg02.png" width="512px"/></a>
32+
<a href="images/debug/win_dbg2.png" target="_blank"><img src="images/debug/win_dbg2.png" width="512px"/></a>
2333

24-
### Running Red Eclipse and Retrieving the Backtrace
2534

26-
- Press the Debug/Continue button.
35+
Inside GDB, to start Red Eclipse, type:
36+
```
37+
run
38+
```
2739

28-
<a href="images/debug/Win64dbg03.png" target="_blank"><img src="images/debug/Win64dbg03.png" width="512px"/></a>
29-
- Red Eclipse will now start, attempt to crash it.
30-
- Once crashed, you will see the debugger near the bottom of the screen with a Command input. Write `bt full` in that command input and press enter.
40+
Now attempt to reproduce the problem in game. Once Red Eclipse has crashed, GDB will catch this and present a prompt. At this prompt run:
41+
```
42+
bt full
43+
```
44+
This will produce a backtrace, copy and paste this to an accessible place such as a crash report on the Red Eclipse [Github Issues page](https://github.com/redeclipse/base/issues) or paste to the Red Eclipse [Discord](https://discord.com/invite/RPDmG5Z).
3145

32-
<a href="images/debug/Win64dbg04.png" target="_blank"><img src="images/debug/Win64dbg04.png" width="512px"/></a>
33-
- This will produce a backtrace, copy and paste this to an accessible place such as a crash report on the Red Eclipse forum or a paste service to be linked on [IRC](IRC.md).
3446

3547
## Linux
3648

@@ -46,12 +58,12 @@ Then run with GDB:
4658
```
4759
gdb src/redeclipse_linux
4860
```
49-
Inside GDB, to start Red Eclipse:
61+
Inside GDB, to start Red Eclipse, type:
5062
```
5163
run
5264
```
53-
Once Red Eclipse has crashed, GDB will catch this and present a prompt. At this prompt run:
65+
Now attempt to reproduce the problem in game. Once Red Eclipse has crashed, GDB will catch this and present a prompt. At this prompt run:
5466
```
5567
bt full
5668
```
57-
This will produce a backtrace, copy and paste this to an accessible place such as a crash report on the Red Eclipse forum or a paste service to be linked on [IRC](IRC.md).
69+
This will produce a backtrace, copy and paste this to an accessible place such as a crash report on the Red Eclipse [Github Issues page](https://github.com/redeclipse/base/issues) or paste to the Red Eclipse [Discord](https://discord.com/invite/RPDmG5Z).

images/debug/Win64dbg01.png

-88.4 KB
Binary file not shown.

images/debug/Win64dbg02.png

-76 KB
Binary file not shown.

images/debug/Win64dbg03.png

-75.9 KB
Binary file not shown.

images/debug/Win64dbg04.png

-119 KB
Binary file not shown.

images/debug/Win64dbg05.png

-92.5 KB
Binary file not shown.

images/debug/Win64dbg06.png

-60.1 KB
Binary file not shown.

images/debug/win_dbg1.png

30.1 KB
Loading

images/debug/win_dbg2.png

44 KB
Loading

0 commit comments

Comments
 (0)