Michael Stapelberg <michael@i3wm.org>
December 2012
-This document describes how to debug i3 suitably for sending us useful bug
-reports, even if you have no clue of C programming.
+This document describes how to debug i3 to send us useful bug
+reports, even if you have no knowledge of C programming.
-First of all: Thank you for being interested in debugging i3. It really means
+Thank you for being interested in debugging i3. It really means
something to us to get your bug fixed. If you have any questions about the
-debugging and/or need further help, do not hesitate to contact us!
+process and/or need further help, do not hesitate to contact us!
== Verify you are using the latest (development) version
---------------
$ i3 --version
-i3 version 4.1.2-248-g51728ba (2012-02-12, branch "next")
+i3 version 4.7-85-g9c15b95 (2014-01-02, branch "next")
---------------
Your version can look like this:
-4.1.2 (release version)::
+4.7 (release version)::
You are using a release version. In many cases, bugs are already
fixed in the development version of i3. If they aren’t, we will still ask you
to reproduce your error with the most recent development version of i3.
Therefore, please upgrade to a development version if you can.
-4.1.2-248-g51728ba (development version)::
-Your version is 248 commits newer than 4.1.2, and the git revision of your
-version is +51728ba+. Go to http://code.i3wm.org/i3/commit/?h=next and see if
+4.7-85-g9c15b95 (development version)::
+Your version is 85 commits newer than 4.7, and the git revision of your
+version is +9c15b95+. Go to http://code.i3wm.org/i3/commit/?h=next and see if
the line "commit" starts with the same revision. If so, you are using the
latest version.
To save a compressed version of the logfile (suitable for attaching it to a
bugreport), use:
--------------------------------------------------------------------
-DISPLAY=:0 i3-dump-log | gzip -9c > /tmp/i3.log.gz
+DISPLAY=:0 i3-dump-log | bzip2 -c > /tmp/i3.log.bz2
--------------------------------------------------------------------
This command does not depend on i3 (it also works while i3 displays
------------------------------------------------------------------------------
Notice the +not stripped+, which is the important part. If you have a version
-which is stripped, please have a look if your distribution provides debug
+which is stripped, please check whether your distribution provides debug
symbols (package +i3-wm-dbg+ on Debian for example) or if you can turn off
stripping. If nothing helps, please build i3 from source.