summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorJelmer Vernooij <jelmer@jelmer.uk>2018-06-15 16:00:13 +0100
committerGitHub <noreply@github.com>2018-06-15 16:00:13 +0100
commit8dd10641f45b519e1f533220bbc088440a5eb585 (patch)
treef99e93ca769c2a7dbd221417d518cda8adb180ec
parent94397173c7ecc65951afa52ce15120b7bfbd3374 (diff)
parent33e9e111edb366c52e4b5d1672ae0d4921309bb7 (diff)
downloadsubunit-git-8dd10641f45b519e1f533220bbc088440a5eb585.tar.gz
Merge pull request #18 from ligurio/patch-1
Improve readability of SubUnit v2 spec
-rw-r--r--README.rst46
1 files changed, 29 insertions, 17 deletions
diff --git a/README.rst b/README.rst
index 178a0b7..37bd72a 100644
--- a/README.rst
+++ b/README.rst
@@ -263,26 +263,38 @@ Valid version values are:
0x2 - version 2
Feature bits:
-Bit 11 - mask 0x0800 - Test id present.
-Bit 10 - mask 0x0400 - Routing code present.
-Bit 9 - mask 0x0200 - Timestamp present.
-Bit 8 - mask 0x0100 - Test is 'runnable'.
-Bit 7 - mask 0x0080 - Tags are present.
-Bit 6 - mask 0x0040 - File content is present.
-Bit 5 - mask 0x0020 - File MIME type is present.
-Bit 4 - mask 0x0010 - EOF marker.
-Bit 3 - mask 0x0008 - Must be zero in version 2.
+
++---------+-------------+---------------------------+
+| Bit 11 | mask 0x0800 | Test id present. |
++---------+-------------+---------------------------+
+| Bit 10 | mask 0x0400 | Routing code present. |
++---------+-------------+---------------------------+
+| Bit 9 | mask 0x0200 | Timestamp present. |
++---------+-------------+---------------------------+
+| Bit 8 | mask 0x0100 | Test is 'runnable'. |
++---------+-------------+---------------------------+
+| Bit 7 | mask 0x0080 | Tags are present. |
++---------+-------------+---------------------------+
+| Bit 6 | mask 0x0040 | File content is present. |
++---------+-------------+---------------------------+
+| Bit 5 | mask 0x0020 | File MIME type is present.|
++---------+-------------+---------------------------+
+| Bit 4 | mask 0x0010 | EOF marker. |
++---------+-------------+---------------------------+
+| Bit 3 | mask 0x0008 | Must be zero in version 2.|
++---------+-------------+---------------------------+
Test status gets three bits:
Bit 2 | Bit 1 | Bit 0 - mask 0x0007 - A test status enum lookup:
-000 - undefined / no test
-001 - Enumeration / existence
-002 - In progress
-003 - Success
-004 - Unexpected Success
-005 - Skipped
-006 - Failed
-007 - Expected failure
+
+* 000 - undefined / no test
+* 001 - Enumeration / existence
+* 002 - In progress
+* 003 - Success
+* 004 - Unexpected Success
+* 005 - Skipped
+* 006 - Failed
+* 007 - Expected failure
After the flags field is a number field giving the length in bytes for the
entire packet including the signature and the checksum. This length must