X-Git-Url: https://git.sur5r.net/?a=blobdiff_plain;f=docs%2Fdebugging.html;h=da9dca0fb1c503d33cd06cdb1dc4e9b266215775;hb=c6ec810e62cd138f5c2edfede6f052141a1a9062;hp=d9e7b43bde8dfb13b3b6e428f8568918e78e9c90;hpb=89ad8183dd7e8532e5f9067d4d71b66a49142ceb;p=i3%2Fi3.github.io diff --git a/docs/debugging.html b/docs/debugging.html index d9e7b43..da9dca0 100644 --- a/docs/debugging.html +++ b/docs/debugging.html @@ -4,7 +4,7 @@ - + i3: Debugging i3: How To @@ -22,8 +22,9 @@ document.addEventListener("DOMContentLoaded", function(){asciidoc.footnotes();},
@@ -43,10 +44,10 @@ process and/or need further help, do not hesitate to contact us!

-

1. Verify you are using i3 ≥ 4.7

+

1. Verify you are using i3 ≥ 4.15

-

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

+

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

$ i3 --moreversion 2>&- || i3 --version
@@ -73,8 +74,8 @@ if you can.
 

 

 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
+version is 9c15b95. Go to https://github.com/i3/i3/commits/next and see if
+the most recent commit starts with the same revision. If so, you are using the
 latest version.
 

 

@@ -111,14 +112,76 @@ fly:
-

3. Obtaining the debug logfile

+

3. Reproducing the problem

+

Before submitting an issue, please make sure to close down on the problem as +much as you can yourself. Here are some steps you should consider:

+
    +
  • +

    +Find a deterministic, reliable way to reproduce the problem and provide it + with your bug report. +

    +
    • +
  • +

    +Try using the default i3 config to reproduce the problem. If the issue does + not appear with the default config, gradually adapt it to track down what + change(s) to the config introduce the problem. +

    +
    • +
  • +

    +Reproduce the problem with a minimal setup, i.e., only use as few applications, + windows and steps as necessary. +

    +
    • +
  • +

    +In addition, try to stick to applications that are common and, even more + importantly, free / open source. +

    +
    • +
  • +

    +Before obtaining the log file, restart i3 in-place, execute the steps to + reproduce the problem and then save the logs. This keeps the log file as + small as possible and necessary. +

    +
    • +
+

Please be aware that we cannot support compatibility issues with closed-source +software, as digging into compatibility problems without having access to the +source code is too time-consuming. Additionally, experience has shown that +often, the software in question is responsible for the issue. Please raise an +issue with the software in question, not i3.

+
+
+
+

4. Obtaining the debug logfile

+
+
+ + + +
+
Caution
+		 +

Logs may contain sensitive information, so please inspect the log before +submitting it. Logs may be viewed by anyone, once posted. If you choose to +redact the log, make an effort not to discard information which may be relevant +to the issue you are reporting.

+

The best way to avoid submitting such information is to only run the necessary +steps to reproduce the behavior when saving the log file. This will also make +analyzing the log file easier.

+
+

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 upload a compressed version of the logfile (for a bugreport), use:

-
DISPLAY=:0 i3-dump-log | bzip2 -c | curl --data-binary @- http://logs.i3wm.org
+
DISPLAY=:0 i3-dump-log | bzip2 -c | curl --data-binary @- https://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.

@@ -127,7 +190,7 @@ your bug report.

-

4. On crashes: Obtaining a backtrace

+

5. 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.

@@ -153,15 +216,33 @@ starting at 0.

-

5. Sending bug reports/debugging on IRC

+

6. 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 information might be necessary to completely diagnose the problem.

-

When debugging with us in IRC, be prepared to use a so called nopaste service -such as http://nopaste.info or http://pastebin.com because pasting large -amounts of text in IRC sometimes leads to incomplete lines (servers have line -length limitations) or flood kicks.

+

When debugging with us in IRC, be prepared to use a so-called nopaste service +such as https://pastebin.com because pasting large amounts of text in IRC +sometimes leads to incomplete lines (servers have line length limitations) or +flood kicks.

+
+
+
+

7. Debugging i3bar

+
+

To debug i3bar problems, add verbose yes to all bar {} blocks in your i3 +config, reload your config and then restart all i3bar instances like this:

+
+
+
$ i3 reload
+$ killall i3bar
+$ for c in $(i3-msg -t get_bar_config | python -c \
+      'import json,sys;print("\n".join(json.load(sys.stdin)))'); do \
+    (i3bar --bar_id=$c >i3bar.$c.log 2>&1) & \
+  done;
+
+

There will now be i3bar.*.log files in your current directory that you can provide +in your bug report.