summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorRobert Collins <robertc@robertcollins.net>2013-02-25 22:08:32 +1300
committerRobert Collins <robertc@robertcollins.net>2013-02-25 22:08:32 +1300
commit51ef4881e36d8984c5bbcb0d577b32cb8175abc9 (patch)
treeda7e486a646fa2ba170ddfef2ead8c9788874ae9
parent03fa780db6e1b76b4bb5056455bb028b02ea22c9 (diff)
downloadsubunit-git-51ef4881e36d8984c5bbcb0d577b32cb8175abc9.tar.gz
More docs.
-rw-r--r--NEWS9
-rw-r--r--README4
2 files changed, 13 insertions, 0 deletions
diff --git a/NEWS b/NEWS
index 129f99b..89f55e2 100644
--- a/NEWS
+++ b/NEWS
@@ -5,6 +5,15 @@ subunit release notes
NEXT (In development)
---------------------
+IMPROVEMENTS
+~~~~~~~~~~~~
+
+* v2 protocol draft included in this release. The v2 protocol trades off
+ human readability for a massive improvement in robustness, the ability
+ to represent concurrent tests in a single stream, cheaper parsing,
+ and that provides significantly better in-line debugging support.
+ (Robert Collins)
+
0.0.10
------
diff --git a/README b/README
index d4a7c0c..c3e4a80 100644
--- a/README
+++ b/README
@@ -153,6 +153,10 @@ Version 2
Version 2 is a binary protocol consisting of independent packets that can be
embedded in the output from tools like make - as long as each packet has no
other bytes mixed in with it (which 'make -j N>1' has a tendency of doing).
+Version 2 is currently in draft form, and early adopters should be willing
+to either discard stored results (if protocol changes are made), or bulk
+convert them back to v1 and then to a newer edition of v2.
+
The protocol synchronises at the start of the stream, after a packet, or
after any 0x0A byte. That is, a subunit v2 packet starts after a newline or
directly after the end of the prior packet.