2022-05-06 12:44:00

by Frank Rowand

[permalink] [raw]
Subject: [PATCH v2 0/2] begin KTAP spec v2 process

From: Frank Rowand <[email protected]>

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 <[email protected]>



2022-05-06 14:44:46

by Frank Rowand

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

From: Frank Rowand <[email protected]>

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 <[email protected]>
---
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 <[email protected]>