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