xref: /linux/Documentation/filesystems/api-summary.rst (revision 4064174becc09a5a2385a27c8a6fd40888b0e13c)
1*4064174bSJonathan Corbet=============================
2*4064174bSJonathan CorbetLinux Filesystems API summary
3*4064174bSJonathan Corbet=============================
4*4064174bSJonathan Corbet
5*4064174bSJonathan CorbetThis section contains API-level documentation, mostly taken from the source
6*4064174bSJonathan Corbetcode itself.
7*4064174bSJonathan Corbet
8*4064174bSJonathan CorbetThe Linux VFS
9*4064174bSJonathan Corbet=============
10*4064174bSJonathan Corbet
11*4064174bSJonathan CorbetThe Filesystem types
12*4064174bSJonathan Corbet--------------------
13*4064174bSJonathan Corbet
14*4064174bSJonathan Corbet.. kernel-doc:: include/linux/fs.h
15*4064174bSJonathan Corbet   :internal:
16*4064174bSJonathan Corbet
17*4064174bSJonathan CorbetThe Directory Cache
18*4064174bSJonathan Corbet-------------------
19*4064174bSJonathan Corbet
20*4064174bSJonathan Corbet.. kernel-doc:: fs/dcache.c
21*4064174bSJonathan Corbet   :export:
22*4064174bSJonathan Corbet
23*4064174bSJonathan Corbet.. kernel-doc:: include/linux/dcache.h
24*4064174bSJonathan Corbet   :internal:
25*4064174bSJonathan Corbet
26*4064174bSJonathan CorbetInode Handling
27*4064174bSJonathan Corbet--------------
28*4064174bSJonathan Corbet
29*4064174bSJonathan Corbet.. kernel-doc:: fs/inode.c
30*4064174bSJonathan Corbet   :export:
31*4064174bSJonathan Corbet
32*4064174bSJonathan Corbet.. kernel-doc:: fs/bad_inode.c
33*4064174bSJonathan Corbet   :export:
34*4064174bSJonathan Corbet
35*4064174bSJonathan CorbetRegistration and Superblocks
36*4064174bSJonathan Corbet----------------------------
37*4064174bSJonathan Corbet
38*4064174bSJonathan Corbet.. kernel-doc:: fs/super.c
39*4064174bSJonathan Corbet   :export:
40*4064174bSJonathan Corbet
41*4064174bSJonathan CorbetFile Locks
42*4064174bSJonathan Corbet----------
43*4064174bSJonathan Corbet
44*4064174bSJonathan Corbet.. kernel-doc:: fs/locks.c
45*4064174bSJonathan Corbet   :export:
46*4064174bSJonathan Corbet
47*4064174bSJonathan Corbet.. kernel-doc:: fs/locks.c
48*4064174bSJonathan Corbet   :internal:
49*4064174bSJonathan Corbet
50*4064174bSJonathan CorbetOther Functions
51*4064174bSJonathan Corbet---------------
52*4064174bSJonathan Corbet
53*4064174bSJonathan Corbet.. kernel-doc:: fs/mpage.c
54*4064174bSJonathan Corbet   :export:
55*4064174bSJonathan Corbet
56*4064174bSJonathan Corbet.. kernel-doc:: fs/namei.c
57*4064174bSJonathan Corbet   :export:
58*4064174bSJonathan Corbet
59*4064174bSJonathan Corbet.. kernel-doc:: fs/buffer.c
60*4064174bSJonathan Corbet   :export:
61*4064174bSJonathan Corbet
62*4064174bSJonathan Corbet.. kernel-doc:: block/bio.c
63*4064174bSJonathan Corbet   :export:
64*4064174bSJonathan Corbet
65*4064174bSJonathan Corbet.. kernel-doc:: fs/seq_file.c
66*4064174bSJonathan Corbet   :export:
67*4064174bSJonathan Corbet
68*4064174bSJonathan Corbet.. kernel-doc:: fs/filesystems.c
69*4064174bSJonathan Corbet   :export:
70*4064174bSJonathan Corbet
71*4064174bSJonathan Corbet.. kernel-doc:: fs/fs-writeback.c
72*4064174bSJonathan Corbet   :export:
73*4064174bSJonathan Corbet
74*4064174bSJonathan Corbet.. kernel-doc:: fs/block_dev.c
75*4064174bSJonathan Corbet   :export:
76*4064174bSJonathan Corbet
77*4064174bSJonathan Corbet.. kernel-doc:: fs/anon_inodes.c
78*4064174bSJonathan Corbet   :export:
79*4064174bSJonathan Corbet
80*4064174bSJonathan Corbet.. kernel-doc:: fs/attr.c
81*4064174bSJonathan Corbet   :export:
82*4064174bSJonathan Corbet
83*4064174bSJonathan Corbet.. kernel-doc:: fs/d_path.c
84*4064174bSJonathan Corbet   :export:
85*4064174bSJonathan Corbet
86*4064174bSJonathan Corbet.. kernel-doc:: fs/dax.c
87*4064174bSJonathan Corbet   :export:
88*4064174bSJonathan Corbet
89*4064174bSJonathan Corbet.. kernel-doc:: fs/direct-io.c
90*4064174bSJonathan Corbet   :export:
91*4064174bSJonathan Corbet
92*4064174bSJonathan Corbet.. kernel-doc:: fs/file_table.c
93*4064174bSJonathan Corbet   :export:
94*4064174bSJonathan Corbet
95*4064174bSJonathan Corbet.. kernel-doc:: fs/libfs.c
96*4064174bSJonathan Corbet   :export:
97*4064174bSJonathan Corbet
98*4064174bSJonathan Corbet.. kernel-doc:: fs/posix_acl.c
99*4064174bSJonathan Corbet   :export:
100*4064174bSJonathan Corbet
101*4064174bSJonathan Corbet.. kernel-doc:: fs/stat.c
102*4064174bSJonathan Corbet   :export:
103*4064174bSJonathan Corbet
104*4064174bSJonathan Corbet.. kernel-doc:: fs/sync.c
105*4064174bSJonathan Corbet   :export:
106*4064174bSJonathan Corbet
107*4064174bSJonathan Corbet.. kernel-doc:: fs/xattr.c
108*4064174bSJonathan Corbet   :export:
109*4064174bSJonathan Corbet
110*4064174bSJonathan CorbetThe proc filesystem
111*4064174bSJonathan Corbet===================
112*4064174bSJonathan Corbet
113*4064174bSJonathan Corbetsysctl interface
114*4064174bSJonathan Corbet----------------
115*4064174bSJonathan Corbet
116*4064174bSJonathan Corbet.. kernel-doc:: kernel/sysctl.c
117*4064174bSJonathan Corbet   :export:
118*4064174bSJonathan Corbet
119*4064174bSJonathan Corbetproc filesystem interface
120*4064174bSJonathan Corbet-------------------------
121*4064174bSJonathan Corbet
122*4064174bSJonathan Corbet.. kernel-doc:: fs/proc/base.c
123*4064174bSJonathan Corbet   :internal:
124*4064174bSJonathan Corbet
125*4064174bSJonathan CorbetEvents based on file descriptors
126*4064174bSJonathan Corbet================================
127*4064174bSJonathan Corbet
128*4064174bSJonathan Corbet.. kernel-doc:: fs/eventfd.c
129*4064174bSJonathan Corbet   :export:
130*4064174bSJonathan Corbet
131*4064174bSJonathan CorbetThe Filesystem for Exporting Kernel Objects
132*4064174bSJonathan Corbet===========================================
133*4064174bSJonathan Corbet
134*4064174bSJonathan Corbet.. kernel-doc:: fs/sysfs/file.c
135*4064174bSJonathan Corbet   :export:
136*4064174bSJonathan Corbet
137*4064174bSJonathan Corbet.. kernel-doc:: fs/sysfs/symlink.c
138*4064174bSJonathan Corbet   :export:
139*4064174bSJonathan Corbet
140*4064174bSJonathan CorbetThe debugfs filesystem
141*4064174bSJonathan Corbet======================
142*4064174bSJonathan Corbet
143*4064174bSJonathan Corbetdebugfs interface
144*4064174bSJonathan Corbet-----------------
145*4064174bSJonathan Corbet
146*4064174bSJonathan Corbet.. kernel-doc:: fs/debugfs/inode.c
147*4064174bSJonathan Corbet   :export:
148*4064174bSJonathan Corbet
149*4064174bSJonathan Corbet.. kernel-doc:: fs/debugfs/file.c
150*4064174bSJonathan Corbet   :export:
151