Re: [PATCH 2/3] MAINTAINERS: Require kvm-xfstests smoke for ext4

On Wed, Nov 15, 2023 at 10:58:08 AM -0800, Darrick J. Wong wrote:
> On Wed, Nov 15, 2023 at 07:43:50PM +0200, Nikolai Kondrashov wrote:
>> Signed-off-by: Nikolai Kondrashov <[email protected]>
>> ---
>>  Documentation/process/tests.rst | 32 ++++++++++++++++++++++++++++++++
>>  MAINTAINERS                     |  1 +
>>  2 files changed, 33 insertions(+)
>> 
>> diff --git a/Documentation/process/tests.rst b/Documentation/process/tests.rst
>> index 907311e91ec45..9a9ea3fe65c37 100644
>> --- a/Documentation/process/tests.rst
>> +++ b/Documentation/process/tests.rst
>> @@ -33,3 +33,35 @@ particularly useful:
>>  
>>  :Source: A URL pointing to the source code of the test suite
>>  :Docs: A URL pointing to further test suite documentation
>> +
>> +xfstests
>> +--------
>> +
>> +:Summary: File system regression test suite
>> +:Source: git://git.kernel.org/pub/scm/fs/xfs/xfstests-dev.git
>
> You might as well use the https link to the fstests git repo.
> https://git.kernel.org/pub/scm/fs/xfs/xfstests-dev.git
>
>> +:Docs: https://github.com/tytso/xfstests-bld/blob/master/Documentation/what-is-xfstests.md
>
> Awkardly, this github link is nice for rendering the markdown as html,
> but I think the canonical source of xfstests-bld is also kernel.org:
>
> https://git.kernel.org/pub/scm/fs/ext2/xfstests-bld.git
>
>> +
>> +As the name might imply, xfstests is a file system regression test suite which
>> +was originally developed by Silicon Graphics (SGI) for the XFS file system.
>> +Originally, xfstests, like XFS was only supported on the SGI's Irix operating
>> +system. When XFS was ported to Linux, so was xfstests, and now xfstests is
>> +only supported on Linux.
>> +
>> +Today, xfstests is used as a file system regression test suite for all of
>> +Linux's major file systems: xfs, ext2, ext4, cifs, btrfs, f2fs, reiserfs, gfs,
>> +jfs, udf, nfs, and tmpfs. Many file system maintainers will run a full set of
>> +xfstests before sending patches to Linus, and will require that any major
>> +changes be tested using xfstests before they are submitted for integration.
>> +
>> +The easiest way to start running xfstests is under KVM with xfstests-bld:
>> +https://github.com/tytso/xfstests-bld/blob/master/Documentation/kvm-quickstart.md
>> +
>> +kvm-xfstests smoke
>> +------------------
>> +
>> +:Summary: File system smoke tests
>> +:Superset: xfstests
>
> Source: https://git.kernel.org/pub/scm/fs/ext2/xfstests-bld.git
>
> ?
>
>> +:Docs: https://github.com/tytso/xfstests-bld/blob/master/Documentation/kvm-quickstart.md
>> +
>> +The "kvm-xfstests smoke" is a minimal subset of xfstests for testing all major
>> +file systems, running under KVM.
>> diff --git a/MAINTAINERS b/MAINTAINERS
>> index 2565c04f0490e..f81a47d87ac26 100644
>> --- a/MAINTAINERS
>> +++ b/MAINTAINERS
>> @@ -7974,6 +7974,7 @@ L:	[email protected]
>>  S:	Maintained
>>  W:	http://ext4.wiki.kernel.org
>>  Q:	http://patchwork.ozlabs.org/project/linux-ext4/list/
>> +V:	kvm-xfstests smoke
>
> I wouldn't mind one of these being added to the XFS entry, though I've
> cc'd the current and past maintainer(s) of XFS for their input.
>
> --D
>

IMHO, For XFS, The value of "V" field should refer to xfstests rather than a
framework built around xfstests. This is because xfstests project contains the
actual tests and also we could have several frameworks (e.g. Kdevops) for
running xfstests.

I think "kvm-xfstests smoke" could be mentioned in
Documentation/process/tests.rst as one of the easier methods to execute
xfstests.

Also, We could add a statement in Documentation/process/tests.rst encouraging
the patch author to look into xfstests/tests/[generic|xfs]/group.list files to
pick and execute test groups which are applicable to areas of XFS
(e.g. realtime) being modified.


>>  T:	git git://git.kernel.org/pub/scm/linux/kernel/git/tytso/ext4.git
>>  F:	Documentation/filesystems/ext4/
>>  F:	fs/ext4/
>> -- 
>> 2.42.0
>> 

-- 
Chandan