From mboxrd@z Thu Jan 1 00:00:00 1970 Received: from mail-io1-f49.google.com (mail-io1-f49.google.com [209.85.166.49]) (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 64E22185E61 for ; Tue, 18 Jun 2024 23:43:23 +0000 (UTC) Authentication-Results: smtp.subspace.kernel.org; arc=none smtp.client-ip=209.85.166.49 ARC-Seal:i=1; a=rsa-sha256; d=subspace.kernel.org; s=arc-20240116; t=1718754205; cv=none; b=BXxS/4BNSW6t00FS3arELbHmT90sLF+zB2zjaHV3vFadRTzXH3v0HdW8heT2if5h0EcV96stvrFGQ7RKLrF+QwQNBJQS8BkqE2A1SWVLTUr0G2lXJ9GTG907slZ0KnGmKaM79awEG7i9G/e51/0k5eSP5CrU7TX1fwzD9qGXa9U= ARC-Message-Signature:i=1; a=rsa-sha256; d=subspace.kernel.org; s=arc-20240116; t=1718754205; c=relaxed/simple; bh=JT0JNMECrMy4aw7rVvFRZG20IaWqJPqXWXGxA66HJeA=; h=Message-ID:Date:MIME-Version:Subject:To:Cc:References:From: In-Reply-To:Content-Type; b=V4EPHkXOo8qJq9p2uMlt06c5tkpQt/vJiC++AihXJXonIuwmLLg4kou/PKucDy3S0FgmVWtizv6I/yGmrQxtdXA603TvkMMHO0Bi0D1AloA0pKg2fkyniv2J6yIsEdS86Lkj6owdsUBr03KgfoY6GmIZ39GlrOkConWF/abqOeQ= ARC-Authentication-Results:i=1; smtp.subspace.kernel.org; dmarc=pass (p=none dis=none) header.from=linuxfoundation.org; spf=pass smtp.mailfrom=linuxfoundation.org; dkim=pass (1024-bit key) header.d=linuxfoundation.org header.i=@linuxfoundation.org header.b=Ol9kNRlN; arc=none smtp.client-ip=209.85.166.49 Authentication-Results: smtp.subspace.kernel.org; dmarc=pass (p=none dis=none) header.from=linuxfoundation.org Authentication-Results: smtp.subspace.kernel.org; spf=pass smtp.mailfrom=linuxfoundation.org Authentication-Results: smtp.subspace.kernel.org; dkim=pass (1024-bit key) header.d=linuxfoundation.org header.i=@linuxfoundation.org header.b="Ol9kNRlN" Received: by mail-io1-f49.google.com with SMTP id ca18e2360f4ac-7ebebdec6c0so20887539f.2 for ; Tue, 18 Jun 2024 16:43:23 -0700 (PDT) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=linuxfoundation.org; s=google; t=1718754202; x=1719359002; darn=vger.kernel.org; h=content-transfer-encoding:in-reply-to:from:content-language :references:cc:to:subject:user-agent:mime-version:date:message-id :from:to:cc:subject:date:message-id:reply-to; bh=h9rdpOi8JxshyFAFLpU0e93AbZSOreFpEAXGG+8lytk=; b=Ol9kNRlNADQJOtPfcsG4RIDEu+bn9L+7JKSX0SdFlwA0YUIeCBaYg3KWREAaPfoGCP dMD3V+h079qFeBSWzPPO5edNqxLYX72fxwICjP9Q3REOhEt0zqqVTglj4mrF+voi9uz3 l6tKkGnS6mfkiIM3eT/2dXcvguqYI8DMgUqQ0= X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=1e100.net; s=20230601; t=1718754202; x=1719359002; h=content-transfer-encoding:in-reply-to:from:content-language :references:cc:to:subject:user-agent:mime-version:date:message-id :x-gm-message-state:from:to:cc:subject:date:message-id:reply-to; bh=h9rdpOi8JxshyFAFLpU0e93AbZSOreFpEAXGG+8lytk=; b=LULHRpwLQ+H4DWv2inyhI/MYH+AtCXQhuV7eciyyQ0Yw/nYvHVSiHRQPwHuWVp0L1Y P/xHeisyASNXW6m3QL0amghyDVE8BUxZFdmj1m1OwzTYswbSzQQ6zZD0z8cdXOn/6HVd L8XhYRcIviDKa+HPadiSM6dWyB/UuAmpe/LWV8WMx//zegFEWBLaUeNmbqna2dyjMvFU CGcf3dJsAwQadhYr5pKqBGJDtJb9cCv84rsP+Wjk/3yHaS6+KvuNnA8KiQ1hOyXTHsmw 2U00p786kr5cmPKMfYeRBKIwH36/hu+QHGJN0fRUCLpxbViqKR9FbCKPGkd1FoRPqouR lh1Q== X-Forwarded-Encrypted: i=1; AJvYcCWJ1dG9mrxYp67rrMAaYuGQXc795E2TFOXGBaZGsU99YnwAGZE87Qh7RzOdovpPXGCoYdvvt1RNw+EoCUTYeyhTMrRjd3Bg1SJikFkP X-Gm-Message-State: AOJu0Yw6omhfLoyQXH+nQxOEXVJ0homr+9nNkcqZ71ExbfaE1lMge1Sa MExjRQwiFtVC25v5gHWJqDNvOBy8+QyUBGNLMwcdOGnwq6Gy7JGSqTwDnjYZ4jA= X-Google-Smtp-Source: AGHT+IEgfEraUGp1/3xnWYLSv3mJ38I1Ff4QXvB7oYKTwoEfflkOmUybcJqiu3mfAAj807U7pdxcgg== X-Received: by 2002:a5e:8e42:0:b0:7e1:8829:51f6 with SMTP id ca18e2360f4ac-7f13ee72e28mr135187939f.1.1718754202422; Tue, 18 Jun 2024 16:43:22 -0700 (PDT) Received: from [192.168.1.128] ([38.175.170.29]) by smtp.gmail.com with ESMTPSA id 8926c6da1cb9f-4b9569ef9d8sm3424643173.95.2024.06.18.16.43.21 (version=TLS1_3 cipher=TLS_AES_128_GCM_SHA256 bits=128/128); Tue, 18 Jun 2024 16:43:22 -0700 (PDT) Message-ID: Date: Tue, 18 Jun 2024 17:43:21 -0600 Precedence: bulk X-Mailing-List: linux-kernel@vger.kernel.org List-Id: List-Subscribe: List-Unsubscribe: MIME-Version: 1.0 User-Agent: Mozilla Thunderbird Subject: Re: [PATCH v2] selftests: Add information about TAP conformance in tests To: Muhammad Usama Anjum , Shuah Khan , Jonathan Corbet Cc: kernel@collabora.com, linux-kselftest@vger.kernel.org, linux-doc@vger.kernel.org, linux-kernel@vger.kernel.org, Shuah Khan References: <20240612072723.4146613-1-usama.anjum@collabora.com> Content-Language: en-US From: Shuah Khan In-Reply-To: <20240612072723.4146613-1-usama.anjum@collabora.com> Content-Type: text/plain; charset=UTF-8; format=flowed Content-Transfer-Encoding: 7bit On 6/12/24 01:27, Muhammad Usama Anjum wrote: > 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 This described what you did which isn't very useful for reviewers. In the future mention why you made these changes instead. Something like "addressed review comments by " > --- > 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) > ================================ > Thank you for this patch. Applied to linux-kselftest next for Linux 6.11-rc1 thanks, -- Shuah