Merge pull request #3144 from DebianWall/guaketilda

[i3/i3] / docs / debugging

diff --git a/docs/debugging b/docs/debugging
index cf61813d4789b52c1c4791f4b28f92698c73e4b2..dd26f98d924b3783a79a09fb9b0e64ce15a25d94 100644 (file)
--- a/docs/debugging
+++ b/docs/debugging
@@ -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
-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
@@ -93,18 +93,25 @@ issue with the software in question, not i3.
 
 == Obtaining the debug logfile
 
-Please note that log files may contain sensitive data such as window titles.
+[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
-applications to reproduce the behavior when saving the log file. This will also
-make analyzing the log file easier.
+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.
@@ -146,17 +153,18 @@ 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.
 
 == Debugging i3bar
 
-To debug i3bar problems, add +verbose yes+ to all +bar {}+ blocks in your i3 config
-and then restart all i3bar instances like this:
+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 \