Gitiles
Code Review Sign In
review.shift-gmbh.com / SHIFTPHONES / mainline / linux / fc2f6fe745a0fa287f68cb8fba04040aaf73fa28 / . / Documentation / filesystems / index.rst
blob: e242cb75f9f24086ae8614c8f4dc9567104fe38d [file] [log] [blame]
Wang Wenhu9d4ca8c2020-03-16 04:01:31 -0700[diff] [blame]1.. _filesystems_index:
2
Jonathan Corbet40641742019-02-20 15:29:36 -0700[diff] [blame]3===============================
4Filesystems in the Linux kernel
5===============================
Mauro Carvalho Chehab90f9f112017-05-12 06:50:22 -0300[diff] [blame]6
Jonathan Corbet40641742019-02-20 15:29:36 -0700[diff] [blame]7This under-development manual will, some glorious day, provide
8comprehensive information on how the Linux virtual filesystem (VFS) layer
9works, along with the filesystems that sit below it. For now, what we have
10can be found below.
Mauro Carvalho Chehab90f9f112017-05-12 06:50:22 -0300[diff] [blame]11
Jonathan Corbet40641742019-02-20 15:29:36 -0700[diff] [blame]12Core VFS documentation
Mauro Carvalho Chehab90f9f112017-05-12 06:50:22 -0300[diff] [blame]13======================
14
Jonathan Corbet40641742019-02-20 15:29:36 -0700[diff] [blame]15See these manuals for documentation about the VFS layer itself and how its
16algorithms work.
NeilBrown7bbfd9a2018-12-05 10:02:51 +1100[diff] [blame]17
18.. toctree::
19 :maxdepth: 2
20
Tobin C. Hardingaf96c1e32019-05-15 10:29:13 +1000[diff] [blame]21 vfs
Mauro Carvalho Chehab7c116d22019-06-26 10:35:11 -0300[diff] [blame]22 path-lookup
Jonathan Corbet40641742019-02-20 15:29:36 -0700[diff] [blame]23 api-summary
24 splice
Mauro Carvalho Chehabec23eb52019-07-26 09:51:27 -0300[diff] [blame]25 locking
26 directory-locking
Mauro Carvalho Chehab01478b82020-04-27 23:17:02 +0200[diff] [blame]27 devpts
Mauro Carvalho Chehabb31763c2020-04-27 23:17:03 +0200[diff] [blame]28 dnotify
Mauro Carvalho Chehabe6f7df72020-04-27 23:17:04 +0200[diff] [blame]29 fiemap
Mauro Carvalho Chehabe6d42cb2020-04-27 23:17:05 +0200[diff] [blame]30 files
Mauro Carvalho Chehab635265252020-04-27 23:17:07 +0200[diff] [blame]31 locks
Mauro Carvalho Chehaba02dcdf2020-04-27 23:17:08 +0200[diff] [blame]32 mandatory-locking
Mauro Carvalho Chehab791a17e2020-04-27 23:17:09 +0200[diff] [blame]33 mount_api
Mauro Carvalho Chehab9b6f1512020-04-27 23:17:10 +0200[diff] [blame]34 quota
Mauro Carvalho Chehab53a41d32020-04-27 23:17:11 +0200[diff] [blame]35 seq_file
Mauro Carvalho Chehabcf066122020-04-27 23:17:12 +0200[diff] [blame]36 sharedsubtree
Mauro Carvalho Chehab28bcadf2020-04-27 23:17:17 +0200[diff] [blame]37 sysfs-pci
Mauro Carvalho Chehabec4551f2020-04-27 23:17:18 +0200[diff] [blame]38 sysfs-tagging
Christian Brauner35283f52019-01-11 14:40:59 +0100[diff] [blame]39
Mauro Carvalho Chehab41defb42020-04-27 23:17:00 +0200[diff] [blame]40 automount-support
41
Mauro Carvalho Chehab67145c22020-04-27 23:16:53 +0200[diff] [blame]42 caching/index
43
Mauro Carvalho Chehab25b532c2019-07-26 09:51:28 -0300[diff] [blame]44 porting
45
Jonathan Corbet40641742019-02-20 15:29:36 -0700[diff] [blame]46Filesystem support layers
47=========================
48
49Documentation for the support code within the filesystem layer for use in
50filesystem implementations.
Christian Brauner35283f52019-01-11 14:40:59 +0100[diff] [blame]51
52.. toctree::
Jonathan Corbet40641742019-02-20 15:29:36 -0700[diff] [blame]53 :maxdepth: 2
54
55 journalling
56 fscrypt
Eric Biggers6ff2deb2019-07-22 09:26:20 -0700[diff] [blame]57 fsverity
Stefan Hajnoczi2d1d25d2019-08-29 14:41:04 +0100[diff] [blame]58
59Filesystems
60===========
61
62Documentation for filesystem implementations.
63
64.. toctree::
65 :maxdepth: 2
66
Mauro Carvalho Chehab07d241f2020-02-17 17:11:47 +0100[diff] [blame]67 9p
Mauro Carvalho Chehab34873902020-02-17 17:11:48 +0100[diff] [blame]68 adfs
Mauro Carvalho Chehab762721682020-02-17 17:11:49 +0100[diff] [blame]69 affs
Mauro Carvalho Chehabca6e9042020-02-17 17:11:50 +0100[diff] [blame]70 afs
Jaskaran Singhf11f2a32019-11-17 22:54:34 +0530[diff] [blame]71 autofs
Mauro Carvalho Chehabc64d3dc2020-02-17 17:11:51 +0100[diff] [blame]72 autofs-mount-control
Mauro Carvalho Chehabc54ad9a2020-02-17 17:11:52 +0100[diff] [blame]73 befs
Mauro Carvalho Chehabee68f342020-02-17 17:11:53 +0100[diff] [blame]74 bfs
Mauro Carvalho Chehab5d43e1b2020-02-17 17:11:54 +0100[diff] [blame]75 btrfs
Mauro Carvalho Chehab175cc462020-04-27 23:16:59 +0200[diff] [blame]76 cifs/cifsroot
Mauro Carvalho Chehab471379a2020-02-17 17:11:55 +0100[diff] [blame]77 ceph
Mauro Carvalho Chehabf476c6e2020-04-27 23:17:01 +0200[diff] [blame]78 coda
Mauro Carvalho Chehabf1fa0e62020-02-17 17:11:56 +0100[diff] [blame]79 cramfs
Mauro Carvalho Chehab57443782020-02-17 17:11:57 +0100[diff] [blame]80 debugfs
Mauro Carvalho Chehab14a19fa2020-02-17 17:11:58 +0100[diff] [blame]81 dlmfs
Mauro Carvalho Chehabb02a17c2020-02-17 17:11:59 +0100[diff] [blame]82 ecryptfs
Mauro Carvalho Chehab06dedb42020-02-17 17:12:00 +0100[diff] [blame]83 efivarfs
Mauro Carvalho Chehabe66d8632020-02-17 17:12:01 +0100[diff] [blame]84 erofs
Mauro Carvalho Chehab6e29ad22020-02-17 17:12:02 +0100[diff] [blame]85 ext2
Mauro Carvalho Chehab7dc62402020-02-17 17:12:03 +0100[diff] [blame]86 ext3
Mauro Carvalho Chehab89272ca2020-02-17 17:12:04 +0100[diff] [blame]87 f2fs
Mauro Carvalho Chehab720c2fc2020-02-17 17:12:05 +0100[diff] [blame]88 gfs2
Mauro Carvalho Chehab5b7ac272020-02-17 17:12:06 +0100[diff] [blame]89 gfs2-uevents
Mauro Carvalho Chehab5040a0a2020-02-17 17:12:08 +0100[diff] [blame]90 hfs
Mauro Carvalho Chehabcdded7d2020-02-17 17:12:07 +0100[diff] [blame]91 hfsplus
Mauro Carvalho Chehaba1ef4bc2020-02-17 17:12:09 +0100[diff] [blame]92 hpfs
Mauro Carvalho Chehab2640c192020-02-17 17:12:12 +0100[diff] [blame]93 fuse
Mauro Carvalho Chehabba302d22020-04-27 23:17:06 +0200[diff] [blame]94 fuse-io
Mauro Carvalho Chehabde389cf2020-02-17 17:12:10 +0100[diff] [blame]95 inotify
Mauro Carvalho Chehab76f21682020-02-17 17:12:11 +0100[diff] [blame]96 isofs
Mauro Carvalho Chehab2640c192020-02-17 17:12:12 +0100[diff] [blame]97 nilfs2
Mauro Carvalho Chehab461f2c82020-02-17 17:12:13 +0100[diff] [blame]98 nfs/index
99 ntfs
Mauro Carvalho Chehabfa95e082020-02-17 17:12:15 +0100[diff] [blame]100 ocfs2
Mauro Carvalho Chehab3d0c60d2020-02-17 17:12:14 +0100[diff] [blame]101 ocfs2-online-filecheck
Mauro Carvalho Chehab7cbb4682020-02-17 17:12:16 +0100[diff] [blame]102 omfs
Mauro Carvalho Chehab18ccb222020-02-17 17:12:17 +0100[diff] [blame]103 orangefs
Mauro Carvalho Chehab77ce1a42020-01-28 07:41:01 +0100[diff] [blame]104 overlayfs
Mauro Carvalho Chehabc33e97e2020-02-17 17:12:18 +0100[diff] [blame]105 proc
Mauro Carvalho Chehabd5eefa22020-02-17 17:12:19 +0100[diff] [blame]106 qnx6
Mauro Carvalho Chehab8979fc92020-02-17 17:12:20 +0100[diff] [blame]107 ramfs-rootfs-initramfs
Mauro Carvalho Chehab56e6d5c2020-02-17 17:12:21 +0100[diff] [blame]108 relay
Mauro Carvalho Chehab6db0a482020-02-17 17:12:22 +0100[diff] [blame]109 romfs
Mauro Carvalho Chehabdc3f0432020-04-27 23:17:14 +0200[diff] [blame]110 spufs/index
Mauro Carvalho Chehab31771f42020-02-17 17:12:23 +0100[diff] [blame]111 squashfs
Mauro Carvalho Chehab86beb972020-02-17 17:12:24 +0100[diff] [blame]112 sysfs
Mauro Carvalho Chehab826a6132020-02-17 17:12:25 +0100[diff] [blame]113 sysv-fs
Mauro Carvalho Chehab7e7cd452020-02-17 17:12:26 +0100[diff] [blame]114 tmpfs
Mauro Carvalho Chehab38e56b42020-02-17 17:12:28 +0100[diff] [blame]115 ubifs
Mauro Carvalho Chehab688f1182020-02-17 17:12:27 +0100[diff] [blame]116 ubifs-authentication.rst
Mauro Carvalho Chehabc9817ad2020-02-17 17:12:29 +0100[diff] [blame]117 udf
Stefan Hajnoczi2d1d25d2019-08-29 14:41:04 +0100[diff] [blame]118 virtiofs
Daniel W. S. Almeidaa1986432019-12-22 22:00:30 -0300[diff] [blame]119 vfat
Mauro Carvalho Chehabc3d2f6c2020-04-27 23:17:19 +0200[diff] [blame]120 xfs-delayed-logging-design
Mauro Carvalho Chehabfc2f6fe2020-04-27 23:17:20 +0200[diff] [blame^]121 xfs-self-describing-metadata
Mauro Carvalho Chehab9a610812020-02-17 17:12:30 +0100[diff] [blame]122 zonefs