| Message ID | 20220829233150.3564612-1-frowand.list@gmail.com |
|---|---|
| Headers | show |
| Series | begin KTAP spec v2 process | expand |
On Mon, Aug 29, 2022 at 06:31:49PM -0500, frowand.list@gmail.com wrote: > From: Frank Rowand <frank.rowand@sony.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. 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.
On 8/29/22 20:48, Bagas Sanjaya wrote: > On 8/30/22 06:31, frowand.list@gmail.com wrote: >> From: Frank Rowand <frank.rowand@sony.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. 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
On 8/29/22 18:31, frowand.list@gmail.com wrote: > From: Frank Rowand <frank.rowand@sony.com> > > The process to create version 2 of the KTAP Specification is documented > in email discussions. I am attempting to capture this information at > > https://elinux.org/Test_Results_Format_Notes#KTAP_version_2 > > I am already not following the suggested process, which says: > "...please try to follow this principal of one major topic per email > thread." I think that is ok in this case because the two patches > are related and (hopefully) not controversial. > > Changes since patch version 2: > - correct version 1 change text > - version 1 patch 2/2 had not yet been applied when I created version 2, > refresh version 2 patch 2/2 for new context > > Changes since patch version 1: > - drop patch 2/2. Jonathan Corbet has already applied this patch > into version 1 of the Specification > - add new patch 2/2 > > Frank Rowand (2): > ktap_v2: change version to 2-rc in KTAP specification > ktap_v2: change "version 1" to "version 2" in examples > > Documentation/dev-tools/ktap.rst | 25 +++++++++++++------------ > 1 file changed, 13 insertions(+), 12 deletions(-) > The process for developing KTAP spec v2 and the status of proposals and accepted patches can be found at: https://elinux.org/Test_Results_Format_Notes#KTAP_version_2
From: Frank Rowand <frank.rowand@sony.com> The process to create version 2 of the KTAP Specification is documented in email discussions. I am attempting to capture this information at https://elinux.org/Test_Results_Format_Notes#KTAP_version_2 I am already not following the suggested process, which says: "...please try to follow this principal of one major topic per email thread." I think that is ok in this case because the two patches are related and (hopefully) not controversial. Changes since patch version 2: - correct version 1 change text - version 1 patch 2/2 had not yet been applied when I created version 2, refresh version 2 patch 2/2 for new context Changes since patch version 1: - drop patch 2/2. Jonathan Corbet has already applied this patch into version 1 of the Specification - add new patch 2/2 Frank Rowand (2): ktap_v2: change version to 2-rc in KTAP specification ktap_v2: change "version 1" to "version 2" in examples Documentation/dev-tools/ktap.rst | 25 +++++++++++++------------ 1 file changed, 13 insertions(+), 12 deletions(-)