1
linux/Documentation/filesystems/index.rst
Matthew Wilcox (Oracle) 5ec5aab775 doc: split buffer.rst out of api-summary.rst
Buffer heads are no longer a generic filesystem API but an optional
filesystem support library.  Make the documentation structure reflect
that, and include the fine documentation kept in buffer_head.h.  We could
give a better overview of what buffer heads are all about, but my
enthusiasm for documenting it is limited.

[willy@infradead.org: fix kerneldoc warning]
  Link: https://lkml.kernel.org/r/20240417015933.453505-1-willy@infradead.org
[akpm@linux-foundation.org: remove newline at EOF]
Link: https://lkml.kernel.org/r/20240416031754.4076917-9-willy@infradead.org
Signed-off-by: Matthew Wilcox (Oracle) <willy@infradead.org>
Tested-by: Randy Dunlap <rdunlap@infradead.org>
Cc: Pankaj Raghav <p.raghav@samsung.com>
Signed-off-by: Andrew Morton <akpm@linux-foundation.org>
2024-05-05 17:53:40 -07:00

127 lines
1.7 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
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