[v3,1/2] ktap_v2: change version to 2-rc in KTAP specification

Commit Message

Frank Rowand Aug. 29, 2022, 11:31 p.m. UTC

From: Frank Rowand <[e-mail]>

Prepare KTAP Specification for the process of creating version 2.

The version will remain "2-rc" until the final commit to complete
Version 2.  Adding the "-rc" ensures that none of the development
versions will be mistaken for the completed version 2.

After this commit, 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
  ===================================================

This warning will disappear in the final commit for the release of
version 2, when the "-rc" is removed.

Signed-off-by: Frank Rowand <[e-mail]>
---
 Documentation/dev-tools/ktap.rst | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)

Comments

Bagas Sanjaya Aug. 30, 2022, 1:48 a.m. UTC | #1

On 8/30/22 06:31, [e-mail] wrote:
> From: Frank Rowand <[e-mail]>
> 
> Prepare KTAP Specification for the process of creating version 2.
> 
> The version will remain "2-rc" until the final commit to complete
> Version 2.  Adding the "-rc" ensures that none of the development
> versions will be mistaken for the completed version 2.
> 
> After this commit, 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
>   ===================================================
> 
> This warning will disappear in the final commit for the release of
> version 2, when the "-rc" is removed.
> 

I don't see that -rc stripping in patch [2/2], so please fix the Sphinx
warning above in this patch.

Matthew Wilcox Aug. 30, 2022, 12:54 p.m. UTC | #2

On Mon, Aug 29, 2022 at 06:31:49PM -0500, [e-mail] wrote:
> From: Frank Rowand <[e-mail]>
> 
> Prepare KTAP Specification for the process of creating version 2.
> 
> The version will remain "2-rc" until the final commit to complete
> Version 2.  Adding the "-rc" ensures that none of the development
> versions will be mistaken for the completed version 2.
> 
> After this commit, 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
>   ===================================================

Hey Frank, you can actually use overlength lines to prevent this kind of
problem from occurring.  eg, this is perfectly acceptable:

===================================================================
Hi
===================================================================

I wonder if we should prefer this style to avoid the rash of complaints
when a headline is changed.

Frank Rowand Aug. 30, 2022, 3:04 p.m. UTC | #3

On 8/29/22 20:48, Bagas Sanjaya wrote:
> On 8/30/22 06:31, [e-mail] wrote:
>> From: Frank Rowand <[e-mail]>
>>
>> Prepare KTAP Specification for the process of creating version 2.
>>
>> The version will remain "2-rc" until the final commit to complete
>> Version 2.  Adding the "-rc" ensures that none of the development
>> versions will be mistaken for the completed version 2.
>>
>> After this commit, 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
>>   ===================================================
>>
>> This warning will disappear in the final commit for the release of
>> version 2, when the "-rc" is removed.
>>
> 
> I don't see that -rc stripping in patch [2/2], so please fix the Sphinx
> warning above in this patch.
> 

The "final commit for the release of version 2" is not in this patch
series, but will be sometime in the future after all of the other
various patch series to make the changes to create version 2, and we
agree that we have reached the time to finalize and release version 2.

-Frank

Frank Rowand Aug. 30, 2022, 3:06 p.m. UTC | #4

On 8/30/22 07:54, Matthew Wilcox wrote:
> On Mon, Aug 29, 2022 at 06:31:49PM -0500, [e-mail] wrote:
>> From: Frank Rowand <[e-mail]>
>>
>> Prepare KTAP Specification for the process of creating version 2.
>>
>> The version will remain "2-rc" until the final commit to complete
>> Version 2.  Adding the "-rc" ensures that none of the development
>> versions will be mistaken for the completed version 2.
>>
>> After this commit, 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
>>   ===================================================
> 
> Hey Frank, you can actually use overlength lines to prevent this kind of
> problem from occurring.  eg, this is perfectly acceptable:
> 
> ===================================================================
> Hi
> ===================================================================
> 
> I wonder if we should prefer this style to avoid the rash of complaints
> when a headline is changed.

Thanks, that is useful to know.  I think it might be a good idea to
switch to the longer style at some point before the final version 2
release.

-Frank

Patch

diff --git a/Documentation/dev-tools/ktap.rst b/Documentation/dev-tools/ktap.rst
index d0a9565b0f44..b9a57ceddd4f 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
 ===================================================
 
 TAP, or the Test Anything Protocol is a format for specifying test results used