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 2: - correct version 1 change text - version 1 patch 2/2 had not yet been applied when I created version 2, refresh version 2 patch 2/2 for new context
Changes since patch version 1: - drop patch 2/2. Jonathan Corbet has already applied this patch into version 1 of the Specification - 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(-)
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 d0a9565b0f44..b9a57ceddd4f 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
On 8/30/22 06:31, frowand.list@gmail.com wrote:
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.
I don't see that -rc stripping in patch [2/2], so please fix the Sphinx warning above in this patch.
On 8/29/22 20:48, Bagas Sanjaya wrote:
On 8/30/22 06:31, frowand.list@gmail.com wrote:
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.
I don't see that -rc stripping in patch [2/2], so please fix the Sphinx warning above in this patch.
The "final commit for the release of version 2" is not in this patch series, but will be sometime in the future after all of the other various patch series to make the changes to create version 2, and we agree that we have reached the time to finalize and release version 2.
-Frank
On Mon, Aug 29, 2022 at 06:31:49PM -0500, frowand.list@gmail.com wrote:
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
Hey Frank, you can actually use overlength lines to prevent this kind of problem from occurring. eg, this is perfectly acceptable:
=================================================================== Hi ===================================================================
I wonder if we should prefer this style to avoid the rash of complaints when a headline is changed.
On 8/30/22 07:54, Matthew Wilcox wrote:
On Mon, Aug 29, 2022 at 06:31:49PM -0500, frowand.list@gmail.com wrote:
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
Hey Frank, you can actually use overlength lines to prevent this kind of problem from occurring. eg, this is perfectly acceptable:
=================================================================== Hi ===================================================================
I wonder if we should prefer this style to avoid the rash of complaints when a headline is changed.
Thanks, that is useful to know. I think it might be a good idea to switch to the longer style at some point before the final version 2 release.
-Frank
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 ---
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
On 8/29/22 18:31, 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 2:
- correct version 1 change text
- version 1 patch 2/2 had not yet been applied when I created version 2, refresh version 2 patch 2/2 for new context
Changes since patch version 1:
- drop patch 2/2. Jonathan Corbet has already applied this patch into version 1 of the Specification
- 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(-)
The process for developing KTAP spec v2 and the status of proposals and accepted patches can be found at:
linux-kselftest-mirror@lists.linaro.org
-
Bagas Sanjaya -
Frank Rowand -
frowand.list＠gmail.com
-
Matthew Wilcox