sim: document interruption and concurrency issues

Does not seem worth doing a lot of locking and detection of these
problems.

diff --git a/doc/git-annex-sim.mdwn b/doc/git-annex-sim.mdwn
index 25214acd10e139b638ea8a11e32921090873445e..717e0b53e966b16b656a8bf0a7dc37dc3f26743e 100644 (file)
--- a/doc/git-annex-sim.mdwn
+++ b/doc/git-annex-sim.mdwn
@@ -38,6 +38,11 @@ As a convenience, to run a sim from a file, and then stop it, use
 "git-annex sim run". If there is a problem running the sim, it will be
 shown before it is stopped.
 
+Note that interrupting this command while it is running may leave the
+simulation in an inconsistent state. And running multiple sim commands at
+the same time can as well, although it is safe to run "git annex sim visit"
+while running other sim commands.
+
 # THE SIM FILE
 
 This text file is used to configure the simulation and also to report on

diff --git a/doc/todo/git-annex_proxies.mdwn b/doc/todo/git-annex_proxies.mdwn
index f6edadade85035c6703c64f89a29de7dd2d6a7b0..1de475d650f8ea9cc4737e6c43bceae726d4aa31 100644 (file)
--- a/doc/todo/git-annex_proxies.mdwn
+++ b/doc/todo/git-annex_proxies.mdwn
@@ -30,11 +30,6 @@ Planned schedule of work:
 
 * Currently working in [[todo/proving_preferred_content_behavior]].
 
-* The sim cannot be safely interrupted, or two processes be run
-  concurrently. Both unlike other git-annex commands. Either document these
-  limitations, or add locking and make it detect when it was interrupted
-  and re-run the sim from the start to resume.
-
 ## completed items for September's work on proving behavior of preferred content
 
 * Static analysis to detect "not present", "not balanced", and similar