aboutsummaryrefslogtreecommitdiffstats
path: root/Documentation
diff options
context:
space:
mode:
authorDavid Sterba <dsterba@suse.com>2022-05-13 18:54:14 +0200
committerDavid Sterba <dsterba@suse.com>2022-05-17 21:12:19 +0200
commit1c70e888da2009ed088fbfe6e22b42acf7ece951 (patch)
treee7f9cc246e24be3d1cff84cba8abf0e2c17b04e6 /Documentation
parent65f67f58294a111c72bf189964f133b38a6190cd (diff)
downloadbtrfs-progs-1c70e888da2009ed088fbfe6e22b42acf7ece951.tar.gz
btrfs-progs: docs: add subpage feature page
Introductory paragraph, status and progress needs to be added. Signed-off-by: David Sterba <dsterba@suse.com>
Diffstat (limited to 'Documentation')
-rw-r--r--Documentation/Subpage.rst11
-rw-r--r--Documentation/index.rst1
2 files changed, 12 insertions, 0 deletions
diff --git a/Documentation/Subpage.rst b/Documentation/Subpage.rst
new file mode 100644
index 00000000..0aadf3c0
--- /dev/null
+++ b/Documentation/Subpage.rst
@@ -0,0 +1,11 @@
+Subpage support
+===============
+
+Subpage block size support, or just *subpage* for short, is a feature to allow
+using a filesystem that has different size of data block size (*sectorsize*)
+and the host CPU page size. For easier implementation the support was limited
+to the exactly same size of the block and page. On x86_64 this is typically
+4KiB, but there are other architectures commonly used that make use of larger
+pages, like 64KiB on 64bit ARM or PowerPC. A filesystem created on one cannot
+be mounted on the other. The subpage support is still work in progress in 5.18
+but the support is incrementally added with each release.
diff --git a/Documentation/index.rst b/Documentation/index.rst
index 01e563a4..fd430805 100644
--- a/Documentation/index.rst
+++ b/Documentation/index.rst
@@ -35,6 +35,7 @@ Welcome to BTRFS documentation!
Scrub
Seeding-device
Send-receive
+ Subpage
Subvolumes
Swapfile
Tree-checker