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