More docs.

diff --git a/NEWS b/NEWS
index 129f99b68415fdecd576535e941da45967fcaa75..89f55e2771d85c1d2fda51b62a8225b99375c18d 100644 (file)
--- 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 d4a7c0c0157fcdcdb6b5a5fb76676d4ffefd4c4f..c3e4a80db13e426b5d1724ed1a64a404c4be21a2 100644 (file)
--- 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.