Skip to content

Commit

Permalink
Provide more thorough bug-report instructions
Browse files Browse the repository at this point in the history
  • Loading branch information
any1 committed Jan 9, 2025
1 parent 1e6f20b commit e2105fd
Showing 1 changed file with 19 additions and 5 deletions.
24 changes: 19 additions & 5 deletions .github/ISSUE_TEMPLATE/bug_report.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,12 +12,23 @@ these instructions:
- **Version:**
- Run this command: `wayvnc -V`

- Try to reproduce while capturing a **trace log:**
- `wayvnc -Ltrace | tee wayvnc-crash.log`
- Provide context, including but not limited to
- Command line arguments
- Special environment variables, if any
- jhich wayland compositor are you using? Which version?
- What VNC client are you using?
- Did you configure your VNC client in a specific manner?
- Linux distro/operating system
- Kernel version
- Graphics drivers

- Get the **stack trace**:
- If have `coredumpctl`, you can gather the stack trace after a crash using
`coredumpctl gdb wayvnc` and then run `bt full` to obtain the stack trace.
- Try to reproduce the problem while capturing a **trace log:**
- `wayvnc -Ltrace | tee wayvnc-bug.log`

- Get the **stack trace**, in case of a crash:
- If you have `coredumpctl`, you can gather the stack trace after a crash
using `coredumpctl gdb wayvnc` and then run `bt full` to obtain the stack
trace.
- Otherwise, you can either locate the core file and load it into gdb or run
wayvnc in gdb like so:
- `gdb --args wayvnc -Ltrace`
Expand All @@ -26,3 +37,6 @@ these instructions:
again.

- Describe how to **reproduce** the problem

- Try to think about your problem beyond these instructions and include
whatever information that you believe will help to resolve the issue

0 comments on commit e2105fd

Please sign in to comment.