]> git.sur5r.net Git - i3/i3/commitdiff
docs/debugging: warn more clearly about sensitive info (Thanks lambithal)
authorMichael Stapelberg <michael@stapelberg.de>
Fri, 11 Sep 2015 18:17:53 +0000 (20:17 +0200)
committerMichael Stapelberg <michael@stapelberg.de>
Fri, 11 Sep 2015 18:18:24 +0000 (20:18 +0200)
closes #1906, see #1907 for discussion

docs/debugging

index 55197753c0d03ffffff82097f00ebab1c9d0069c..7be7c8e5b37f2d4cd44134c30b9b6f32f4a3ea0a 100644 (file)
@@ -93,10 +93,17 @@ 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.