docs/debugging: warn more clearly about sensitive info (Thanks lambithal)

closes #1906, see #1907 for discussion
This commit is contained in:
Michael Stapelberg 2015-09-11 20:17:53 +02:00
parent 520602e8d7
commit 69b3523b3f

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