summaryrefslogtreecommitdiff
path: root/doc
diff options
context:
space:
mode:
authorRobert Collins <robertc@robertcollins.net>2010-08-30 13:07:00 +1200
committerRobert Collins <robertc@robertcollins.net>2010-08-30 13:07:00 +1200
commitb5d67f43a85f64962fae7789e0d3616908f4fceb (patch)
treeafd9d9cb5f2851cb9d9986dca1eb652166bc5c3f /doc
parent68f933238a270f579d22c6b712beb75bbf0e351d (diff)
downloadtestrepository-b5d67f43a85f64962fae7789e0d3616908f4fceb.tar.gz
Save some doc updates.
Diffstat (limited to 'doc')
-rw-r--r--doc/DESIGN.txt19
-rw-r--r--doc/MANUAL.txt24
2 files changed, 39 insertions, 4 deletions
diff --git a/doc/DESIGN.txt b/doc/DESIGN.txt
index 840787e..3f8bcac 100644
--- a/doc/DESIGN.txt
+++ b/doc/DESIGN.txt
@@ -18,9 +18,10 @@ Data model/storage
~~~~~~~~~~~~~~~~~~
testrepository stores subunit streams as subunit streams in .testrespository
-with simple additional metadata - a format marker to allow this to be changed
-in the future, and a next-stream counter counting the id to give the next
-stream.
+with simple additional metadata. See the MANUAL for documentation on the
+repository layout. The key design elements are that streams are stored
+verbatim, and a testr managed stream called 'failing' is used to track the
+current failures.
Code layout
~~~~~~~~~~~
@@ -36,3 +37,15 @@ all types.
The tests for the code in testrepository.foo.bar is in
testrepository.tests.foo.test_bar. Interface tests for testrepository.foo is
in testrepository.tests.test_foo.
+
+External integration
+~~~~~~~~~~~~~~~~~~~~
+
+Test Repository command, ui, parsing etc objects should all be suitable for
+reuse from other programs.
+
+Threads/concurrency
+~~~~~~~~~~~~~~~~~~~
+
+In general using any public interface
+
diff --git a/doc/MANUAL.txt b/doc/MANUAL.txt
index 77d35c4..d01d6d2 100644
--- a/doc/MANUAL.txt
+++ b/doc/MANUAL.txt
@@ -42,7 +42,7 @@ to run are passed through to your test runner command line. To pass options
through to your test running, use a ``--`` before your options.
For instance, ``testr run foo -- bar --no-plugins`` would run
``foo foo bar --no-plugins | testr load`` using the above config example. The
-command help for ``testr run`` describes the availableoptions for .testr.conf.
+command help for ``testr run`` describes the available options for .testr.conf.
Having setup a .testr.conf, a common workflow then becomes::
@@ -52,3 +52,25 @@ Having setup a .testr.conf, a common workflow then becomes::
$ testr run
# And either commit or loop around this again depending on whether errors
# were found.
+
+Repositories
+~~~~~~~~~~~~
+
+A testr repository is a very simple disk structure. It contains the following
+files (for a format 1 repository - the only current format):
+
+* format: This file identifies the precise layout of the repository, in case
+ future changes are needed.
+
+* next-stream: This file contains the serial number to be used when adding another
+ stream to the repository.
+
+* failing: This file is a stream containing just the known failing tests. It
+ is updated whenever a new stream is added to the repository, so that it only
+ references known failing tests.
+
+* #N - all the streams inserted in the repository are given a serial number.
+
+* repo.conf: This file contains user configuration settings for the repository.
+ ``testr repo-config`` will dump a repo configration and
+ ``test help repo-config`` has online help for all the repository settings.