Skip to content

Commit 609237a

Browse files
author
Red Eclipse
committed
Build docs:149 from 936c24e4c80902569c2cf11d7569e945c3ffbeec
1 parent d20c2e9 commit 609237a

File tree

3 files changed

+33
-21
lines changed

3 files changed

+33
-21
lines changed

docs/Debug.md

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

1414
## Windows (64 bit)
1515

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

18-
### Setting up Code::Blocks
18+
### Setting up MSYS2
1919

20-
- Install TDM-GCC-64
21-
- 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.
22-
23-
<a href="images/debug/Win64dbg06.png" target="_blank"><img src="images/debug/Win64dbg06.png" width="512px"/></a>
20+
- Install MSYS2 from https://www.msys2.org/ and follow the instructions on that page
21+
- Then launch **MSYS2 MinGW x64** from the start menu
2422

2523
### Compiling Red Eclipse
2624

27-
- Open redeclipse.cbp in Code::Blocks as a project.
28-
- Select the debug build (redeclipse-amd64-dbg)
25+
In the MSYS2 prompt, change directory to the location that of Red Eclipse:
26+
```
27+
cd /c/Users/qreev/Documents/redeclipse
28+
```
29+
*(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`*
30+
31+
First you must compile with debug symbols:
32+
```
33+
make -Csrc clean && CXXFLAGS=-ggdb3 make -Csrc install
34+
```
35+
36+
<a href="images/debug/win_dbg1.png" target="_blank"><img src="images/debug/win_dbg1.png" width="512px"/></a>
2937

30-
<a href="images/debug/Win64dbg01.png" target="_blank"><img src="images/debug/Win64dbg01.png" width="512px"/></a>
31-
- Press the Build button.
38+
Then run with GDB:
39+
```
40+
gdb src/redeclipse_windows.exe
41+
```
3242

33-
<a href="images/debug/Win64dbg02.png" target="_blank"><img src="images/debug/Win64dbg02.png" width="512px"/></a>
43+
<a href="images/debug/win_dbg2.png" target="_blank"><img src="images/debug/win_dbg2.png" width="512px"/></a>
3444

35-
### Running Red Eclipse and Retrieving the Backtrace
3645

37-
- Press the Debug/Continue button.
46+
Inside GDB, to start Red Eclipse, type:
47+
```
48+
run
49+
```
3850

39-
<a href="images/debug/Win64dbg03.png" target="_blank"><img src="images/debug/Win64dbg03.png" width="512px"/></a>
40-
- Red Eclipse will now start, attempt to crash it.
41-
- 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.
51+
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:
52+
```
53+
bt full
54+
```
55+
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).
4256

43-
<a href="images/debug/Win64dbg04.png" target="_blank"><img src="images/debug/Win64dbg04.png" width="512px"/></a>
44-
- 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)~~.
4557

4658
## Linux
4759

@@ -57,12 +69,12 @@ Then run with GDB:
5769
```
5870
gdb src/redeclipse_linux
5971
```
60-
Inside GDB, to start Red Eclipse:
72+
Inside GDB, to start Red Eclipse, type:
6173
```
6274
run
6375
```
64-
Once Red Eclipse has crashed, GDB will catch this and present a prompt. At this prompt run:
76+
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:
6577
```
6678
bt full
6779
```
68-
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)~~.
80+
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).

docs/images/debug/win_dbg1.png

30.1 KB
Loading

docs/images/debug/win_dbg2.png

44 KB
Loading

0 commit comments

Comments
 (0)