From 69b3523b3fbb5a9fdfdb147a3d4a4f19d2e7fb83 Mon Sep 17 00:00:00 2001 From: Michael Stapelberg Date: Fri, 11 Sep 2015 20:17:53 +0200 Subject: [PATCH] docs/debugging: warn more clearly about sensitive info (Thanks lambithal) closes #1906, see #1907 for discussion --- docs/debugging | 13 ++++++++++--- 1 file changed, 10 insertions(+), 3 deletions(-) diff --git a/docs/debugging b/docs/debugging index 55197753..7be7c8e5 100644 --- a/docs/debugging +++ b/docs/debugging @@ -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.