linux-kernel - Re: [RFC PATCH 1/2] Documentation: dev-tools: KTAP spec change version to 2-rc

lists.openwall.net		lists / announce owl-users owl-dev john-users john-dev passwdqc-users yescrypt popa3d-users / oss-security kernel-hardening musl sabotage tlsify passwords / crypt-dev xvendor / Bugtraq Full-Disclosure linux-kernel linux-netdev linux-ext4 linux-hardening linux-cve-announce PHC
Open Source and information security mailing list archives

Hash Suite: Windows password security audit tool. GUI, reports in PDF.

[<prev] [next>] [<thread-prev] [thread-next>] [day] [month] [year] [list]

Message-ID: <CABVgOSm_rQcBhbC5C7Z7_+zEheCjkjHCmzKHyx7b5bYLESvA0A@mail.gmail.com>
Date:   Thu, 17 Mar 2022 16:43:01 +0800
From:   David Gow <davidgow@...gle.com>
To:     Frank Rowand <frowand.list@...il.com>
Cc:     Jonathan Corbet <corbet@....net>,
        Shuah Khan <skhan@...uxfoundation.org>,
        Kees Cook <keescook@...omium.org>,
        "Bird, Tim" <Tim.Bird@...y.com>,
        Brendan Higgins <brendanhiggins@...gle.com>,
        Rae Moar <rmr167@...il.com>,
        Guillaume Tucker <guillaume.tucker@...labora.com>,
        Daniel Latypov <dlatypov@...gle.com>, kernelci@...ups.io,
        KUnit Development <kunit-dev@...glegroups.com>,
        "open list:KERNEL SELFTEST FRAMEWORK" 
        <linux-kselftest@...r.kernel.org>,
        "open list:DOCUMENTATION" <linux-doc@...r.kernel.org>,
        Linux Kernel Mailing List <linux-kernel@...r.kernel.org>
Subject: Re: [RFC PATCH 1/2] Documentation: dev-tools: KTAP spec change
 version to 2-rc

On Thu, Mar 17, 2022 at 4:26 AM <frowand.list@...il.com> wrote:
>
> From: Frank Rowand <frank.rowand@...y.com>
>
> Prepare KTAP Specification for the process of creating Version 2.
> The version will remain 2-rc until the final commit to complete
> Version 2.
>
> Signed-off-by: Frank Rowand <frank.rowand@...y.com>
> ---

This seems okay to me, though I'd generally rather this stay in a
branch rather than hitting torvalds/master while there aren't any
substantive changes to the actual spec. (Basically, let's not rush
naming this "2-rc" for 5.18 if there aren't any other changes: a 2-rc
which is practically the same as 1 is probably going to be more
confusing than helpful if it sticks around for a whole kernel release.

(Also, when would we want to update the various mentions of "KTAP
version 1" in the document to "KTAP version 2" or "KTAP version 2-rc"?
Now, when 2 is released, at the first breaking change to that example,
etc?)

Cheers,
-- David

>  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 5ee735c6687f..37b5dc61bfb8 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
>  ===================================================

Nit: 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
===================================================

>
>  TAP, or the Test Anything Protocol is a format for specifying test results used
> --
> Frank Rowand <frank.rowand@...y.com>
>

Download attachment "smime.p7s" of type "application/pkcs7-signature" (4003 bytes)