From: Ingo Bürk <ingo.buerk@tngtech.com>
Date: Sun, 26 Apr 2015 20:51:16 +0000 (+0200)
Subject: Added a note to the debugging docs about sensitive data.
X-Git-Tag: 4.11~118^2
X-Git-Url: https://git.sur5r.net/?a=commitdiff_plain;h=refs%2Fpull%2F1688%2Fhead;p=i3%2Fi3

Added a note to the debugging docs about sensitive data.

resolves #1687
---

diff --git a/docs/debugging b/docs/debugging
index 894a873b..639dbdfe 100644
--- a/docs/debugging
+++ b/docs/debugging
@@ -69,6 +69,11 @@ i3-msg 'debuglog on; shmlog on; reload'
 
 == Obtaining the debug logfile
 
+Please note that log files may contain sensitive data such as window titles.
+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.
+
 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.