tools: make sure that test groups are described in the documentation
[xfstests-dev.git] / doc / group-names.txt
diff --git a/doc/group-names.txt b/doc/group-names.txt
new file mode 100644 (file)
index 0000000..e8e3477
--- /dev/null
@@ -0,0 +1,135 @@
+======================= =======================================================
+Group Name:            Description:
+======================= =======================================================
+all                    All known tests, automatically generated by ./check at
+                       runtime
+auto                   Tests that should be run automatically.  These should
+                       not require more than ~5 minutes to run.
+quick                  Tests that should run in under 30 seconds.
+deprecated             Old tests that should not be run.
+
+acl                    Access Control Lists
+admin                  xfs_admin functionality
+aio                    general libaio async io tests
+atime                  file access time
+attr                   extended attributes
+attr2                  xfs v2 extended aributes
+balance                        btrfs tree rebalance
+bigtime                        timestamps beyond the year 2038
+blockdev               block device functionality
+broken                 broken tests
+cap                    Linux capabilities
+casefold               directory name casefolding
+ci                     ASCII case-insensitive directory name lookups
+clone                  FICLONE/FICLONERANGE ioctls
+clone_stress           stress testing FICLONE/FICLONERANGE
+collapse               fallocate FALLOC_FL_COLLAPSE_RANGE
+compress               file compression
+convert                        btrfs ext[34] conversion tool
+copy                   xfs_copy functionality
+copy_range             copy_file_range syscall
+copyup                 overlayfs copyup
+dangerous              dangerous test that can crash the system
+dangerous_bothrepair   fuzzers to evaluate xfs_scrub + xfs_repair repair
+dangerous_fuzzers      fuzzers that can crash your computer
+dangerous_norepair     fuzzers to evaluate kernel metadata verifiers
+dangerous_online_repair        fuzzers to evaluate xfs_scrub online repair
+dangerous_repair       fuzzers to evaluate xfs_repair offline repair
+dangerous_scrub                fuzzers to evaluate xfs_scrub checking
+data                   data loss checkers
+dax                    direct access mode for persistent memory files
+db                     xfs_db functional tests
+dedupe                 FIEDEDUPERANGE ioctl
+defrag                 filesystem defragmenters
+dir                    directory test functions
+dump                   dump and restore utilities
+eio                    IO error reporting
+encrypt                        encrypted file contents
+enospc                 ENOSPC error reporting
+exportfs               file handles
+filestreams            XFS filestreams allocator
+freeze                 filesystem freeze tests
+fsck                   general fsck tests
+fsmap                  FS_IOC_GETFSMAP ioctl
+fsr                    XFS free space reorganizer
+fuzzers                        filesystem fuzz tests
+growfs                 increasing the size of a filesystem
+hardlink               hardlinks
+health                 XFS health reporting
+idmapped               idmapped mount functionality
+inobtcount             XFS inode btree count tests
+insert                 fallocate FALLOC_FL_INSERT_RANGE
+ioctl                  general ioctl tests
+io_uring               general io_uring async io tests
+label                  filesystem labelling
+limit                  resource limits
+locks                  file locking
+log                    metadata logging
+logprint               xfs_logprint functional tests
+long_rw                        long-soak read write IO path exercisers
+metacopy               overlayfs metadata-only copy-up
+metadata               filesystem metadata update exercisers
+metadump               xfs_metadump/xfs_mdrestore functionality
+mkfs                   filesystem formatting tools
+mount                  mount option and functionality checks
+nested                 nested overlayfs instances
+nfs4_acl               NFSv4 access control lists
+nonsamefs              overlayfs layers on different filesystems
+online_repair          online repair functionality tests
+other                  dumping ground, do not add more tests to this group
+pattern                        specific IO pattern tests
+perms                  access control and permission checking
+pipe                   pipe functionality
+pnfs                   PNFS
+posix                  POSIX behavior conformance
+prealloc               fallocate for preallocating unwritten space
+preallocrw             fallocate, then read and write
+punch                  fallocate FALLOC_FL_PUNCH_HOLE
+qgroup                 btrfs qgroup feature
+quota                  filesystem usage quotas
+raid                   btrfs RAID
+realtime               XFS realtime volumes
+recoveryloop           crash recovery loops
+redirect               overlayfs redirect_dir feature
+remote                 dump and restore with a remote tape
+remount                        remounting filesystems
+rename                 rename system call
+repair                 xfs_repair functional tests
+replace                        btrfs device replace
+replay                 dm-logwrites replays
+resize                 resize2fs functionality tests
+richacl                        rich ACL feature
+rmap                   XFS reverse mapping exercisers
+rotate                 overlayfs upper layer rotate tests from the unionmount
+                       test suite
+rw                     read/write IO tests
+samefs                 overlayfs when all layers are on the same fs
+scrub                  filesystem metadata scrubbers
+seed                   btrfs seeded filesystems
+seek                   llseek functionality
+send                   btrfs send/receive
+shrinkfs               decreasing the size of a filesystem
+shutdown               FS_IOC_SHUTDOWN ioctl
+snapshot               btrfs snapshots
+soak                   long running soak tests of any kind
+spaceman               xfs_spaceman functional tests
+splice                 splice system call
+stress                 fsstress filesystem exerciser
+subvol                 btrfs subvolumes
+swap                   swap files
+symlink                        symbolic links
+tape                   dump and restore with a tape
+thin                   thin provisioning
+trim                   FITRIM ioctl
+udf                    UDF functionality tests
+union                  tests from the unionmount test suite
+unlink                 O_TMPFILE unlinked files
+unshare                        fallocate FALLOC_FL_UNSHARE_RANGE
+v2log                  XFS v2 log format tests
+verity                 fsverity
+volume                 btrfs volume management
+whiteout               overlayfs whiteout functionality
+xino                   overlayfs xino feature
+zero                   fallocate FALLOC_FL_ZERO_RANGE
+zone                   zoned (SMR) device support
+======================= =======================================================