Code drop

6 files changed, 77 insertions, 0 deletions

diff --git a/doc/crucible-bootstrap.txt b/doc/crucible-bootstrap.txt
new file mode 100644
index 0000000..eb03dd7
--- /dev/null
+++ b/doc/crucible-bootstrap.txt
@@ -0,0 +1,10 @@
+NAME
+    crucible booststrap - bootstrap test data
+
+SYNOPSIS
+    crucible bootstrap <test-name>
+        [--width <image-width>]
+        [--height <image-height>]
+
+DESCRIPTION
+    TODO
diff --git a/doc/crucible-help.txt b/doc/crucible-help.txt
new file mode 100644
index 0000000..5b3f6c7
--- /dev/null
+++ b/doc/crucible-help.txt
@@ -0,0 +1,9 @@
+NAME
+    crucible help - show help about Crucible
+
+SYNOPSIS
+    crucible help [<command-name>|<topic>]
+
+DESCRIPTION
+    Show help for the given command or topic. If none is given, then print help
+    for the main crucible command.
diff --git a/doc/crucible-ls-example-tests.txt b/doc/crucible-ls-example-tests.txt
new file mode 100644
index 0000000..a859f57
--- /dev/null
+++ b/doc/crucible-ls-example-tests.txt
@@ -0,0 +1,8 @@
+NAME
+    crucible ls-example-tests - list names of example tests
+
+SYNOPSIS
+    crucible ls-example-tests
+
+DESCRIPTION
+    This command takes no arguments.
diff --git a/doc/crucible-ls-tests.txt b/doc/crucible-ls-tests.txt
new file mode 100644
index 0000000..83ba519
--- /dev/null
+++ b/doc/crucible-ls-tests.txt
@@ -0,0 +1,8 @@
+NAME
+    crucible ls-tests - list test names
+
+SYNOPSIS
+    crucible ls-tests
+
+DESCRIPTION
+    This command takes no arguments.
diff --git a/doc/crucible-run.txt b/doc/crucible-run.txt
new file mode 100644
index 0000000..30500cb
--- /dev/null
+++ b/doc/crucible-run.txt
@@ -0,0 +1,34 @@
+NAME
+    crucible run - run tests
+
+SYNOPSIS
+    crucible run [--no-cleanup] [<testname>...]
+
+DESCRIPTION
+    Run tests in the order given on the command line. If no tests are given
+    then run all tests. Example tests are not run, except those whose names
+    match a given glob pattern (see `crucible help ls-example-tests`).
+
+OPTIONS
+    --no-cleanup
+        Disable each test's cleanup phase. This is useful because a test may
+        crash during cleanup but otherwise pass.
+
+EXAMPLES
+    Run all tests (except example tests).
+        $ crucible run
+
+    Run one test.
+        $ crucible run functional.miptree.2d.levels01
+
+    Run multiple tests.
+        $ crucible run functional.miptree.2d.levels01 \\
+                       functional.miptree.2d.levels02 \\
+                       functional.miptree.cubemap.levels09
+
+    Run tests that match glob patterns.
+        $ crucible run 'functional.miptree.cubemap.*' \\
+                       'functional.txf.*'
+
+    Run all example tests.
+        $ crucible run 'example.*'
diff --git a/doc/crucible-version.txt b/doc/crucible-version.txt
new file mode 100644
index 0000000..3b9bed2
--- /dev/null
+++ b/doc/crucible-version.txt
@@ -0,0 +1,8 @@
+NAME
+    crucible version - show version info
+
+SYNOPSIS
+    crucible version
+
+DESCRIPTION
+    This command takes no arguments.