From: Frank Rowand <frank.rowand@xxxxxxxx> Change the "version line" in example output from "KTAP version 1" to "KTAP version 2". Change version that should be used by compliant tests from 1 to 2. Signed-off-by: Frank Rowand <frank.rowand@xxxxxxxx> --- Changes since patch version 2: - refresh version 2 patch 2/2 for new context Documentation/dev-tools/ktap.rst | 23 ++++++++++++----------- 1 file changed, 12 insertions(+), 11 deletions(-) diff --git a/Documentation/dev-tools/ktap.rst b/Documentation/dev-tools/ktap.rst index b9a57ceddd4f..ff77f4aaa6ef 100644 --- a/Documentation/dev-tools/ktap.rst +++ b/Documentation/dev-tools/ktap.rst @@ -39,6 +39,7 @@ version of the (K)TAP standard the result is compliant with. For example: - "KTAP version 1" +- "KTAP version 2" - "TAP version 13" - "TAP version 14" @@ -46,7 +47,7 @@ Note that, in KTAP, subtests also begin with a version line, which denotes the start of the nested test results. This differs from TAP14, which uses a separate "Subtest" line. -While, going forward, "KTAP version 1" should be used by compliant tests, it +While, going forward, "KTAP version 2" should be used by compliant tests, it is expected that most parsers and other tooling will accept the other versions listed here for compatibility with existing tests and frameworks. @@ -202,9 +203,9 @@ An example of a test with two nested subtests: :: - KTAP version 1 + KTAP version 2 1..1 - KTAP version 1 + KTAP version 2 1..2 ok 1 test_1 not ok 2 test_2 @@ -215,11 +216,11 @@ An example format with multiple levels of nested testing: :: - KTAP version 1 + KTAP version 2 1..2 - KTAP version 1 + KTAP version 2 1..2 - KTAP version 1 + KTAP version 2 1..2 not ok 1 test_1 ok 2 test_2 @@ -250,21 +251,21 @@ Example KTAP output -------------------- :: - KTAP version 1 + KTAP version 2 1..1 - KTAP version 1 + KTAP version 2 1..3 - KTAP version 1 + KTAP version 2 1..1 # test_1: initializing test_1 ok 1 test_1 ok 1 example_test_1 - KTAP version 1 + KTAP version 2 1..2 ok 1 test_1 # SKIP test_1 skipped ok 2 test_2 ok 2 example_test_2 - KTAP version 1 + KTAP version 2 1..3 ok 1 test_1 # test_2: FAIL -- Frank Rowand <frank.rowand@xxxxxxxx>
