blackbox: rewrite dirty documentation noting it is expensive
authortimeless <timeless@mozdev.org>
Tue, 01 Mar 2016 10:43:52 +0000
changeset 28303 ce24de063aa5
parent 28302 e96a3ae025ed
child 28304 6b38888ab033
blackbox: rewrite dirty documentation noting it is expensive
hgext/blackbox.py
--- a/hgext/blackbox.py	Tue Mar 01 09:49:38 2016 +0000
+++ b/hgext/blackbox.py	Tue Mar 01 10:43:52 2016 +0000
@@ -11,13 +11,12 @@
 Logs event information to .hg/blackbox.log to help debug and diagnose problems.
 The events that get logged can be configured via the blackbox.track config key.
 
-If you want to record whether the repository is dirty (a `+` sign, as you'd
-get when using :hg:`id`), you can set the blackbox.dirty config key.
-
 Examples::
 
   [blackbox]
   track = *
+  # dirty is *EXPENSIVE* (slow);
+  # each log entry indicates `+` if the repository is dirty, like :hg:`id`.
   dirty = True
 
   [blackbox]