Received: by 2002:ab2:6c55:0:b0:1fd:c486:4f03 with SMTP id v21csp269108lqp; Wed, 12 Jun 2024 00:27:45 -0700 (PDT) X-Forwarded-Encrypted: i=3; AJvYcCXfuFavnfNWpHHe3ObxI4co9qvSZS6ms/p9TIkSjUTMAX23HLMt4WjfDxeatG06H3q5l0LGhCT4hBntVoYhWVdE+ur0QmoFuWyjDR4ZqQ== X-Google-Smtp-Source: AGHT+IEUZ6kmhagHRnZDEn9Mo9MmrOKq7AwjO1GZMw/tKpCCyUyIS3lWTI9gguCrSLONAltf4MM7 X-Received: by 2002:a50:d7dd:0:b0:57c:74b1:bf51 with SMTP id 4fb4d7f45d1cf-57ca97626b3mr901269a12.20.1718177265303; Wed, 12 Jun 2024 00:27:45 -0700 (PDT) ARC-Seal: i=2; a=rsa-sha256; t=1718177265; cv=pass; d=google.com; s=arc-20160816; b=Nzt5iMJw8mUwAxglbI6H15dxsfXCadB5QSo2NeOnsMoAnlvM9kOcniHPaSKfAMiTYW MJKFjNeoiHodtPPEatHWn0Y3EB8rfwSwHFpsLKETvRF6BMavlDdyKjkxApDH3crS0+M/ 4Sh6WqztxHFhSsVl3FVGhpN4P7mTR5JU0fQnitAVzRy9Tvrm9rXvGbiqXsefU3jW0zMY b9ej0NhtmoL0lMslfWXW3TJBDIjfVIA4REm/JR0IvwpkYWmcYzEnL0/U50tiuNfy69q3 Vm57r9V5MBDEWBnpYj2BXt8lD3hNAhSy0FXf51v7UwBiWu3vHVSqyYQebV6M7i/uHcuB 03Ow== ARC-Message-Signature: i=2; a=rsa-sha256; c=relaxed/relaxed; d=google.com; s=arc-20160816; h=content-transfer-encoding:mime-version:list-unsubscribe :list-subscribe:list-id:precedence:message-id:date:subject:cc:to :from:dkim-signature; bh=R9kETKXOAV/NjRWtB/tPhF0tnhUa4zL5vToFx57j/E8=; fh=KsUHpNsOaOSWwGWe8LIdK2SX4xyy4FQLB8+JX7+NgW8=; b=k7RpqCVVhD9ItI4uKdCskOch7VJArGVHEnoEyXeLbNUaDd4iHwxPvYMrg2q01xcbQd JioOHE52j79ETkMp5pWFZGEg/qHI3kOncSVcCYwb3Mk91wWZEb93pH2XQlz9v4JKQK0I 7infcy/h8lLiwgFk60XOya5BUXPwBn6wtKSDKxOFj0cuGPXqbO2jv5fwcoR5H6vVL+EX YfYm6yiDznTobNFnXzXW5K5/i0S3jl7nshEPmqR7socCrqxFsWkFADjwBsH7zq8nZDWw /baM8aQJFKbesdQf+vv6OdrO/mknzxq7oXWggElMdHPiJ1cYiUOSZTt7rwktw+XwVFg3 r30A==; dara=google.com ARC-Authentication-Results: i=2; mx.google.com; dkim=pass header.i=@collabora.com header.s=mail header.b=MkGtJ0sD; arc=pass (i=1 spf=pass spfdomain=collabora.com dkim=pass dkdomain=collabora.com dmarc=pass fromdomain=collabora.com); spf=pass (google.com: domain of linux-kernel+bounces-211075-linux.lists.archive=gmail.com@vger.kernel.org designates 2604:1380:4601:e00::3 as permitted sender) smtp.mailfrom="linux-kernel+bounces-211075-linux.lists.archive=gmail.com@vger.kernel.org"; dmarc=pass (p=QUARANTINE sp=QUARANTINE dis=NONE) header.from=collabora.com Return-Path: Received: from am.mirrors.kernel.org (am.mirrors.kernel.org. [2604:1380:4601:e00::3]) by mx.google.com with ESMTPS id 4fb4d7f45d1cf-57aae0c62f2si6741549a12.35.2024.06.12.00.27.45 for (version=TLS1_3 cipher=TLS_AES_256_GCM_SHA384 bits=256/256); Wed, 12 Jun 2024 00:27:45 -0700 (PDT) Received-SPF: pass (google.com: domain of linux-kernel+bounces-211075-linux.lists.archive=gmail.com@vger.kernel.org designates 2604:1380:4601:e00::3 as permitted sender) client-ip=2604:1380:4601:e00::3; Authentication-Results: mx.google.com; dkim=pass header.i=@collabora.com header.s=mail header.b=MkGtJ0sD; arc=pass (i=1 spf=pass spfdomain=collabora.com dkim=pass dkdomain=collabora.com dmarc=pass fromdomain=collabora.com); spf=pass (google.com: domain of linux-kernel+bounces-211075-linux.lists.archive=gmail.com@vger.kernel.org designates 2604:1380:4601:e00::3 as permitted sender) smtp.mailfrom="linux-kernel+bounces-211075-linux.lists.archive=gmail.com@vger.kernel.org"; dmarc=pass (p=QUARANTINE sp=QUARANTINE dis=NONE) header.from=collabora.com Received: from smtp.subspace.kernel.org (wormhole.subspace.kernel.org [52.25.139.140]) (using TLSv1.2 with cipher ECDHE-RSA-AES256-GCM-SHA384 (256/256 bits)) (No client certificate requested) by am.mirrors.kernel.org (Postfix) with ESMTPS id 0C4C21F259E2 for ; Wed, 12 Jun 2024 07:27:45 +0000 (UTC) Received: from localhost.localdomain (localhost.localdomain [127.0.0.1]) by smtp.subspace.kernel.org (Postfix) with ESMTP id 56DBE16C862; Wed, 12 Jun 2024 07:26:55 +0000 (UTC) Authentication-Results: smtp.subspace.kernel.org; dkim=pass (2048-bit key) header.d=collabora.com header.i=@collabora.com header.b="MkGtJ0sD" Received: from madrid.collaboradmins.com (madrid.collaboradmins.com [46.235.227.194]) (using TLSv1.2 with cipher ECDHE-RSA-AES256-GCM-SHA384 (256/256 bits)) (No client certificate requested) by smtp.subspace.kernel.org (Postfix) with ESMTPS id 1816845948; Wed, 12 Jun 2024 07:26:52 +0000 (UTC) Authentication-Results: smtp.subspace.kernel.org; arc=none smtp.client-ip=46.235.227.194 ARC-Seal:i=1; a=rsa-sha256; d=subspace.kernel.org; s=arc-20240116; t=1718177214; cv=none; b=ufp5crxxu9tnopAu5qHEZY+NRh4vtgrtLYTBKkpDZVEofjaYnPDr0YPui0wurj01L0LkEur5pkEQcDqd3zySlcerPRxLRgYlIF1xCxZqFc7f1pCUSPHpGEAjDWu8jwko0FJktlNYneyOus40VhlurKUAYA1htBOO4eHebRLRKX4= ARC-Message-Signature:i=1; a=rsa-sha256; d=subspace.kernel.org; s=arc-20240116; t=1718177214; c=relaxed/simple; bh=ThVc3Kcb94KGiefhslXFeJ1mJHzv8+sc5d1DSQ7YMek=; h=From:To:Cc:Subject:Date:Message-Id:MIME-Version; b=R72Wa8aTZByya2Q4z80a8gYSjodhWz0+7xy80qk3lFAV6FNFkRcbVQQTdAa+jRiiFM32Dq7QldHJu0IBX3QaO+m8oAt6lShLaXoovBx58sIGaeE3e9NNPVGR/wxq1iXFGvPI/ukmn61rqEsKVt7ZdqXkkWmPl3Mf2dwnmMtr/N4= ARC-Authentication-Results:i=1; smtp.subspace.kernel.org; dmarc=pass (p=quarantine dis=none) header.from=collabora.com; spf=pass smtp.mailfrom=collabora.com; dkim=pass (2048-bit key) header.d=collabora.com header.i=@collabora.com header.b=MkGtJ0sD; arc=none smtp.client-ip=46.235.227.194 Authentication-Results: smtp.subspace.kernel.org; dmarc=pass (p=quarantine dis=none) header.from=collabora.com Authentication-Results: smtp.subspace.kernel.org; spf=pass smtp.mailfrom=collabora.com DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/simple; d=collabora.com; s=mail; t=1718177211; bh=ThVc3Kcb94KGiefhslXFeJ1mJHzv8+sc5d1DSQ7YMek=; h=From:To:Cc:Subject:Date:From; b=MkGtJ0sDzDTkbpC9gw+IAYvsTc3PFbOoSZSoYQOIY/pp9oLv2Z9LCSzyTi4Ds4FpG Xd9KKPWWMdPfAuSR36phaQ3DX994pxmC+flK9fiNoDrZkoYQKsBMy/2mX4bxiaTmCg D3TKlq/T3DKAO0W8PrqyahkDxMyDTwg4zdGX+eRAgOzwkvkh7d0abDphN07CpiJes1 SS4Xadlf6DxXjOUw6ZKCTN8fh4MeL77EWYcaLWx1u1H67dyYjfm67YctjWxAxDHzSX s/dpKLe14Yt7uDV29e0fd1FobPnHIGBeAHBq2bOieX0jhgo4+rprR9YtnQp/SWDed3 YGvfsAe0i/NhQ== Received: from localhost.localdomain (ec2-34-240-57-77.eu-west-1.compute.amazonaws.com [34.240.57.77]) (using TLSv1.3 with cipher TLS_AES_256_GCM_SHA384 (256/256 bits) key-exchange X25519 server-signature RSA-PSS (4096 bits) server-digest SHA256) (No client certificate requested) (Authenticated sender: usama.anjum) by madrid.collaboradmins.com (Postfix) with ESMTPSA id 273113781188; Wed, 12 Jun 2024 07:26:48 +0000 (UTC) From: Muhammad Usama Anjum To: Shuah Khan , Jonathan Corbet Cc: Muhammad Usama Anjum , kernel@collabora.com, linux-kselftest@vger.kernel.org, linux-doc@vger.kernel.org, linux-kernel@vger.kernel.org Subject: [PATCH v2] selftests: Add information about TAP conformance in tests Date: Wed, 12 Jun 2024 12:27:23 +0500 Message-Id: <20240612072723.4146613-1-usama.anjum@collabora.com> X-Mailer: git-send-email 2.39.2 Precedence: bulk X-Mailing-List: linux-kernel@vger.kernel.org List-Id: List-Subscribe: List-Unsubscribe: MIME-Version: 1.0 Content-Transfer-Encoding: 8bit Although "TAP" word is being used already in documentation, but it hasn't been defined in informative way for developers that how to write TAP conformant tests and what are the benefits. Write a short brief about it. Signed-off-by: Muhammad Usama Anjum --- Changes since v1: - Update documentation by modifying and removing sentences --- Documentation/dev-tools/kselftest.rst | 7 +++++++ 1 file changed, 7 insertions(+) diff --git a/Documentation/dev-tools/kselftest.rst b/Documentation/dev-tools/kselftest.rst index dcf634e411bd9..f3766e326d1e3 100644 --- a/Documentation/dev-tools/kselftest.rst +++ b/Documentation/dev-tools/kselftest.rst @@ -228,6 +228,13 @@ In general, the rules for selftests are * Don't cause the top-level "make run_tests" to fail if your feature is unconfigured. + * The output of tests must conform to the TAP standard to ensure high + testing quality and to capture failures/errors with specific details. + The kselftest.h and kselftest_harness.h headers provide wrappers for + outputting test results. These wrappers should be used for pass, + fail, exit, and skip messages. CI systems can easily parse TAP output + messages to detect test results. + Contributing new tests (details) ================================ -- 2.39.2