mirror of
https://github.com/torvalds/linux.git
synced 2024-09-20 15:03:04 +00:00
a7ca193bc9
Capture the design of iomap and how to port filesystems to use it. Apologies for all the rst formatting, but it's necessary to distinguish code from regular text. A lot of this has been collected from various email conversations, code comments, commit messages, my own understanding of iomap, and Ritesh/Luis' previous efforts to create a document. Please note a large part of this has been taken from Dave's reply to last iomap doc patchset. Thanks to Ritesh, Luis, Dave, Darrick, Matthew, Christoph and other iomap developers who have taken time to explain the iomap design in various emails, commits, comments etc. Cc: Dave Chinner <david@fromorbit.com> Cc: Matthew Wilcox <willy@infradead.org> Cc: Christoph Hellwig <hch@infradead.org> Cc: Christian Brauner <brauner@kernel.org> Cc: Ojaswin Mujoo <ojaswin@linux.ibm.com> Cc: Jan Kara <jack@suse.cz> Cc: Luis Chamberlain <mcgrof@kernel.org> Inspired-by: Ritesh Harjani (IBM) <ritesh.list@gmail.com> Signed-off-by: Darrick J. Wong <djwong@kernel.org> Link: https://lore.kernel.org/r/20240614214347.GK6125@frogsfrogsfrogs Signed-off-by: Christian Brauner <brauner@kernel.org>
128 lines
1.8 KiB
ReStructuredText
128 lines
1.8 KiB
ReStructuredText
.. _filesystems_index:
|
|
|
|
===============================
|
|
Filesystems in the Linux kernel
|
|
===============================
|
|
|
|
This under-development manual will, some glorious day, provide
|
|
comprehensive information on how the Linux virtual filesystem (VFS) layer
|
|
works, along with the filesystems that sit below it. For now, what we have
|
|
can be found below.
|
|
|
|
Core VFS documentation
|
|
======================
|
|
|
|
See these manuals for documentation about the VFS layer itself and how its
|
|
algorithms work.
|
|
|
|
.. toctree::
|
|
:maxdepth: 2
|
|
|
|
vfs
|
|
path-lookup
|
|
api-summary
|
|
splice
|
|
locking
|
|
directory-locking
|
|
devpts
|
|
dnotify
|
|
fiemap
|
|
files
|
|
locks
|
|
mount_api
|
|
quota
|
|
seq_file
|
|
sharedsubtree
|
|
idmappings
|
|
iomap/index
|
|
|
|
automount-support
|
|
|
|
caching/index
|
|
|
|
porting
|
|
|
|
Filesystem support layers
|
|
=========================
|
|
|
|
Documentation for the support code within the filesystem layer for use in
|
|
filesystem implementations.
|
|
|
|
.. toctree::
|
|
:maxdepth: 2
|
|
|
|
buffer
|
|
journalling
|
|
fscrypt
|
|
fsverity
|
|
netfs_library
|
|
|
|
Filesystems
|
|
===========
|
|
|
|
Documentation for filesystem implementations.
|
|
|
|
.. toctree::
|
|
:maxdepth: 2
|
|
|
|
9p
|
|
adfs
|
|
affs
|
|
afs
|
|
autofs
|
|
autofs-mount-control
|
|
bcachefs/index
|
|
befs
|
|
bfs
|
|
btrfs
|
|
ceph
|
|
coda
|
|
configfs
|
|
cramfs
|
|
dax
|
|
debugfs
|
|
dlmfs
|
|
ecryptfs
|
|
efivarfs
|
|
erofs
|
|
ext2
|
|
ext3
|
|
ext4/index
|
|
f2fs
|
|
gfs2
|
|
gfs2-uevents
|
|
gfs2-glocks
|
|
hfs
|
|
hfsplus
|
|
hpfs
|
|
fuse
|
|
fuse-io
|
|
inotify
|
|
isofs
|
|
nilfs2
|
|
nfs/index
|
|
ntfs3
|
|
ocfs2
|
|
ocfs2-online-filecheck
|
|
omfs
|
|
orangefs
|
|
overlayfs
|
|
proc
|
|
qnx6
|
|
ramfs-rootfs-initramfs
|
|
relay
|
|
romfs
|
|
smb/index
|
|
spufs/index
|
|
squashfs
|
|
sysfs
|
|
sysv-fs
|
|
tmpfs
|
|
ubifs
|
|
ubifs-authentication
|
|
udf
|
|
virtiofs
|
|
vfat
|
|
xfs/index
|
|
zonefs
|