document how to provide symbolic backtraces
Add a "REPORTING CRASH BUGS" section to the README.md with instructions for how to provide a symbolic backtrace on Linux and MSYS2. Add a "Crash bugs" section the the issue template with a link to said README.md section.
This commit is contained in:
parent
1e3a85a34b
commit
9bca4f7292
|
@ -6,6 +6,14 @@
|
|||
|
||||
### Steps to reproduce the behavior
|
||||
|
||||
### Crash bugs
|
||||
|
||||
If this is a crash bug, and you have the time and inclination, please provide a
|
||||
symblic backtrace.
|
||||
|
||||
Instructions for doing so are
|
||||
[here](https://github.com/visualboyadvance-m/visualboyadvance-m/blob/master/README.md#reporting-crash-bugs).
|
||||
|
||||
### ROM details
|
||||
|
||||
Which games are affected by the issue (please state if GBA or GB game):
|
||||
|
|
40
README.md
40
README.md
|
@ -170,6 +170,46 @@ wxString world = "world";
|
|||
wxLogDebug(wxT("Hello, %s!"), world.utf8_str());
|
||||
```
|
||||
|
||||
## REPORTING CRASH BUGS
|
||||
|
||||
If the emulator crashes and you wish to report the bug, a backtrace made with
|
||||
debug symbols would be immensely helpful.
|
||||
|
||||
To generate one (on Linux and MSYS2) first build in debug mode by invoking
|
||||
`cmake` as:
|
||||
|
||||
```shell
|
||||
cmake .. -DCMAKE_BUILD_TYPE=Debug
|
||||
```
|
||||
|
||||
After you've reproduced the crash, you need the core dump file, you may need to
|
||||
do something such as:
|
||||
|
||||
```shell
|
||||
ulimit -c unlimited
|
||||
```
|
||||
|
||||
in your shell to enable coredump files.
|
||||
|
||||
[This
|
||||
post](https://ask.fedoraproject.org/en/question/98776/where-is-core-dump-located/?answer=98779#post-id-98779)
|
||||
explains how to retrieve core dump on Fedora Linux (and possibly other
|
||||
distributions.)
|
||||
|
||||
Once you have the core dump file, open it with `gdb`, for example:
|
||||
|
||||
```shell
|
||||
gdb -c core ./visualboyadvance-m
|
||||
```
|
||||
|
||||
In the `gdb` shell, to print the backtrace, type:
|
||||
|
||||
```
|
||||
bt
|
||||
```
|
||||
|
||||
This may be a bit of a hassle, but it helps us out immensely.
|
||||
|
||||
## CONTRIBUTING
|
||||
|
||||
Please keep in mind that this app needs to run on Windows, Linux and macOS at
|
||||
|
|
Loading…
Reference in New Issue