swayfx/ISSUE_TEMPLATE.md
Brian Ashworth 8fd450db16 ISSUE_TEMPLATE: note debug logs should be from TTY
It is common for user to attach a debug log from the Wayland backend
because they are running the command from inside of Sway. This just adds
a note that the debug logs should be obtained from a TTY. Anyone who is
actually using the Wayland or X11 backends and submitting an issue
related to them likely is already familiar with how to obtain a debug
log for the appropriate backend.
2020-04-29 08:33:20 +02:00

2.3 KiB

If you want to ask a question, please check out the wiki. If you don't find an answer there, ask on IRC (#sway on irc.freenode.net). The issue tracker may not be used for questions.

If you are using the Nvidia proprietary driver for any reason, you have two choices:

  1. Uninstall it and use nouveau instead
  2. Use X11+i3 and close your browser tab

If lsmod | grep nvidia | wc -l shows anything other than zero, your bug report is not welcome here.

Additionally, problems with Firefox are almost certainly Firefox bugs, not sway bugs. Start by submitting your issue to the Firefox Bugzilla and come back here only after they confirm otherwise.

Otherwise, please include the following four components in your bug report: sway version, debug log, configuration (if applicable), and an explanation of steps taken to reproduce the issue. If sway crashes, also include a stack trace.

Obtain your version like so:

swaymsg -t get_version

If this doesn't work, use:

sway -v
  • Sway Version:

Obtain a debug log by running the following command from a TTY:

sway -d 2> ~/sway.log

This will record information about sway's activity when it's running. Briefly reproduce your problem and exit sway. When preparing a debug log, brevity is important - start up sway, do the minimum work necessary to reproduce the error, then close sway.

Upload the debug log to a pastebin service such as gist.github.com, and link to it below.

  • Debug Log:

You should try to reproduce the issue with the default configuration. If you cannot, please reproduce with a minimal configuration, upload the config to a pastebin service, and link to it below.

  • Configuration File:

Finally, explain the steps you took in plain English to reproduce the problem below.

  • Stack Trace, if sway crashes:

If you use systemd, you should be able to open the coredump of the most recent crash with GDB like so:

coredumpctl gdb sway

And then type bt full to obtain the stack trace.

If the lines mentioning sway/wlroots have "??" for the location, your binaries were built without debug symbols, and the stack trace is unlikely to be useful. You can find instructions to compile sway from source here. Note that debug symbols are included in Meson builds by default.