document "spy" option
authorblanchet
Mon, 23 Sep 2013 14:53:43 +0200
changeset 53801 342e371395c6
parent 53800 ac1ec5065316
child 53802 44bc6ff8f350
document "spy" option
NEWS
src/Doc/Sledgehammer/document/root.tex
--- a/NEWS	Mon Sep 23 14:53:43 2013 +0200
+++ b/NEWS	Mon Sep 23 14:53:43 2013 +0200
@@ -395,7 +395,7 @@
   - Renamed option:
       isar_shrink ~> isar_compress
     INCOMPATIBILITY.
-  - Added option "isar_try0"
+  - Added options "isar_try0", "spy"
   - Better support for "isar_proofs"
   - MaSh has been fined-tuned and now runs as a local server
 
--- a/src/Doc/Sledgehammer/document/root.tex	Mon Sep 23 14:53:43 2013 +0200
+++ b/src/Doc/Sledgehammer/document/root.tex	Mon Sep 23 14:53:43 2013 +0200
@@ -1016,6 +1016,18 @@
 {\small See also \textit{preplay\_timeout} (\S\ref{timeouts})
 and \textit{dont\_preplay} (\S\ref{timeouts}).}
 
+\opfalse{spy}{dont\_spy}
+Specifies whether Sledgehammer should record statistics in
+\texttt{\$ISA\-BELLE\_\allowbreak HOME\_\allowbreak USER/\allowbreak spy\_\allowbreak sledgehammer}.
+These statistics can be useful to the developers of Sledgehammer. If you are willing to have your
+interactions recorded in the name of science, please enable this feature and send the statistics
+file every now and then to the author of this manual (\authoremail).
+To change the default value of this option globally, set the environment variable
+\texttt{SLEDGEHAMMER\_SPY} to \texttt{yes}.
+
+\nopagebreak
+{\small See also \textit{debug} (\S\ref{output-format}).}
+
 \opfalse{overlord}{no\_overlord}
 Specifies whether Sledgehammer should put its temporary files in
 \texttt{\$ISA\-BELLE\_\allowbreak HOME\_\allowbreak USER}, which is useful for
@@ -1280,7 +1292,8 @@
 automatic runs.
 
 \nopagebreak
-{\small See also \textit{overlord} (\S\ref{mode-of-operation}).}
+{\small See also \textit{spy} (\S\ref{mode-of-operation}) and
+\textit{overlord} (\S\ref{mode-of-operation}).}
 
 \opsmart{isar\_proofs}{no\_isar\_proofs}
 Specifies whether Isar proofs should be output in addition to one-liner