linux-doc.vger.kernel.org archive mirror
 help / color / mirror / Atom feed
From: Rae Moar <rmoar@google.com>
To: frowand.list@gmail.com, davidgow@google.com,
	keescook@chromium.org,  raemoar63@gmail.com, Tim.Bird@sony.com,
	shuah@kernel.org
Cc: tytso@google.com, gustavo.padovan@collabora.com,
	 ricardo.canuelo@collabora.com, corbet@lwn.net,
	kernelci@lists.linux.dev,  linux-kselftest@vger.kernel.org,
	kunit-dev@googlegroups.com,  linux-doc@vger.kernel.org,
	linux-kernel@vger.kernel.org,  Rae Moar <rmoar@google.com>
Subject: [PATCH RESEND 0/5] release of KTAP version 2
Date: Fri,  7 Nov 2025 05:29:21 +0000	[thread overview]
Message-ID: <20251107052926.3403265-1-rmoar@google.com> (raw)

Hi all! I wanted to resend out this series to respark the discussion
on KTAP version 2. Many of the features proposed are already in use by
KUnit. This would add these features to the KTAP documentation. Note
that all the features of KTAP v2 are backwards compatible. Also, today
is my last day at Google so I will be responding with my personal
email afterwards.

--

This patch series represents the final release of KTAP version 2.

There have been open discussions on version 2 for just over 2
years. This patch series marks the end of KTAP version 2 development
and beginning of the KTAP version 3 development.

The largest component of KTAP version 2 release is the addition of test
metadata to the specification. KTAP metadata could include any test
information that is pertinent for user interaction before or after the
running of the test. For example, the test file path or the test speed.

Example of KTAP Metadata:

 KTAP version 2
 #:ktap_test: main
 #:ktap_arch: uml
 1..1
     KTAP version 2
     #:ktap_test: suite_1
     #:ktap_subsystem: example
     #:ktap_test_file: lib/test.c
     1..2
     ok 1 test_1
     #:ktap_test: test_2
     #:ktap_speed: very_slow
     # test_2 has begun
     #:custom_is_flaky: true
     ok 2 test_2
 # suite_1 has passed
 ok 1 suite_1

The release also includes some formatting fixes and changes to update
the specification to version 2.

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

Rae Moar (3):
  ktap_v2: add test metadata
  ktap_v2: formatting fixes to ktap spec
  ktap_v2: change version to 2 in KTAP specification

 Documentation/dev-tools/ktap.rst | 273 +++++++++++++++++++++++++++++--
 1 file changed, 257 insertions(+), 16 deletions(-)


base-commit: 9de5f847ef8fa205f4fd704a381d32ecb5b66da9
-- 
2.51.2.1041.gc1ab5b90ca-goog


             reply	other threads:[~2025-11-07  5:29 UTC|newest]

Thread overview: 6+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2025-11-07  5:29 Rae Moar [this message]
2025-11-07  5:29 ` [PATCH RESEND 1/5] ktap_v2: change version to 2-rc in KTAP specification Rae Moar
2025-11-07  5:29 ` [PATCH RESEND 2/5] ktap_v2: change "version 1" to "version 2" in examples Rae Moar
2025-11-07  5:29 ` [PATCH RESEND 3/5] ktap_v2: add test metadata Rae Moar
2025-11-07  5:29 ` [PATCH RESEND 4/5] ktap_v2: formatting fixes to ktap spec Rae Moar
2025-11-07  5:29 ` [PATCH RESEND 5/5] ktap_v2: change version to 2 in KTAP specification Rae Moar

Reply instructions:

You may reply publicly to this message via plain-text email
using any one of the following methods:

* Save the following mbox file, import it into your mail client,
  and reply-to-all from there: mbox

  Avoid top-posting and favor interleaved quoting:
  https://en.wikipedia.org/wiki/Posting_style#Interleaved_style

* Reply using the --to, --cc, and --in-reply-to
  switches of git-send-email(1):

  git send-email \
    --in-reply-to=20251107052926.3403265-1-rmoar@google.com \
    --to=rmoar@google.com \
    --cc=Tim.Bird@sony.com \
    --cc=corbet@lwn.net \
    --cc=davidgow@google.com \
    --cc=frowand.list@gmail.com \
    --cc=gustavo.padovan@collabora.com \
    --cc=keescook@chromium.org \
    --cc=kernelci@lists.linux.dev \
    --cc=kunit-dev@googlegroups.com \
    --cc=linux-doc@vger.kernel.org \
    --cc=linux-kernel@vger.kernel.org \
    --cc=linux-kselftest@vger.kernel.org \
    --cc=raemoar63@gmail.com \
    --cc=ricardo.canuelo@collabora.com \
    --cc=shuah@kernel.org \
    --cc=tytso@google.com \
    /path/to/YOUR_REPLY

  https://kernel.org/pub/software/scm/git/docs/git-send-email.html

* If your mail client supports setting the In-Reply-To header
  via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line before the message body.
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for NNTP newsgroup(s).