From patchwork Tue Nov 12 20:07:44 2024 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: Rae Moar X-Patchwork-Id: 843353 Received: from mail-qk1-f201.google.com (mail-qk1-f201.google.com [209.85.222.201]) (using TLSv1.2 with cipher ECDHE-RSA-AES128-GCM-SHA256 (128/128 bits)) (No client certificate requested) by smtp.subspace.kernel.org (Postfix) with ESMTPS id 3210D219E3B for ; Tue, 12 Nov 2024 20:08:09 +0000 (UTC) Authentication-Results: smtp.subspace.kernel.org; arc=none smtp.client-ip=209.85.222.201 ARC-Seal: i=1; a=rsa-sha256; d=subspace.kernel.org; s=arc-20240116; t=1731442090; cv=none; b=py42E9FQWOllZ/+OT6vcEHImp4bBOh83SCBv2S4VTrEkDiXpwk1nuAzuD4qSfrCZzQAT2lRbi6xe5sh/18Z6dFpl8HhWscSJhcMyuTzJPOn0dYAtAfs/OaLIR8hpIABwnv4viJb1N2m8fX1c3TDDdo+yf4FZsMmPhU8t95e2fTU= ARC-Message-Signature: i=1; a=rsa-sha256; d=subspace.kernel.org; s=arc-20240116; t=1731442090; c=relaxed/simple; bh=Cm/eSbmPeMPfJ/E//ira1pv4Z1VsSaUAw7VZkKz7sRA=; h=Date:In-Reply-To:Mime-Version:References:Message-ID:Subject:From: To:Cc:Content-Type; b=B8cU29HCPU/VBSmpI2bA4+HlZ7gK1SIwYuZDE1EzkdldQWEeCm8vPZuqjH0hg6yDKZeVgynz4Uxv8QSvh28TImMWtXIXXa427/bqyf84Mb1cJjCCyBMRY40jJ+nGEkoPChYsp0Bnagc0HH0ddrRc4CdnuWJCgXqahdHUaTVuNQU= ARC-Authentication-Results: i=1; smtp.subspace.kernel.org; dmarc=pass (p=reject dis=none) header.from=google.com; spf=pass smtp.mailfrom=flex--rmoar.bounces.google.com; dkim=pass (2048-bit key) header.d=google.com header.i=@google.com header.b=IoH0jiXV; arc=none smtp.client-ip=209.85.222.201 Authentication-Results: smtp.subspace.kernel.org; dmarc=pass (p=reject dis=none) header.from=google.com Authentication-Results: smtp.subspace.kernel.org; spf=pass smtp.mailfrom=flex--rmoar.bounces.google.com Authentication-Results: smtp.subspace.kernel.org; dkim=pass (2048-bit key) header.d=google.com header.i=@google.com header.b="IoH0jiXV" Received: by mail-qk1-f201.google.com with SMTP id af79cd13be357-7b1492b01b0so791660285a.2 for ; Tue, 12 Nov 2024 12:08:08 -0800 (PST) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=google.com; s=20230601; t=1731442088; x=1732046888; darn=vger.kernel.org; h=cc:to:from:subject:message-id:references:mime-version:in-reply-to :date:from:to:cc:subject:date:message-id:reply-to; bh=XQtsjzam/tQ6ilcR7zH4AHmKAym/OiKHd6SuoQU0pLU=; b=IoH0jiXVW5QRUUG41sckqQ+wzcHFai31/r5PFjCpzgAfM64pB/6V/Fo4ytIdWQpf3Y FAdUjHkI81dcGfqWo/19sGkc5Hqt5xsKr4n/P97da1gR99h7JP8Yx4GjKo09CtplS0Fu UK2nyG3QZBD9L3L2hP86v8Ubu1c9Z3kn+CfJBZW08ph5mEKkxY4Qjaj7ekA6HZ2GFFVh dQoHu/gSFVP4RMfR4Gs5KaDJq+FnCAT5QdpTFSArNkXfaCOvqxvR9Izpn+H8Y0NEhJIz P67pnzbvI4LudxVsSoq0FU17oB++aRAOm+aoFi41KpB4V8hVcjsHmdEFgQZ5VZUYxS3O 0qjw== X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=1e100.net; s=20230601; t=1731442088; x=1732046888; h=cc:to:from:subject:message-id:references:mime-version:in-reply-to :date:x-gm-message-state:from:to:cc:subject:date:message-id:reply-to; bh=XQtsjzam/tQ6ilcR7zH4AHmKAym/OiKHd6SuoQU0pLU=; b=DEyspEEyydu0GGtCbAmfs5n28SHZ+UAKC8CN7B6YHIhTCj1/dQFcE8og+LQ134WOlb s8Zpje1KO+KepFrhiy93HG0iXZqn8mUXy3uVPNrgs+K/K5Gya/BMjk5BiSamZUKG59Dk RFpIlWAezoXYKpkIC2owQv5PUnQKKZ1xOYsqtqNDGXozTtOV62w3LxlCKPfCh2dnVFmi pN0Q5268+ZhplP5zkFrGjQ22H+ujSfu7KGIc/8WHaMxlleI18MA4ikXNSQQ/J6OPNC+9 +JRtv+MrQuaqdk/yiX1HpS8B5ftYDXzpLdmzSoQQJB2589SjGbwrTapAvboRnds9rzPs +/0g== X-Forwarded-Encrypted: i=1; AJvYcCX+RQq0maiOUAaGnN7tPp+iIQUcGC6lf7Jh2W/P6fJaraVNp07I7nbJ+lRimCYETcu+Zz5ZxvHSoJW4Hk71/wM=@vger.kernel.org X-Gm-Message-State: AOJu0YyZobsqlihJiHFG6rGeHW1KBfzT3/5z0hd2IWDNdRoCQ+tOE5mR BAjez2Q0XzgAQo2vWnRpUytrwXwWQYaMznvyuDjDZNsBSq5XKXNaeZIbv92S+oivz533r5lGQA= = X-Google-Smtp-Source: AGHT+IGfGyU7tdZqjtr7KJw/2/4k9KdVjXiekuns5ySOGstmvVLOLtq64XkmS7ScAEgZKCZ7k/oCEnEgBQ== X-Received: from rmoar-specialist.c.googlers.com ([fda3:e722:ac3:cc00:d3:4d64:ac12:6a5d]) (user=rmoar job=sendgmr) by 2002:a05:620a:172b:b0:7b1:50fd:4cd2 with SMTP id af79cd13be357-7b3528cea97mr40585a.5.1731442088098; Tue, 12 Nov 2024 12:08:08 -0800 (PST) Date: Tue, 12 Nov 2024 20:07:44 +0000 In-Reply-To: <20241112200748.791828-1-rmoar@google.com> Precedence: bulk X-Mailing-List: linux-kselftest@vger.kernel.org List-Id: List-Subscribe: List-Unsubscribe: Mime-Version: 1.0 References: <20241112200748.791828-1-rmoar@google.com> X-Mailer: git-send-email 2.47.0.277.g8800431eea-goog Message-ID: <20241112200748.791828-2-rmoar@google.com> Subject: [PATCH 1/5] ktap_v2: change version to 2-rc in KTAP specification From: Rae Moar To: frowand.list@gmail.com, davidgow@google.com, keescook@chromium.org, Tim.Bird@sony.com, shuah@kernel.org, brendanhiggins@google.com 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, Frank Rowand , Rae Moar From: Frank Rowand 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. Reviewed-by: Rae Moar Signed-off-by: Frank Rowand Signed-off-by: Rae Moar --- 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 414c105b10a9..333193f51a53 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 From patchwork Tue Nov 12 20:07:45 2024 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: Rae Moar X-Patchwork-Id: 842784 Received: from mail-yw1-f202.google.com (mail-yw1-f202.google.com [209.85.128.202]) (using TLSv1.2 with cipher ECDHE-RSA-AES128-GCM-SHA256 (128/128 bits)) (No client certificate requested) by smtp.subspace.kernel.org (Postfix) with ESMTPS id EDA66219E58 for ; Tue, 12 Nov 2024 20:08:11 +0000 (UTC) Authentication-Results: smtp.subspace.kernel.org; arc=none smtp.client-ip=209.85.128.202 ARC-Seal: i=1; a=rsa-sha256; d=subspace.kernel.org; s=arc-20240116; t=1731442094; cv=none; b=qbC65NzDUinff/um/h7j/eqEMUk0z1rzBSre7nDpTmpHTK05aRjOBXQfXlEPZ1JF0GF+HakjTncqYC33l8c29wfZiz3qsK3SOqxPMnqtEV7kFOeDsVtp62twMPWFsvzPxkiPVCY2yzOE/JDaLE03iY9UE7vPkLB62ud0LMRLVBg= ARC-Message-Signature: i=1; a=rsa-sha256; d=subspace.kernel.org; s=arc-20240116; t=1731442094; c=relaxed/simple; bh=B2BZlLToTUAjoVWiSQSwNAS8P01rAmnOoNV4PHC+xME=; h=Date:In-Reply-To:Mime-Version:References:Message-ID:Subject:From: To:Cc:Content-Type; b=aFzhE7XNKBGSeSCUSKlWQVOK8Yos4IwcnNbqIbH+MMRqH05rmrfYEjO2n9cRsrka65e6bUfzbITJY4lclQ3E7B8xGPUCRZDnpKcr1l2hAqyE6hgMz/0FMe1uKtFXTIrTYqvK2//K2s/igSmyJ13IJvTe4M6rOV0BPEFOeWKjG5c= ARC-Authentication-Results: i=1; smtp.subspace.kernel.org; dmarc=pass (p=reject dis=none) header.from=google.com; spf=pass smtp.mailfrom=flex--rmoar.bounces.google.com; dkim=pass (2048-bit key) header.d=google.com header.i=@google.com header.b=EqnIm1ue; arc=none smtp.client-ip=209.85.128.202 Authentication-Results: smtp.subspace.kernel.org; dmarc=pass (p=reject dis=none) header.from=google.com Authentication-Results: smtp.subspace.kernel.org; spf=pass smtp.mailfrom=flex--rmoar.bounces.google.com Authentication-Results: smtp.subspace.kernel.org; dkim=pass (2048-bit key) header.d=google.com header.i=@google.com header.b="EqnIm1ue" Received: by mail-yw1-f202.google.com with SMTP id 00721157ae682-6ea7c5805ccso92551417b3.0 for ; Tue, 12 Nov 2024 12:08:11 -0800 (PST) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=google.com; s=20230601; t=1731442091; x=1732046891; darn=vger.kernel.org; h=cc:to:from:subject:message-id:references:mime-version:in-reply-to :date:from:to:cc:subject:date:message-id:reply-to; bh=yLdLdld0TfKxmW0hbDEs868Z4miMeCQgcxYojucNxMY=; b=EqnIm1ue6AMluRbMR86uCkEK9779obZemRDjZWdu7JgkPH7fJ2IcBVMbVYYW5Y1mPF TZMnBAK7lDRQXMc2m7aQcAEwOfPEgomLP+89+Q0PyoBVLhHLgILntyDMpGsfwo3/G/jx AmonKiKnthAVaDYj2y8XXGHt75K7G8GD9ICmWeF1mgJk/8a/mz5tgV8PWhLLMuY9Q8sT LwiPot0uGPL2wkj6/UwP2Uwij9vNGsAKcnOyPqgcKgZYFaKt6GG7IvZRqIGHV94kLe+o kURsokE5SM4EZMlC/in9FFotGhqyXtJrKWy4n0wEmByPsbUJ+eQOevsQwXyh6Aey0o4u vlYg== X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=1e100.net; s=20230601; t=1731442091; x=1732046891; h=cc:to:from:subject:message-id:references:mime-version:in-reply-to :date:x-gm-message-state:from:to:cc:subject:date:message-id:reply-to; bh=yLdLdld0TfKxmW0hbDEs868Z4miMeCQgcxYojucNxMY=; b=lmampU1Dv9/MHQGO5ukDWNfftziCxGfguseuViuckliSbSlLm2xfdneyS6VNZFoCNB VAZ3mQASS/QDMoF90krrauwCu60CZ0+d6EZh0h4bEp7yAPS8IAs3qzvR7AyxRWj/B6k1 aFw+UJyVvom9sgC+s1/CRUpp5l42P3R8rx5FKGzHHYC2vWopW8cM6pDyr1DK7JDK4R2H 1y04upVGRSNhJRuSvb1So6r4nKj7JpLenY9AO2AVL8z+RSUWsSoqMUhDK6OjOEOPNhj+ 1TGp8uuC8yhHilJXb7fKdlN1RAxeHz4SdP2pgIYtHfyu68mNAernX1RIt/2WtCYP2bjX t5Sg== X-Forwarded-Encrypted: i=1; AJvYcCWNQp/5mLfBxXxhjF5qPn6+3RyaMANG5eJwln/SJQqj09OmeKRuks2rCXbgCr2PSO2DNbEPTtequJKprkNAl0g=@vger.kernel.org X-Gm-Message-State: AOJu0Yzr9NwqHcZ8CghweVfXvXmsKY/CcqUpGDO/fcd9mav9b/1qoVz+ +rJ/X/AIKLQIS4ymqs4JFqZpKbY87lHgCq+BRSGS+PpcHAHnH6CAp/l/CH5jts0v//GR95ddeA= = X-Google-Smtp-Source: AGHT+IGGLxhy/xfGywcyzjSFou+hNr9cGpfKtubs2n9Br3Ll18e1mbZqoMdRM1c0fxSfULNH4+V9bbUbIw== X-Received: from rmoar-specialist.c.googlers.com ([fda3:e722:ac3:cc00:d3:4d64:ac12:6a5d]) (user=rmoar job=sendgmr) by 2002:a05:690c:64c1:b0:6ea:1f5b:1f5e with SMTP id 00721157ae682-6ecb34412abmr6067b3.4.1731442091073; Tue, 12 Nov 2024 12:08:11 -0800 (PST) Date: Tue, 12 Nov 2024 20:07:45 +0000 In-Reply-To: <20241112200748.791828-1-rmoar@google.com> Precedence: bulk X-Mailing-List: linux-kselftest@vger.kernel.org List-Id: List-Subscribe: List-Unsubscribe: Mime-Version: 1.0 References: <20241112200748.791828-1-rmoar@google.com> X-Mailer: git-send-email 2.47.0.277.g8800431eea-goog Message-ID: <20241112200748.791828-3-rmoar@google.com> Subject: [PATCH 2/5] ktap_v2: change "version 1" to "version 2" in examples From: Rae Moar To: frowand.list@gmail.com, davidgow@google.com, keescook@chromium.org, Tim.Bird@sony.com, shuah@kernel.org, brendanhiggins@google.com 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, Frank Rowand , Rae Moar From: Frank Rowand 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. Reviewed-by: Rae Moar Signed-off-by: Frank Rowand Signed-off-by: Rae Moar --- 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 333193f51a53..c8f83a7bd470 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 From patchwork Tue Nov 12 20:07:46 2024 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: Rae Moar X-Patchwork-Id: 843352 Received: from mail-yw1-f201.google.com (mail-yw1-f201.google.com [209.85.128.201]) (using TLSv1.2 with cipher ECDHE-RSA-AES128-GCM-SHA256 (128/128 bits)) (No client certificate requested) by smtp.subspace.kernel.org (Postfix) with ESMTPS id C3AD821A4B7 for ; Tue, 12 Nov 2024 20:08:13 +0000 (UTC) Authentication-Results: smtp.subspace.kernel.org; arc=none smtp.client-ip=209.85.128.201 ARC-Seal: i=1; a=rsa-sha256; d=subspace.kernel.org; s=arc-20240116; t=1731442097; cv=none; b=isiX4phhIS7EpFt1dUAmXjC4loJy+KsGdm0+AqXJqRWuBx7UioSLFYM7lS3vnjwzRMJxUgUtTxqxNM5JG5ghgFwn93msbC0XUaoHpBfjAHNC8Ow7DEXhXUY37RK2KPUb5J6uPAOL/FOCwqKmWYjtiu6j9357z6XZirru4+btSac= ARC-Message-Signature: i=1; a=rsa-sha256; d=subspace.kernel.org; s=arc-20240116; t=1731442097; c=relaxed/simple; bh=N/kqKSd5HGjnRCd+J9lM0CPyS/hgrFerGMHg0X1h0mU=; h=Date:In-Reply-To:Mime-Version:References:Message-ID:Subject:From: To:Cc:Content-Type; b=MIOOw1Ez4lpVThVnHQc2A1gDULjYHhbi1YhAuZYPoHxDBVc0zPXL4LZrzxPUZhmaQWTbfouuifR5RiXOSAhjNHYR7CxsfmWF2YQkLfSinzjgQpnrbWO3W4wEMZ/iio15bE/6HuzSe1UH7L/+3eNkektxNEV2hCDv7Lk/umhtOok= ARC-Authentication-Results: i=1; smtp.subspace.kernel.org; dmarc=pass (p=reject dis=none) header.from=google.com; spf=pass smtp.mailfrom=flex--rmoar.bounces.google.com; dkim=pass (2048-bit key) header.d=google.com header.i=@google.com header.b=cMcjZA92; arc=none smtp.client-ip=209.85.128.201 Authentication-Results: smtp.subspace.kernel.org; dmarc=pass (p=reject dis=none) header.from=google.com Authentication-Results: smtp.subspace.kernel.org; spf=pass smtp.mailfrom=flex--rmoar.bounces.google.com Authentication-Results: smtp.subspace.kernel.org; dkim=pass (2048-bit key) header.d=google.com header.i=@google.com header.b="cMcjZA92" Received: by mail-yw1-f201.google.com with SMTP id 00721157ae682-6e6101877abso110892047b3.0 for ; Tue, 12 Nov 2024 12:08:13 -0800 (PST) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=google.com; s=20230601; t=1731442093; x=1732046893; darn=vger.kernel.org; h=cc:to:from:subject:message-id:references:mime-version:in-reply-to :date:from:to:cc:subject:date:message-id:reply-to; bh=ApGi/y+58f9rJEZDIpWpt6jzoTzWeL/xk3OWsFr2GqI=; b=cMcjZA92IJFaxH9s4gSeYZQADDExCcN4sjo4sXP+jFnqesM37zwMpDZ7JHmuZ9w/oi 9HUdtUCAqZyFgPGwwbDpYAWERd1Am6yVYnwposhBPyqRITo+bLOUIMTkZU3TV/qWhHFw iyRlXJHjcOHzIEzzza9bCJ1kEe9ydnnFOyn8TjUUXWsFOW14QTyy6VgrjB43NSyIcEOU uhVbIKE4sODF0Y0G5z6O15R8yELxelrbVqQZqw/WyA77qzWzzn/Wk/rd281ZPzGE4/HQ 3+cDx4JWKuUt+nUmimyEaDe07iFA8Yeowb4T+qhegMR76RhhQSAGcqAtgfFFGAbPOt1b 3L5Q== X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=1e100.net; s=20230601; t=1731442093; x=1732046893; h=cc:to:from:subject:message-id:references:mime-version:in-reply-to :date:x-gm-message-state:from:to:cc:subject:date:message-id:reply-to; bh=ApGi/y+58f9rJEZDIpWpt6jzoTzWeL/xk3OWsFr2GqI=; b=PngkZGcc4OCHeybN2zYUwQ+CXLgs7Qa386DDLYHQI1L1qdGrlbc0BIB8WEMZ8DoQbZ AfEc2AyYo5gxC222OT7aIzzN65WMyYJC9UMoitE1V5LIGtWRHCtZ5mOexpB1D7rD4YlZ tFiUggZXQ9+mgVjFZz5AX6ckOWkD1upI8NQgQl74sWB4zXUUl/sFmFFfRzSZg0z0pctA FWUeWEjmAq9W0BQTvdBMtD9PqVRntmUNFogzkVhFZidDOwGSttQ3TVUxqcg8VcDN+RJo epwmwQQMIX44ArkBN31sp2pG9wCXcR35jGB4+NoN7T6hHSF/D8Lm4QN3lhnyZA9yofI4 JVzg== X-Forwarded-Encrypted: i=1; AJvYcCWn/7EVhubD4low2ka3Poe5zMxnb8rKSO6Fg/oNf6IJN5IgqHc1LCy7jstC6ApFVMrrTq++4fKaV92Po0RnG5Y=@vger.kernel.org X-Gm-Message-State: AOJu0YyPWmmcWk+NPiaYC8u8KL68cvs+Vi3aLuwqRgytGQsIYC74odev oV2og6hASwT1JdbLkGYMUowA+PHGLhlyTi3S08tLOiZlI8yfbTmPk+t/bUIFIYebst05qaJCIg= = X-Google-Smtp-Source: AGHT+IEgl/NagswMe3ogaADqrl8UdqMFKaeMoJU3wMGiXCuoEIJgbxJG6a47VnTjitrfetoMwaEm4xjLgg== X-Received: from rmoar-specialist.c.googlers.com ([fda3:e722:ac3:cc00:d3:4d64:ac12:6a5d]) (user=rmoar job=sendgmr) by 2002:a5b:70a:0:b0:e28:e6a1:fc53 with SMTP id 3f1490d57ef6-e337f8c6c5dmr54106276.5.1731442092914; Tue, 12 Nov 2024 12:08:12 -0800 (PST) Date: Tue, 12 Nov 2024 20:07:46 +0000 In-Reply-To: <20241112200748.791828-1-rmoar@google.com> Precedence: bulk X-Mailing-List: linux-kselftest@vger.kernel.org List-Id: List-Subscribe: List-Unsubscribe: Mime-Version: 1.0 References: <20241112200748.791828-1-rmoar@google.com> X-Mailer: git-send-email 2.47.0.277.g8800431eea-goog Message-ID: <20241112200748.791828-4-rmoar@google.com> Subject: [PATCH 3/5] ktap_v2: add test metadata From: Rae Moar To: frowand.list@gmail.com, davidgow@google.com, keescook@chromium.org, Tim.Bird@sony.com, shuah@kernel.org, brendanhiggins@google.com 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 Add specification for test metadata to the KTAP v2 spec. KTAP v1 only specifies the output format of very basic test information: test result and test name. Any additional test information either gets added to general diagnostic data or is not included in the output at all. The purpose of KTAP metadata is to create a framework to include and easily identify additional important test information in KTAP. 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. Since this includes a large variety of information, this specification will recognize notable types of KTAP metadata to ensure consistent format across test frameworks. See the full list of types in the specification. 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 changes to the KTAP specification outline the format, location, and different types of metadata. Reviewed-by: Kees Cook Reviewed-by: David Gow Signed-off-by: Rae Moar --- Documentation/dev-tools/ktap.rst | 248 ++++++++++++++++++++++++++++++- 1 file changed, 244 insertions(+), 4 deletions(-) diff --git a/Documentation/dev-tools/ktap.rst b/Documentation/dev-tools/ktap.rst index c8f83a7bd470..d4529f4e38c7 100644 --- a/Documentation/dev-tools/ktap.rst +++ b/Documentation/dev-tools/ktap.rst @@ -17,19 +17,21 @@ KTAP test results describe a series of tests (which may be nested: i.e., test can have subtests), each of which can contain both diagnostic data -- e.g., log lines -- and a final result. The test structure and results are machine-readable, whereas the diagnostic data is unstructured and is there to -aid human debugging. +aid human debugging. Since version 2, tests can also contain metadata which +consists of important supplemental test information and can be +machine-readable. -KTAP output is built from four different types of lines: +KTAP output is built from five different types of lines: - Version lines - Plan lines - Test case result lines - Diagnostic lines +- Metadata lines In general, valid KTAP output should also form valid TAP output, but some information, in particular nested test results, may be lost. Also note that there is a stagnant draft specification for TAP14, KTAP diverges from this in -a couple of places (notably the "Subtest" header), which are described where -relevant later in this document. +a couple of places, which are described where relevant later in this document. Version lines ------------- @@ -166,6 +168,238 @@ even if they do not start with a "#": this is to capture any other useful kernel output which may help debug the test. It is nevertheless recommended that tests always prefix any diagnostic output they have with a "#" character. +KTAP metadata lines +------------------- + +KTAP metadata lines are used to include and easily identify important +supplemental test information in KTAP. These lines may appear similar to +diagnostic lines. They were introduced in KTAP version 2. The format of +metadata lines is below: + +.. code-block:: none + + #:_: + +The indicates where to find the specification for the type of +metadata, such as the name of a test framework or "ktap" to indicate this +specification. The list of currently approved prefixes and where to find the +documentation of the metadata types is below. Note any metadata type that does +not use a prefix from the list below must use the prefix "custom". + +Current List of Approved Prefixes: + +- ``ktap``: See Types of KTAP Metadata below for the list of metadata types. + +The format of and varies based on the type. See the +individual specification. For "custom" types the can be any +string excluding ":", spaces, or newline characters and the can be any +string. + +**Location:** + +The first KTAP metadata line for a test must be "#:ktap_test: ", +which acts as a header to associate metadata with the correct test. Metadata +for the main KTAP level uses the test name "main". A test's metadata ends +with a "ktap_test" line for a different test. + +For test cases, the location of the metadata is between the prior test result +line and the current test result line. For test suites, the location of the +metadata is between the suite's version line and test plan line. For the main +level, the location of the metadata is between the main version line and main +test plan line. See the example below. + +Note that a test case's metadata is inline with the test's result line. Whereas +a suite's metadata is inline with the suite's version line and thus will be +more indented than the suite's result line. Additionally, metadata for the main +level is inline with the main version line. + +KTAP metadata for a test does not need to be contiguous. For example, a kernel +warning or other diagnostic output could interrupt metadata lines. However, it +is recommended to keep a test's metadata lines in the correct location and +together when possible, as this improves readability. + +**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 + # WARNING: test_1 skipped + ok 1 test_1 # SKIP + #:ktap_test: test_2 + #:ktap_speed: very_slow + # test_2 has begun + #:custom_is_flaky: true + ok 2 test_2 + # suite_1 passed + ok 1 suite_1 + +In this example, the tests are running on UML. The test suite "suite_1" is part +of the subsystem "example" and belongs to the file "lib/test.c". It has +two subtests, "test_1" and "test_2". The subtest "test_2" has a speed of +"very_slow" and has been marked with a custom KTAP metadata type called +"custom_is_flaky" with the value of "true". + +**Inheritance of KTAP metadata** + +Tests can inherit KTAP metadata. A child test inherits all the parent test's +KTAP metadata except for directly opposing metadata. For example, if a suite +has a property of "#:ktap_speed: slow", all child test cases are also marked as +slow. However, if one of the test cases has metadata of "#:ktap_speed: +very_slow" then that test case would be marked as very_slow instead and not +slow. + +Note if a test case inherits metadata it does not need to appear as a line in +the KTAP. Using the example above, not every test case would have the line +"#:ktap_speed: slow" in their metadata. + +**Edge Case Examples of KTAP metadata** + +Here are a few edge case examples of KTAP metadata. The first example shows +metadata in the wrong location. + +:: + + KTAP version 2 + 1..1 + KTAP version 2 + #:ktap_test: suite_1 + 1..3 + ok 1 test_1 + #:ktap_test: test_2 + #:ktap_speed: very_slow + ok 2 test_2 + #:ktap_duration: 1.342s + #:ktap_test: test_3 + #:ktap_speed: slow + ok 3 test_3 + ok 1 suite_1 + +In this example, the metadata "#:ktap_duration: 1.342s" is in the wrong +location. It was meant to belong to test_2 but was printed late. The location +of this metadata is not recommended. However, it is allowed because the line is +still below "#:ktap_test: test_2" and above any other ktap_test lines. + +This second example shows metadata in the correct location but without the +proper header. + +:: + + KTAP version 2 + 1..1 + KTAP version 2 + #:ktap_test: suite_1 + 1..2 + not ok 1 test_1 + #:ktap_speed: very_slow + ok 2 test_2 + ok 1 suite_1 + +In this example, the metadata "#:ktap_speed: very_slow" is meant to belong to +test_2. It is in the correct location but does not fall below a ktap_test line +for test_2. Instead this metadata might be mistaken for belonging to suite_1 +because it does fall under the ktap_test line for suite_1. This lack of header +is not allowed. + +**Types of KTAP Metadata:** + +This is the current list of KTAP metadata types recognized in this +specification. Note that all of these metadata types are optional (except for +ktap_test as the KTAP metadata header). + +- ``ktap_test``: Name of test (used as header of KTAP metadata). This should + match the test name printed in the test result line: "ok 1 [test_name]". + +- ``ktap_module``: Name of the module containing the test + +- ``ktap_subsystem``: Name of the subsystem being tested + +- ``ktap_start_time``: Time tests started in ISO8601 format + + - Example: "#:ktap_start_time: 2024-01-09T13:09:01.990000+00:00" + +- ``ktap_duration``: Time taken (in seconds) to execute the test + + - Example: "#:ktap_duration: 10.154s" + +- ``ktap_speed``: Category of how fast test runs: "normal", "slow", or + "very_slow" + +- ``ktap_test_file``: Path to source file containing the test. This metadata + line can be repeated if the test is spread across multiple files. + + - Example: "#:ktap_test_file: lib/test.c" + +- ``ktap_generated_file``: Description of and path to file generated during + test execution. This could be a core dump, generated filesystem image, some + form of visual output (for graphics drivers), etc. This metadata line can be + repeated to attach multiple files to the test. Note use ktap_log_file or + ktap_error_file instead of this type if more applicable. + + - Example: "#:ktap_generated_file: Core dump: /var/lib/systemd/coredump/hello.core" + +- ``ktap_log_file``: Path to file containing kernel log test output + + - Example: "#:ktap_log_file: /sys/kernel/debugfs/kunit/example/results" + +- ``ktap_error_file``: Path to file containing context for test failure or + error. This could include the difference between optimal test output and + actual test output. + + - Example: "#:ktap_error_file: fs/results/example.out.bad" + +- ``ktap_results_url``: Link to webpage describing this test run and its + results + + - Example: "#:ktap_results_url: https://kcidb.kernelci.org/hello" + +- ``ktap_arch``: Architecture used during test run + + - Example: "#:ktap_arch: x86_64" + +- ``ktap_compiler``: Compiler used during test run + + - Example: "#:ktap_compiler: gcc (GCC) 10.1.1 20200507 (Red Hat 10.1.1-1)" + +- ``ktap_respository_url``: Link to git repository of the checked out code. + + - Example: "#:ktap_respository_url: https://github.com/torvalds/linux.git" + +- ``ktap_git_branch``: Name of git branch of checked out code + + - Example: "#:ktap_git_branch: kselftest/kunit" + +- ``ktap_kernel_version``: Version of Linux Kernel being used during test run + + - Example: "#:ktap_kernel_version: 6.7-rc1" + +- ``ktap_config``: Config name and value. This does not necessarly need to be + restricted to Kconfig. + + - Example: "#:ktap_config: CONFIG_SYSFS=y" + +- ``ktap_id``: Description of ID and ID value. This is an open-ended metadata + used for IDs, such as checkout id or test run id. + + - Example: "#:ktap_id: Test run id: 14e782" + +- ``ktap_commit_hash``: The full git commit hash of the checked out base code. + + - Example: "#:ktap_commit_hash: 064725faf8ec2e6e36d51e22d3b86d2707f0f47f" + +**Other Metadata Types:** + +There can also be KTAP metadata that is not included in the recognized list +above. This metadata must be prefixed with the test framework, ie. "kselftest", +or with the prefix "custom". For example, "# custom_batch: 20". + Unknown lines ------------- @@ -206,6 +440,7 @@ An example of a test with two nested subtests: KTAP version 2 1..1 KTAP version 2 + #:ktap_test: example 1..2 ok 1 test_1 not ok 2 test_2 @@ -219,6 +454,7 @@ An example format with multiple levels of nested testing: KTAP version 2 1..2 KTAP version 2 + #:ktap_test: example_test_1 1..2 KTAP version 2 1..2 @@ -254,6 +490,7 @@ Example KTAP output KTAP version 2 1..1 KTAP version 2 + #:ktap_test: main_test 1..3 KTAP version 2 1..1 @@ -261,11 +498,14 @@ Example KTAP output ok 1 test_1 ok 1 example_test_1 KTAP version 2 + #:ktap_test: example_test_2 + #:ktap_speed: slow 1..2 ok 1 test_1 # SKIP test_1 skipped ok 2 test_2 ok 2 example_test_2 KTAP version 2 + #:ktap_test: example_test_3 1..3 ok 1 test_1 # test_2: FAIL From patchwork Tue Nov 12 20:07:47 2024 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: Rae Moar X-Patchwork-Id: 842783 Received: from mail-yb1-f201.google.com (mail-yb1-f201.google.com [209.85.219.201]) (using TLSv1.2 with cipher ECDHE-RSA-AES128-GCM-SHA256 (128/128 bits)) (No client certificate requested) by smtp.subspace.kernel.org (Postfix) with ESMTPS id D07E921A4DB for ; Tue, 12 Nov 2024 20:08:16 +0000 (UTC) Authentication-Results: smtp.subspace.kernel.org; arc=none smtp.client-ip=209.85.219.201 ARC-Seal: i=1; a=rsa-sha256; d=subspace.kernel.org; s=arc-20240116; t=1731442098; cv=none; b=hsMbnDOUDY2/K+aGBmQHWSiX4Vh7W1mUB0gs+H7Ngdz0G6nPOap3rHREiMJqPlsE3kXWR7O05RuMds2ExcoGSvn0NzLp6oeCFHHT3+pm5d6CMlbEURymtZ9I+v2xuob1YrUSBT+nLf4t8ORGdl72S2gLlwZXjXlAcB1ugma1t5w= ARC-Message-Signature: i=1; a=rsa-sha256; d=subspace.kernel.org; s=arc-20240116; t=1731442098; c=relaxed/simple; bh=FJxuu9SZEvE8/lpXK8JtYaTHBfXuBPx5hwpAA4obJiI=; h=Date:In-Reply-To:Mime-Version:References:Message-ID:Subject:From: To:Cc:Content-Type; b=tfNAkLzVZXuJg9CoiBHVEGYuBXkbXz89zXomy7gh24Uz1pbgFWKBJuNdEByE20S4TBN86Pwur5MymXdXnDH8uNGoQiWXkI1xK3x91cceHNT7CMvhxdKuenbhisweFEMLnhfJY/+0k6zoPRiEGw4sryyyag+pm9CriFBGQbXU/fQ= ARC-Authentication-Results: i=1; smtp.subspace.kernel.org; dmarc=pass (p=reject dis=none) header.from=google.com; spf=pass smtp.mailfrom=flex--rmoar.bounces.google.com; dkim=pass (2048-bit key) header.d=google.com header.i=@google.com header.b=XZ51q6Xs; arc=none smtp.client-ip=209.85.219.201 Authentication-Results: smtp.subspace.kernel.org; dmarc=pass (p=reject dis=none) header.from=google.com Authentication-Results: smtp.subspace.kernel.org; spf=pass smtp.mailfrom=flex--rmoar.bounces.google.com Authentication-Results: smtp.subspace.kernel.org; dkim=pass (2048-bit key) header.d=google.com header.i=@google.com header.b="XZ51q6Xs" Received: by mail-yb1-f201.google.com with SMTP id 3f1490d57ef6-e30d7b4205eso9214963276.2 for ; Tue, 12 Nov 2024 12:08:16 -0800 (PST) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=google.com; s=20230601; t=1731442096; x=1732046896; darn=vger.kernel.org; h=cc:to:from:subject:message-id:references:mime-version:in-reply-to :date:from:to:cc:subject:date:message-id:reply-to; bh=FZebOFvXhdHbUqBa6VoAUwcXkgGJWlmZrSal3cue+e0=; b=XZ51q6XshVizEXnh5VDUie5LrWsdSgFXmg7auY3003qlpQXCLSqlY/bOx1JkBpxMN3 xF83J8BTjEezwB2F62KmjaGSkQMtJbSpuwtHNsb1ctmFLfWU4JJRH8zozy9NUtVU1V8Y 9wbT7zYXLPRD4O1sS2acXb6m+fTTMeGAoOJ3FbR69vYIOQA2BepmNbRw1Y9R+qPNpfNk mz9qE1hdV94y5KfKNmh9sZ7wT48pRKkMtuozEp4REgd7ZftVA0pW9nYxQuLSr4Je0EdX z4RR72T4Fic19WZdPKBwOWtQsN8vSeVMLS9iR5mjKO8hJRUo9CcNtdVdsr7uCobwL3w9 aqew== X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=1e100.net; s=20230601; t=1731442096; x=1732046896; h=cc:to:from:subject:message-id:references:mime-version:in-reply-to :date:x-gm-message-state:from:to:cc:subject:date:message-id:reply-to; bh=FZebOFvXhdHbUqBa6VoAUwcXkgGJWlmZrSal3cue+e0=; b=wzM7nnqNnGshXxvf7fFFVmlbT6NB4j5Tp1jKDxDh+Ths6Il8Q6xzPub/G+A3uw4Hto KzRptkguJGpzRyAvoeowe3QEnaorEMDaChteIK3Ncvf6gJKCnYNTiRK9W7MK8b/E7LKi k11J9MwGjYIGM+73Giq9EWZFdtOXBGRaBWcLzrj643IMNQb8//pnsUtlKK095lVWG+q1 EBxAlLlPRT9CUS0qOAfuS3YiOuW9n9kksMpCCPAqpg+OisG/xKzmKmz0xX7IA+cGe4ck 3NhJMkgTP4fBeyBVe67TPVWLAvRdwsAcwCF0kk4liuTGP5tOHozuyjCE2D4IBqkqrhc5 uQzQ== X-Forwarded-Encrypted: i=1; AJvYcCWwGlxw4IbGm90qfy48D/vB8wOCAn2HnnLJp4hDMNUIO7mXIrmAhkakRS4mgZ2Cyi4SQW9Dr9aqKek7oXAMRVI=@vger.kernel.org X-Gm-Message-State: AOJu0YxJE3BsoTb/XQKUHuhlhyHxS8JL/TXvMN3bRBsweU2q2vLs6muR fkdEBrHfvikWg8Cs8pRTe5RliTZoasjdNiN3FCSsRKt6Gtiy6bmfeeYz5/Jm9hwtenFe/H9mqg= = X-Google-Smtp-Source: AGHT+IFHMV1811rm2dOpYbT3VPVmCYSYVxNohph1lrNLKTBJ3I8s7FaDFr3MiHn8g8q048q+n0kQifFS+A== X-Received: from rmoar-specialist.c.googlers.com ([fda3:e722:ac3:cc00:d3:4d64:ac12:6a5d]) (user=rmoar job=sendgmr) by 2002:a25:6fc1:0:b0:e2b:cd55:11b3 with SMTP id 3f1490d57ef6-e35ed246250mr179276.5.1731442095955; Tue, 12 Nov 2024 12:08:15 -0800 (PST) Date: Tue, 12 Nov 2024 20:07:47 +0000 In-Reply-To: <20241112200748.791828-1-rmoar@google.com> Precedence: bulk X-Mailing-List: linux-kselftest@vger.kernel.org List-Id: List-Subscribe: List-Unsubscribe: Mime-Version: 1.0 References: <20241112200748.791828-1-rmoar@google.com> X-Mailer: git-send-email 2.47.0.277.g8800431eea-goog Message-ID: <20241112200748.791828-5-rmoar@google.com> Subject: [PATCH 4/5] ktap_v2: formatting fixes to ktap spec From: Rae Moar To: frowand.list@gmail.com, davidgow@google.com, keescook@chromium.org, Tim.Bird@sony.com, shuah@kernel.org, brendanhiggins@google.com 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 Fix formatting of bulleted lists on KTAP specification for new version. Signed-off-by: Rae Moar --- Documentation/dev-tools/ktap.rst | 3 +++ 1 file changed, 3 insertions(+) diff --git a/Documentation/dev-tools/ktap.rst b/Documentation/dev-tools/ktap.rst index d4529f4e38c7..496799e7b87a 100644 --- a/Documentation/dev-tools/ktap.rst +++ b/Documentation/dev-tools/ktap.rst @@ -22,6 +22,7 @@ consists of important supplemental test information and can be machine-readable. KTAP output is built from five different types of lines: + - Version lines - Plan lines - Test case result lines @@ -40,6 +41,7 @@ All KTAP-formatted results begin with a "version line" which specifies which version of the (K)TAP standard the result is compliant with. For example: + - "KTAP version 1" - "KTAP version 2" - "TAP version 13" @@ -517,6 +519,7 @@ Example KTAP output This output defines the following hierarchy: A single test called "main_test", which fails, and has three subtests: + - "example_test_1", which passes, and has one subtest: - "test_1", which passes, and outputs the diagnostic message "test_1: initializing test_1" From patchwork Tue Nov 12 20:07:48 2024 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: Rae Moar X-Patchwork-Id: 843351 Received: from mail-yw1-f202.google.com (mail-yw1-f202.google.com [209.85.128.202]) (using TLSv1.2 with cipher ECDHE-RSA-AES128-GCM-SHA256 (128/128 bits)) (No client certificate requested) by smtp.subspace.kernel.org (Postfix) with ESMTPS id C886921A6F3 for ; Tue, 12 Nov 2024 20:08:18 +0000 (UTC) Authentication-Results: smtp.subspace.kernel.org; arc=none smtp.client-ip=209.85.128.202 ARC-Seal: i=1; a=rsa-sha256; d=subspace.kernel.org; s=arc-20240116; t=1731442100; cv=none; b=j4dqe7wgmy86MCAK2mhDP8uns1iMSi309Hq9+MtpS+JjZAkNqMQc7uQ9hataG21d4XLQFp9mK1dI6wlAMqDASPUSV+K1UzoDd1ypV9XijtRk8E2Wa4jZpYEqYAKW+YlMM7A5+TuCe/sK+A4mGxhqs6Ey8x4KI3PYi+EB9xWbLMw= ARC-Message-Signature: i=1; a=rsa-sha256; d=subspace.kernel.org; s=arc-20240116; t=1731442100; c=relaxed/simple; bh=BZcMip1bKNbU0MtdUd5Um/QIvw5ZzOLApoYfnzoTTh8=; h=Date:In-Reply-To:Mime-Version:References:Message-ID:Subject:From: To:Cc:Content-Type; b=b/kHFABBwSi8OG8O+oimwS9cs9GVGlSSjwqa7MsCfwWK4f84451CgpyMsU8yVftqoug4NWrGO2g0HmJKqYRr1xJAOqybxm9SHnjqyWvDiJuwRzGp90Z7QZ2T3j60gTH6vUKGNv3ne7dBi/c5JEjXH/77JVXiEUGeJ5PkgVI8osY= ARC-Authentication-Results: i=1; smtp.subspace.kernel.org; dmarc=pass (p=reject dis=none) header.from=google.com; spf=pass smtp.mailfrom=flex--rmoar.bounces.google.com; dkim=pass (2048-bit key) header.d=google.com header.i=@google.com header.b=11vZ99T1; arc=none smtp.client-ip=209.85.128.202 Authentication-Results: smtp.subspace.kernel.org; dmarc=pass (p=reject dis=none) header.from=google.com Authentication-Results: smtp.subspace.kernel.org; spf=pass smtp.mailfrom=flex--rmoar.bounces.google.com Authentication-Results: smtp.subspace.kernel.org; dkim=pass (2048-bit key) header.d=google.com header.i=@google.com header.b="11vZ99T1" Received: by mail-yw1-f202.google.com with SMTP id 00721157ae682-6ea8794f354so106507787b3.2 for ; Tue, 12 Nov 2024 12:08:18 -0800 (PST) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=google.com; s=20230601; t=1731442098; x=1732046898; darn=vger.kernel.org; h=cc:to:from:subject:message-id:references:mime-version:in-reply-to :date:from:to:cc:subject:date:message-id:reply-to; bh=F7eUSGCHQaz0mvFxw9nIvdeT0r5uHAkn6h07yqvZcoQ=; b=11vZ99T12k/3EHIeV/EcCTMqw7z/FkoX20BH2vX2VU2+4MtkYLjOejZRjgTLsZCcrv LOjzmjKItPSC4Uvbaj8gslAhP5aF4lVOcaVi2PBqIkmVOZzAT8aQnCQhWwQxiuXySZdJ U8+OHdBNMgq4Gq9Pa4hVABKG90nphFf0+D9Zr3qI3l4ED+7FdbomrjCXZ+iExXA8cZ5m NWAeRW+hWGgOcmExIFIhacTUVAR058BHYIjQtsPeDwILGhD4U3kv9xdBnNzn4JhI86fJ N3qoKUC43/deKP/LKfsQfnIBrmm6t5JaFrcF7H1tF2LOM5NYYY8E8ILC5Wp2y/d27BmX DdEg== X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=1e100.net; s=20230601; t=1731442098; x=1732046898; h=cc:to:from:subject:message-id:references:mime-version:in-reply-to :date:x-gm-message-state:from:to:cc:subject:date:message-id:reply-to; bh=F7eUSGCHQaz0mvFxw9nIvdeT0r5uHAkn6h07yqvZcoQ=; b=U8JZ8VYRb0ZtrM+7KUwgPxT49hpXLBfwLV98ODXz4Z9JUAC/vJEexAT2Qe6tx8VcDu /eQqUdM/z+syR1APyw7qRKD/KEcoQENYL1ifokuhW1MUD5p3Nxe44QA5SsU8XZEnTeWK q3dMoPzfM0QQ4HXfe4ShoI+f+dUI2qrZVMkCkjeJ1IK4pxn3M2HIcCcCo+x6L1EQegxb 3PUCPU/28PpPnbG3eoclUPu53O6+nNzV7adbatkuepQtN9Zsp4LuAAwMGswMrY8PsX7N BeOd4RHpk5hyHwZZwlTqxI0nBAPGniFN8vFfu/xkL4kB/Xo04xQVXB2xr2+kMe24i/j5 E9WQ== X-Forwarded-Encrypted: i=1; AJvYcCVH6VDc8MowKRdWCrDMRTv8zbRBaBoobSh9+Z30if6Pmra7AZ9yLs7HHwbhRBHf3JOXltTPMGQXRGyQJyljZnU=@vger.kernel.org X-Gm-Message-State: AOJu0Ywug0002sQcy5yja5t67APHTxccN56T4zJIX3Jud0KHIxqo2B2L K4g3TRHfGehl2qQb9rVVG6vjndVN7/SdgOfAwHLy5jd20jAQgZ9zobUhuzJx4jXmjI2VUGSw7A= = X-Google-Smtp-Source: AGHT+IEAVxAYdUdYAQubxN8mrbbDw0d3Ds8w2IG/q0VgI/G4c9boud7SVcYUAj1VwuKEfvLwEZTE9bAyMw== X-Received: from rmoar-specialist.c.googlers.com ([fda3:e722:ac3:cc00:d3:4d64:ac12:6a5d]) (user=rmoar job=sendgmr) by 2002:a05:690c:9a0c:b0:6e3:14c3:379a with SMTP id 00721157ae682-6eadda09a7fmr2383017b3.0.1731442097981; Tue, 12 Nov 2024 12:08:17 -0800 (PST) Date: Tue, 12 Nov 2024 20:07:48 +0000 In-Reply-To: <20241112200748.791828-1-rmoar@google.com> Precedence: bulk X-Mailing-List: linux-kselftest@vger.kernel.org List-Id: List-Subscribe: List-Unsubscribe: Mime-Version: 1.0 References: <20241112200748.791828-1-rmoar@google.com> X-Mailer: git-send-email 2.47.0.277.g8800431eea-goog Message-ID: <20241112200748.791828-6-rmoar@google.com> Subject: [PATCH 5/5] ktap_v2: change version to 2 in KTAP specification From: Rae Moar To: frowand.list@gmail.com, davidgow@google.com, keescook@chromium.org, Tim.Bird@sony.com, shuah@kernel.org, brendanhiggins@google.com 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 Prepare KTAP specification for the final release of version 2 by removing "-rc" in the title. This would previously cause a Sphinx warning. This series represents the final version of KTAP version 2 that includes the major addition of test metadata. Signed-off-by: Rae Moar --- 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 496799e7b87a..a8ff15e6d0fa 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 2-rc +The Kernel Test Anything Protocol (KTAP), version 2 =================================================== TAP, or the Test Anything Protocol is a format for specifying test results used