X-Git-Url: https://git.sur5r.net/?a=blobdiff_plain;f=docs%2Fdebugging.html;h=99ff40813e82a13a7a8d81f4aaccf70129831342;hb=3771d13d731b12db55004a331f565e2cec003d6a;hp=c60b0faf3bb7a67015e585b98787e2f3279f15a0;hpb=3b669adf6e67997ea586e57d692b858f64648658;p=i3%2Fi3.github.io diff --git a/docs/debugging.html b/docs/debugging.html index c60b0fa..99ff408 100644 --- a/docs/debugging.html +++ b/docs/debugging.html @@ -2,15 +2,15 @@ "http://www.w3.org/TR/xhtml11/DTD/xhtml11.dtd"> - + - + i3: Debugging i3: How To @@ -22,8 +22,9 @@ window.onload = function(){asciidoc.footnotes();}
@@ -31,7 +32,7 @@ window.onload = function(){asciidoc.footnotes();}

Debugging i3: How To

Michael Stapelberg
<michael@i3wm.org>
-December 2012 +January 2014
@@ -43,34 +44,37 @@ process and/or need further help, do not hesitate to contact us!

-

1. Verify you are using the latest (development) version

+

1. Verify you are using i3 ≥ 4.7

-

Please verify that you are using the latest version of i3:

+

Only the latest major version of i3 is supported, i.e. version 4.7 currently. +To verify which version you are running, use:

-
$ i3 --version
-i3 version 4.1.2-248-g51728ba (2012-02-12, branch "next")
+
$ i3 --moreversion 2>&- || i3 --version
+Binary i3 version:  4.7 (2013-12-22, branch "tags/4.7")
+Running i3 version: 4.7-84-gac74a63 (2014-01-01, branch "next") (pid 1995)

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. +fixed in the development version of i3. Even if the bug is not a known fixed +one, 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) +4.7-85-g9c15b95 (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 +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.

@@ -99,6 +103,12 @@ list of sessions in your desktop manager (gdm, lxdm, …), edit 
Exec=i3 --shmlog-size=26214400
+

If you cannot restart i3 for some reason, you can enable debug logging on the +fly:

+
+
+
i3-msg 'debuglog on; shmlog on; reload'
+
@@ -106,19 +116,22 @@ list of sessions in your desktop manager (gdm, lxdm, …), edit

No matter whether i3 misbehaved in some way without crashing or whether it just crashed, the logfile provides all information necessary to debug the problem.

-

To save a compressed version of the logfile (suitable for attaching it to a -bugreport), use:

+

To upload a compressed version of the logfile (for a bugreport), use:

-
DISPLAY=:0 i3-dump-log | gzip -9c > /tmp/i3.log.gz
+
DISPLAY=:0 i3-dump-log | bzip2 -c | curl --data-binary @- http://logs.i3wm.org

This command does not depend on i3 (it also works while i3 displays the crash dialog), but it requires a working X11 connection.

+

After running it, you will get a URL to the logfile. Please include that URL in +your bug report.

-

4. Compiling with debug symbols

+

4. On crashes: Obtaining a backtrace

+

When i3 crashes, it will display a dialog stating “i3 just crashed”, offering +you to save a backtrace to a text file.

To actually get useful backtraces, you should make sure that your version of i3 is compiled with debug symbols:

@@ -131,11 +144,6 @@ linked (uses shared libs), for GNU/Linux 2.6.18, not stripped 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.

-
-
-
-

5. Obtaining a backtrace

-

Once you have made sure that your i3 is compiled with debug symbols and the C debugger gdb is installed on your machine, you can let i3 generate a backtrace in the crash dialog.

@@ -146,7 +154,7 @@ starting at 0.

-

6. Sending bug reports/debugging on IRC

+

5. Sending bug reports/debugging on IRC

When sending bug reports, please attach the whole log file. Even if you think you found the section which clearly highlights the problem, additional