public inbox for linux-fsdevel@vger.kernel.org
 help / color / mirror / Atom feed
From: Zorro Lang <zlang@kernel.org>
To: fstests@vger.kernel.org
Cc: David Sterba <dsterba@suse.com>, linux-fsdevel@vger.kernel.org
Subject: [PATCH v2] README: add supported fs list
Date: Sat, 29 Mar 2025 00:46:09 +0800	[thread overview]
Message-ID: <20250328164609.188062-1-zlang@kernel.org> (raw)

To clarify the supported filesystems by fstests, add a fs list to
README file.

Signed-off-by: Zorro Lang <zlang@kernel.org>
Acked-by: "Darrick J. Wong" <djwong@kernel.org>
---

The v1 patch and review points:
https://lore.kernel.org/fstests/20250227200514.4085734-1-zlang@kernel.org/

V2 did below things:
1) Fix some wrong english sentences
2) Explain the meaning of "+" and "-".
3) Add a link to btrfs comment.
4) Split ext2/3/4 to 3 lines.
5) Reorder the fs list by "Level".

Thanks,
Zorro

 README | 90 ++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
 1 file changed, 90 insertions(+)

diff --git a/README b/README
index 024d39531..5ceaa0c1e 100644
--- a/README
+++ b/README
@@ -1,3 +1,93 @@
+_______________________
+SUPPORTED FS LIST
+_______________________
+
+History
+-------
+
+Firstly, xfstests is the old name of this project, due to it was originally
+developed for testing the XFS file system on the SGI's Irix operating system.
+When xfs was ported to Linux, so was xfstests, now it only supports Linux.
+
+As xfstests has many test cases that can be run on some other filesystems,
+we call them "generic" (and "shared", but it has been removed) cases, you
+can find them in tests/generic/ directory. Then more and more filesystems
+started to use xfstests, and contribute patches. Today xfstests is used
+as a file system regression test suite for lots of Linux's major file systems.
+So it's not "xfs"tests only, we tend to call it "fstests" now.
+
+Supported fs
+------------
+
+Firstly, there's not hard restriction about which filesystem can use fstests.
+Any filesystem can give fstests a try.
+
+Although fstests supports many filesystems, they have different support level
+by fstests. So mark it with 4 levels as below:
+
+L1: Fstests can be run on the specified fs basically.
+L2: Rare support from the specified fs list to fix some generic test failures.
+L3: Normal support from the specified fs list, has some own cases.
+L4: Active support from the fs list, has lots of own cases.
+
+("+" means a slightly higher than the current level, but not reach to the next.
+"-" is opposite, means a little bit lower than the current level.)
+
++------------+-------+---------------------------------------------------------+
+| Filesystem | Level |                       Comment                           |
++------------+-------+---------------------------------------------------------+
+| XFS        |  L4+  | N/A                                                     |
++------------+-------+---------------------------------------------------------+
+| Btrfs      |  L4   | https://btrfs.readthedocs.io/en/latest/dev/Development-\|
+|            |       | notes.html#fstests-setup                                |
++------------+-------+---------------------------------------------------------+
+| Ext4       |  L4   | N/A                                                     |
++------------+-------+---------------------------------------------------------+
+| Ext2       |  L3   | N/A                                                     |
++------------+-------+---------------------------------------------------------+
+| Ext3       |  L3   | N/A                                                     |
++------------+-------+---------------------------------------------------------+
+| overlay    |  L3   | N/A                                                     |
++------------+-------+---------------------------------------------------------+
+| f2fs       |  L3-  | N/A                                                     |
++------------+-------+---------------------------------------------------------+
+| tmpfs      |  L3-  | N/A                                                     |
++------------+-------+---------------------------------------------------------+
+| NFS        |  L2+  | https://linux-nfs.org/wiki/index.php/Xfstests           |
++------------+-------+---------------------------------------------------------+
+| Ceph       |  L2   | N/A                                                     |
++------------+-------+---------------------------------------------------------+
+| CIFS       |  L2-  | https://wiki.samba.org/index.php/Xfstesting-cifs        |
++------------+-------+---------------------------------------------------------+
+| ocfs2      |  L2-  | N/A                                                     |
++------------+-------+---------------------------------------------------------+
+| Bcachefs   |  L1+  | N/A                                                     |
++------------+-------+---------------------------------------------------------+
+| Exfat      |  L1+  | N/A                                                     |
++------------+-------+---------------------------------------------------------+
+| AFS        |  L1   | N/A                                                     |
++------------+-------+---------------------------------------------------------+
+| FUSE       |  L1   | N/A                                                     |
++------------+-------+---------------------------------------------------------+
+| GFS2       |  L1   | N/A                                                     |
++------------+-------+---------------------------------------------------------+
+| Glusterfs  |  L1   | N/A                                                     |
++------------+-------+---------------------------------------------------------+
+| JFS        |  L1   | N/A                                                     |
++------------+-------+---------------------------------------------------------+
+| pvfs2      |  L1   | N/A                                                     |
++------------+-------+---------------------------------------------------------+
+| Reiser4    |  L1   | Reiserfs has been removed, only left reiser4            |
++------------+-------+---------------------------------------------------------+
+| ubifs      |  L1   | N/A                                                     |
++------------+-------+---------------------------------------------------------+
+| udf        |  L1   | N/A                                                     |
++------------+-------+---------------------------------------------------------+
+| Virtiofs   |  L1   | N/A                                                     |
++------------+-------+---------------------------------------------------------+
+| 9p         |  L1   | N/A                                                     |
++------------+-------+---------------------------------------------------------+
+
 _______________________
 BUILDING THE FSQA SUITE
 _______________________
-- 
2.47.1


             reply	other threads:[~2025-03-28 16:46 UTC|newest]

Thread overview: 6+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2025-03-28 16:46 Zorro Lang [this message]
2025-04-12  6:26 ` [PATCH v2] README: add supported fs list Zorro Lang
2025-04-12 22:54 ` Anand Jain
2025-04-13 21:56 ` Kent Overstreet
2025-04-14  5:58   ` Zorro Lang
2025-04-14 11:09     ` Kent Overstreet

Reply instructions:

You may reply publicly to this message via plain-text email
using any one of the following methods:

* Save the following mbox file, import it into your mail client,
  and reply-to-all from there: mbox

  Avoid top-posting and favor interleaved quoting:
  https://en.wikipedia.org/wiki/Posting_style#Interleaved_style

* Reply using the --to, --cc, and --in-reply-to
  switches of git-send-email(1):

  git send-email \
    --in-reply-to=20250328164609.188062-1-zlang@kernel.org \
    --to=zlang@kernel.org \
    --cc=dsterba@suse.com \
    --cc=fstests@vger.kernel.org \
    --cc=linux-fsdevel@vger.kernel.org \
    /path/to/YOUR_REPLY

  https://kernel.org/pub/software/scm/git/docs/git-send-email.html

* If your mail client supports setting the In-Reply-To header
  via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line before the message body.
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox