aboutsummaryrefslogtreecommitdiffstats
path: root/Documentation/filesystems/btrfs.rst
diff options
context:
space:
mode:
authorMauro Carvalho Chehab <mchehab+huawei@kernel.org>2020-02-17 17:11:54 +0100
committerJonathan Corbet <corbet@lwn.net>2020-03-02 14:01:28 -0700
commit5d43e1bc2dfccbb07ea662fa4536544f1b6efd43 (patch)
treefe9faad07d50932b633791981203c088a36e9cc2 /Documentation/filesystems/btrfs.rst
parentdocs: filesystems: convert bfs.txt to ReST (diff)
downloadlinux-dev-5d43e1bc2dfccbb07ea662fa4536544f1b6efd43.tar.xz
linux-dev-5d43e1bc2dfccbb07ea662fa4536544f1b6efd43.zip
docs: filesystems: convert btrfs.txt to ReST
Just trivial changes: - Add a SPDX header; - Add it to filesystems/index.rst. While here, adjust document title, just to make it use the same style of the other docs. Signed-off-by: Mauro Carvalho Chehab <mchehab+huawei@kernel.org> Acked-by: David Sterba <dsterba@suse.com> Link: https://lore.kernel.org/r/1ef76da4ac24a9a6f6187723554733c702ea19ae.1581955849.git.mchehab+huawei@kernel.org Signed-off-by: Jonathan Corbet <corbet@lwn.net>
Diffstat (limited to 'Documentation/filesystems/btrfs.rst')
-rw-r--r--Documentation/filesystems/btrfs.rst34
1 files changed, 34 insertions, 0 deletions
diff --git a/Documentation/filesystems/btrfs.rst b/Documentation/filesystems/btrfs.rst
new file mode 100644
index 000000000000..d0904f602819
--- /dev/null
+++ b/Documentation/filesystems/btrfs.rst
@@ -0,0 +1,34 @@
+.. SPDX-License-Identifier: GPL-2.0
+
+=====
+BTRFS
+=====
+
+Btrfs is a copy on write filesystem for Linux aimed at implementing advanced
+features while focusing on fault tolerance, repair and easy administration.
+Jointly developed by several companies, licensed under the GPL and open for
+contribution from anyone.
+
+The main Btrfs features include:
+
+ * Extent based file storage (2^64 max file size)
+ * Space efficient packing of small files
+ * Space efficient indexed directories
+ * Dynamic inode allocation
+ * Writable snapshots
+ * Subvolumes (separate internal filesystem roots)
+ * Object level mirroring and striping
+ * Checksums on data and metadata (multiple algorithms available)
+ * Compression
+ * Integrated multiple device support, with several raid algorithms
+ * Offline filesystem check
+ * Efficient incremental backup and FS mirroring
+ * Online filesystem defragmentation
+
+For more information please refer to the wiki
+
+ https://btrfs.wiki.kernel.org
+
+that maintains information about administration tasks, frequently asked
+questions, use cases, mount options, comprehensible changelogs, features,
+manual pages, source code repositories, contacts etc.