Merge pull request #3101 from tpraxl/feature/workspace-variables

[i3/i3] / docs / debugging

diff --git a/docs/debugging b/docs/debugging
index 1253b0c50fc2b405f8279d36211c7c02014174fd..dd26f98d924b3783a79a09fb9b0e64ce15a25d94 100644 (file)
--- a/docs/debugging
+++ b/docs/debugging
@@ -10,10 +10,10 @@ 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
 process and/or need further help, do not hesitate to contact us!
 
 something to us to get your bug fixed. If you have any questions about the
 process and/or need further help, do not hesitate to contact us!
 

-== Verify you are using i3 ≥ 4.7
+== Verify you are using i3 ≥ 4.10

 
 

-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
 
 ---------------
 $ i3 --moreversion 2>&- || i3 --version


@@ -32,8 +32,8 @@ if you can.
 
 4.7-85-g9c15b95 (development version)::
 Your version is 85 commits newer than 4.7, and the git revision of your
 
 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
+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.
 
 Development versions of i3 have logging enabled by default and are compiled
 latest version.
 
 Development versions of i3 have logging enabled by default and are compiled


@@ -67,15 +67,51 @@ fly:
 i3-msg 'debuglog on; shmlog on; reload'
 ---------------------------------------
 
 i3-msg 'debuglog on; shmlog on; reload'
 ---------------------------------------
 

+== 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.
+

 == Obtaining the debug logfile
 
 == 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:
 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.
 
 This command does not depend on i3 (it also works while i3 displays
 the crash dialog), but it requires a working X11 connection.


@@ -117,7 +153,24 @@ 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.
 
 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.
+
+== 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.