README.dev: Document the usage of stop files

Signed-off-by: Ian Campbell <ian.campbell@citrix.com>
Acked-by: Ian Jackson <ian.jackson@eu.citrix.com>

diff --git a/README.dev b/README.dev
index ed8dcf9d66a33fb328d6fb1f2874562a70b0d5eb..e9458a3b19d2d997b3358f814001de166c7c4323 100644 (file)
--- a/README.dev
+++ b/README.dev
@@ -136,3 +136,37 @@ $ cd ~/testing.git
 $ OSSTEST_CONFIG=production-config ./ap-push $branch $revision
 
 NOTE: $revision must be a revision *not* a tag.
+
+Temporarily stopping a branch or the entire system
+==================================================
+
+osstest can be paused by dropping a stop file into either the central
+$HOME/testing.git or $HOME/branches/for-$branch.git etc.
+
+$HOME/testing.git/stop
+
+  stop everything
+
+$HOME/testing.git/daily.stop
+
+  stops all regular tests
+
+$HOME/testing.git/bisect.stop
+
+  stops all bisections
+
+$HOME/testing.git/$branch.stop
+
+  stop regular tests and bisections of $branch
+
+$HOME/branches/for-$branch.git/stop
+
+  stops regular tests $branch
+
+$HOME/bisects/for-$branch.git/stop
+
+  stops bisections of $branch
+
+$HOME/testing.git/$xenbranch.stop
+
+  stops everything using $xenbranch