[LTP] [PATCH 1/1] doc: Improve .skip_filesystems documentation

[LTP] [PATCH 1/1] doc: Improve .skip_filesystems documentation

[Petr Vorel]

Signed-off-by: Petr Vorel <pvorel@suse.cz>
---
 doc/c-test-api.txt | 9 +++++++++
 1 file changed, 9 insertions(+)

diff --git a/doc/c-test-api.txt b/doc/c-test-api.txt
index 64ee3397f..2865160cc 100644
--- a/doc/c-test-api.txt
+++ b/doc/c-test-api.txt
@@ -894,6 +894,15 @@ If test needs to adjust expectations based on filesystem type it's also
 possible to detect filesystem type at the runtime. This is preferably used
 when only subset of the test is not applicable for a given filesystem.
 
+NOTE: ext2, ext3 or ext4 in '.skip_filesystems' on tests which does *not* use
+      '.all_filesystems' needs to be defined as 'ext2/ext3/ext4'. The reason
+      is that is hard to detect used filesystem due overlapping the functionality.
+      OTOH tests which use '.skip_filesystems' *with* '.all_filesystems' can skip
+      only filesystems which are actually used in '.all_filesystems': ext2, ext3,
+      ext4, xfs, btrfs, vfat, exfat, ntfs, tmpfs (defined in 'fs_type_whitelist[]').
+      It does not make sense to list other filesystems.
+
+
 [source,c]
 -------------------------------------------------------------------------------
 #include "tst_test.h"
-- 
2.37.3


-- 
Mailing list info: https://lists.linux.it/listinfo/ltp

Re: [LTP] [PATCH 1/1] doc: Improve .skip_filesystems documentation

[Avinesh Kumar]

Hi Petr,

On Thursday, October 6, 2022 3:59:00 PM IST Petr Vorel wrote:
> Signed-off-by: Petr Vorel <pvorel@suse.cz>
> ---
>  doc/c-test-api.txt | 9 +++++++++
>  1 file changed, 9 insertions(+)
> 
> diff --git a/doc/c-test-api.txt b/doc/c-test-api.txt
> index 64ee3397f..2865160cc 100644
> --- a/doc/c-test-api.txt
> +++ b/doc/c-test-api.txt
> @@ -894,6 +894,15 @@ If test needs to adjust expectations based on filesystem type it's also
>  possible to detect filesystem type at the runtime. This is preferably used
>  when only subset of the test is not applicable for a given filesystem.
>  
> +NOTE: ext2, ext3 or ext4 in '.skip_filesystems' on tests which does *not* use
> +      '.all_filesystems' needs to be defined as 'ext2/ext3/ext4'. The reason
> +      is that is hard to detect used filesystem due overlapping the functionality.
nit:
s/that is/that it is
s/due/due to
> +      OTOH tests which use '.skip_filesystems' *with* '.all_filesystems' can skip
> +      only filesystems which are actually used in '.all_filesystems': ext2, ext3,
> +      ext4, xfs, btrfs, vfat, exfat, ntfs, tmpfs (defined in 'fs_type_whitelist[]').
> +      It does not make sense to list other filesystems.
> +
> +
>  [source,c]
>  -------------------------------------------------------------------------------
>  #include "tst_test.h"
> 

Reviewed-by: Avinesh Kumar <akumar@suse.de>


Regards,
Avinesh




-- 
Mailing list info: https://lists.linux.it/listinfo/ltp

Re: [LTP] [PATCH 1/1] doc: Improve .skip_filesystems documentation

[Petr Vorel]

> > +NOTE: ext2, ext3 or ext4 in '.skip_filesystems' on tests which does *not* use
> > +      '.all_filesystems' needs to be defined as 'ext2/ext3/ext4'. The reason
> > +      is that is hard to detect used filesystem due overlapping the functionality.
> nit:
> s/that is/that it is
> s/due/due to
Thanks Avinesh!

Kind regards,
Petr

-- 
Mailing list info: https://lists.linux.it/listinfo/ltp

Re: [LTP] [PATCH 1/1] doc: Improve .skip_filesystems documentation

[Richard Palethorpe]

Hello,

Petr Vorel <pvorel@suse.cz> writes:

>> > +NOTE: ext2, ext3 or ext4 in '.skip_filesystems' on tests which does *not* use
>> > +      '.all_filesystems' needs to be defined as 'ext2/ext3/ext4'. The reason
>> > +      is that is hard to detect used filesystem due overlapping the functionality.
>> nit:
>> s/that is/that it is
>> s/due/due to

Whith that change

Reviewed-by: Richard Palethorpe <rpalethorpe@suse.com>

> Thanks Avinesh!
>
> Kind regards,
> Petr


-- 
Thank you,
Richard.

-- 
Mailing list info: https://lists.linux.it/listinfo/ltp

Re: [LTP] [PATCH 1/1] doc: Improve .skip_filesystems documentation

[Petr Vorel]

Hi all,

typos fixed and merged.
Thanks for your review!

Kind regards,
Petr

-- 
Mailing list info: https://lists.linux.it/listinfo/ltp