[PATCH v2] selftests: Add information about TAP conformance in tests

[PATCH v2] selftests: Add information about TAP conformance in tests

[Muhammad Usama Anjum]

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 <usama.anjum@collabora.com>
---
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

Re: [PATCH v2] selftests: Add information about TAP conformance in tests

[Shuah Khan]

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 <usama.anjum@collabora.com>
> ---
> 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 <reviewer's name>"

> ---
>   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