summaryrefslogtreecommitdiff
path: root/Documentation/btrfstune.asciidoc
diff options
context:
space:
mode:
authorDavid Sterba <dsterba@suse.com>2016-09-01 18:51:18 +0200
committerDavid Sterba <dsterba@suse.com>2016-09-05 10:05:30 +0200
commit51d41fac76b6ef6c0b363000fc87a272cf2c0a8d (patch)
treec414bff7ef3ff0e83edd297b3a6aeb92805c55e7 /Documentation/btrfstune.asciidoc
parent752d8fda32ac645d0cfba82b10e26e17796e626b (diff)
btrfs-progs: docs: describe filesystem features
Signed-off-by: David Sterba <dsterba@suse.com>
Diffstat (limited to 'Documentation/btrfstune.asciidoc')
-rw-r--r--Documentation/btrfstune.asciidoc24
1 files changed, 20 insertions, 4 deletions
diff --git a/Documentation/btrfstune.asciidoc b/Documentation/btrfstune.asciidoc
index 68fec4c9..1e9aa703 100644
--- a/Documentation/btrfstune.asciidoc
+++ b/Documentation/btrfstune.asciidoc
@@ -17,7 +17,11 @@ parameters. The filesystem must be unmounted.
The common usecase is to enable features that were not enabled at mkfs time.
Please make sure that you have kernel support for the features. You can find a
complete list of features and kernel version of their introduction at
-https://btrfs.wiki.kernel.org/index.php/Changelog#By_feature .
+https://btrfs.wiki.kernel.org/index.php/Changelog#By_feature . Also, the
+manual page `mkfs.btrfs`(8) contains more details about the features.
+
+Some of the features could be enabled on a mounted filesytem. Please refer to
+the respective section in `btrfs`(5).
OPTIONS
-------
@@ -26,14 +30,24 @@ Enable seeding on a given device. Value 1 will enable seeding, 0 will disable it
A seeding filesystem is forced to be mounted read-only. A new device can be added
to the filesystem and will capture all writes keeping the seeding device intact.
-r::
+(since kernel: 3.7)
++
Enable extended inode refs (hardlink limit per file in a directory is 65536),
-enabled by mkfs feature 'extref'. Since kernel 3.7.
+enabled by mkfs feature 'extref'.
-x::
+(since kernel: 3.10)
++
Enable skinny metadata extent refs (more efficient representation of extents),
-enabled by mkfs feature 'skinny-metadata'. Since kernel 3.10.
+enabled by mkfs feature 'skinny-metadata'.
++
+All newly created extents will use the new representation. To completely switch
+the entire filesystem, run a full balance of the metadata. Please refer to
+`btrfs-balance`(8).
-n::
+(since kernel: 3.14)
++
Enable no-holes feature (more efficient representation of file holes), enabled
-by mkfs feature 'no-holes'. Since kernel 3.14.
+by mkfs feature 'no-holes'.
-f::
Allow dangerous changes, e.g. clear the seeding flag or change fsid. Make sure
that you are aware of the dangers.
@@ -72,4 +86,6 @@ will become deprecated and removed afterwards.
SEE ALSO
--------
+`btrfs`(5),
+`btrfs-balance`(8),
`mkfs.btrfs`(8)