]> git.ipfire.org Git - thirdparty/linux.git/commitdiff
btrfs: update Kconfig option descriptions
authorDavid Sterba <dsterba@suse.com>
Tue, 6 May 2025 11:04:26 +0000 (13:04 +0200)
committerDavid Sterba <dsterba@suse.com>
Thu, 15 May 2025 12:30:56 +0000 (14:30 +0200)
Expand what the options do and if they are OK to be enabled.

Signed-off-by: David Sterba <dsterba@suse.com>
fs/btrfs/Kconfig

index 8d51a76bc45193163b5016d92601236b69158926..c352f3ae0385c7ba25181b7dd84d48c5ad3fa31a 100644 (file)
@@ -52,10 +52,10 @@ config BTRFS_FS_RUN_SANITY_TESTS
        bool "Btrfs will run sanity tests upon loading"
        depends on BTRFS_FS
        help
-         This will run some basic sanity tests on the free space cache
-         code to make sure it is acting as it should.  These are mostly
-         regression tests and are only really interesting to btrfs
-         developers.
+         This will run sanity tests for core functionality like free space,
+         extent maps, extent io, extent buffers, inodes, qgroups and others,
+         at module load time.  These are mostly regression tests and are only
+         interesting to developers.
 
          If unsure, say N.
 
@@ -63,9 +63,12 @@ config BTRFS_DEBUG
        bool "Btrfs debugging support"
        depends on BTRFS_FS
        help
-         Enable run-time debugging support for the btrfs filesystem. This may
-         enable additional and expensive checks with negative impact on
-         performance, or export extra information via sysfs.
+         Enable run-time debugging support for the btrfs filesystem.
+
+         Additional potentially expensive checks, debugging functionality or
+         sysfs exported information is enabled, like leak checks of internal
+         objects, optional forced space fragmentation and /sys/fs/btrfs/debug .
+         This has negative impact on performance.
 
          If unsure, say N.
 
@@ -73,8 +76,10 @@ config BTRFS_ASSERT
        bool "Btrfs assert support"
        depends on BTRFS_FS
        help
-         Enable run-time assertion checking.  This will result in panics if
-         any of the assertions trip.  This is meant for btrfs developers only.
+         Enable run-time assertion checking. Additional safety checks are
+         done, simple enough not to affect performance but verify invariants
+         and assumptions of code to run properly. This may result in panics,
+         and is meant for developers but can be enabled in general.
 
          If unsure, say N.