[PATCH v2 0/2] begin KTAP spec v2 process

[PATCH v2 0/2] begin KTAP spec v2 process

[frowand.list]

From: Frank Rowand <frank.rowand@sony.com>

The process to create version 2 of the KTAP Specification is documented
in email discussions.  I am attempting to capture this information at

   https://elinux.org/Test_Results_Format_Notes#KTAP_version_2

I am already not following the suggested process, which says:
"...please try to follow this principal of one major topic per email
thread."  I think that is ok in this case because the two patches
are related and (hopefully) not controversial.

Changes since patch version 1:
   - drop patch 1/2.  Jonathan Corbet has already applied this patch
     into version 1 of the Specification
   - rename patch 2/2 to patch 1/2, with updated patch comment
   - add new patch 2/2

Frank Rowand (2):
  ktap_v2: change version to 2-rc in KTAP specification
  ktap_v2: change "version 1" to "version 2" in examples

 Documentation/dev-tools/ktap.rst | 25 +++++++++++++------------
 1 file changed, 13 insertions(+), 12 deletions(-)

-- 
Frank Rowand <frank.rowand@sony.com>

[PATCH v2 1/2] ktap_v2: change version to 2-rc in KTAP specification

[frowand.list]

From: Frank Rowand <frank.rowand@sony.com>

Prepare KTAP Specification for the process of creating version 2.

The version will remain "2-rc" until the final commit to complete
Version 2.  Adding the "-rc" ensures that none of the development
versions will be mistaken for the completed version 2.

After this commit, Sphinx complains that we now need more '=' signs:

  Documentation/dev-tools/ktap.rst:3: WARNING: Title overline too short.
  ===================================================
  The Kernel Test Anything Protocol (KTAP), version 2-rc
  ===================================================

This warning will disappear in the final commit for the release of
version 2, when the "-rc" is removed.

Signed-off-by: Frank Rowand <frank.rowand@sony.com>
---
 Documentation/dev-tools/ktap.rst | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)

diff --git a/Documentation/dev-tools/ktap.rst b/Documentation/dev-tools/ktap.rst
index 5ee735c6687f..37b5dc61bfb8 100644
--- a/Documentation/dev-tools/ktap.rst
+++ b/Documentation/dev-tools/ktap.rst
@@ -1,7 +1,7 @@
 .. SPDX-License-Identifier: GPL-2.0
 
 ===================================================
-The Kernel Test Anything Protocol (KTAP), version 1
+The Kernel Test Anything Protocol (KTAP), version 2-rc
 ===================================================
 
 TAP, or the Test Anything Protocol is a format for specifying test results used
-- 
Frank Rowand <frank.rowand@sony.com>

[PATCH v2 2/2] ktap_v2: change "version 1" to "version 2" in examples

[frowand.list]

From: Frank Rowand <frank.rowand@sony.com>

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@sony.com>
---
 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 37b5dc61bfb8..c78bb46a4430 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.
 
@@ -204,9 +205,9 @@ An example of a test with two nested subtests:
 
 .. code-block:: none
 
-	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
@@ -217,11 +218,11 @@ An example format with multiple levels of nested testing:
 
 .. code-block:: none
 
-	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
@@ -252,21 +253,21 @@ Example KTAP output
 --------------------
 .. code-block:: none
 
-	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@sony.com>

Re: [PATCH v2 0/2] begin KTAP spec v2 process

[Frank Rowand]

On 5/4/22 17:51, frowand.list@gmail.com wrote:
> From: Frank Rowand <frank.rowand@sony.com>
> 
> The process to create version 2 of the KTAP Specification is documented
> in email discussions.  I am attempting to capture this information at
> 
>    https://elinux.org/Test_Results_Format_Notes#KTAP_version_2
> 
> I am already not following the suggested process, which says:
> "...please try to follow this principal of one major topic per email
> thread."  I think that is ok in this case because the two patches
> are related and (hopefully) not controversial.
> 
> Changes since patch version 1:
>    - drop patch 1/2.  Jonathan Corbet has already applied this patch
>      into version 1 of the Specification
>    - rename patch 2/2 to patch 1/2, with updated patch comment
>    - add new patch 2/2
> 
> Frank Rowand (2):
>   ktap_v2: change version to 2-rc in KTAP specification
>   ktap_v2: change "version 1" to "version 2" in examples
> 
>  Documentation/dev-tools/ktap.rst | 25 +++++++++++++------------
>  1 file changed, 13 insertions(+), 12 deletions(-)
> 

I should note that I will be maintaining a branch of the KTAP Specification version 2
patches and that they will not be submitted to mainline until we agree on the final
content of version 2.