From 5cbafb2a787c5247ad072eab11f104875766b3a8 Mon Sep 17 00:00:00 2001
From: Thomas Levine <_@thomaslevine.com>
Date: Sun, 6 Mar 2016 15:46:06 +0000
Subject: [PATCH] document .urchin_dir

---
 HISTORY | 15 +++++++++++----
 TODO    | 11 -----------
 2 files changed, 11 insertions(+), 15 deletions(-)

diff --git a/HISTORY b/HISTORY
index 2a92a7a..9b2a872 100644
--- a/HISTORY
+++ b/HISTORY
@@ -12,18 +12,18 @@ test suite, as we need to know how far up to apply the setup
 and teardown files.
 
 The Urchin root directory is determined by moving higher in the directory
-tree in search of a file named `.urchin`.
+tree in search of a file named `.urchin_root`.
 The closest directory that contains such a file is considered the root.
 In the following filesystem, for example, `/a/b/c` would be the root.
 
     mkdir -p /a/b/c/d
     touch /a/b/c/d/e
     chmod +x /a/b/c/d/e
-    touch /a/b/c/.urchin
+    touch /a/b/c/.urchin_root
     urchin /a/b/c/d
 
 There are two situations in which we would stop looking without having
-found a `.urchin` file.
+found a `.urchin_root` file.
 
 1. The system root, `/`, because we can't go any higher
 2. A directory that starts with a dot, because an urchin call on a higher
@@ -97,6 +97,13 @@ turned on.
 
 Parallel processing and shell cycling are both enabled by default.
 
+You may want make only some directories run in series, you can create
+".urchin_dir" files in those directories.
+If .urchin_dir contains the phrase "series", run that directory in series
+rather than in parallel.
+This is helpful when directories actually need to run in series
+and also when running all your tests in parallel crashes your computer.
+
 ### Options
 Long options are now available for all command line flags.
 For example, the `-s` flag is now available as `--shell` as well.
@@ -229,7 +236,7 @@ other Urchin call), and the test suite is recursively descended. Setup and
 teardown files are sourced, and everything but the specified test file is
 otherwise ignored.
 
-If you don't explicitly specify the Urchin root with a .urchin file, we
+If you don't explicitly specify the Urchin root with a .urchin_root file, we
 consider the test suite root directory to be the parent of the file that
 you ran Urchin on.
 
diff --git a/TODO b/TODO
index f8514cb..37df9c0 100644
--- a/TODO
+++ b/TODO
@@ -46,17 +46,6 @@ List some shell linters somewhere.
 * checkbashisms
 
 
-Set parallel and series
-----------
-I want to be able to make only some directories run in series.
-This is helpful when directories actually need to run in series
-and also when running all your tests in parallel crashes your computer.
-
-* Rename .urchin to .urchin_root.
-* Look for a .urchin_dir file.
-* If .urchin_dir contains "series", run that directory in series rather
-  than in parallel.
-
 Rename to something other than "test"?
 ----------
 Maybe wait until I have a use for this.