xref: /linux/Documentation/filesystems/api-summary.rst (revision 61307b7be41a1f1039d1d1368810a1d92cb97b44)
14064174bSJonathan Corbet=============================
24064174bSJonathan CorbetLinux Filesystems API summary
34064174bSJonathan Corbet=============================
44064174bSJonathan Corbet
54064174bSJonathan CorbetThis section contains API-level documentation, mostly taken from the source
64064174bSJonathan Corbetcode itself.
74064174bSJonathan Corbet
84064174bSJonathan CorbetThe Linux VFS
94064174bSJonathan Corbet=============
104064174bSJonathan Corbet
114064174bSJonathan CorbetThe Filesystem types
124064174bSJonathan Corbet--------------------
134064174bSJonathan Corbet
144064174bSJonathan Corbet.. kernel-doc:: include/linux/fs.h
154064174bSJonathan Corbet   :internal:
164064174bSJonathan Corbet
174064174bSJonathan CorbetThe Directory Cache
184064174bSJonathan Corbet-------------------
194064174bSJonathan Corbet
204064174bSJonathan Corbet.. kernel-doc:: fs/dcache.c
214064174bSJonathan Corbet   :export:
224064174bSJonathan Corbet
234064174bSJonathan Corbet.. kernel-doc:: include/linux/dcache.h
244064174bSJonathan Corbet   :internal:
254064174bSJonathan Corbet
264064174bSJonathan CorbetInode Handling
274064174bSJonathan Corbet--------------
284064174bSJonathan Corbet
294064174bSJonathan Corbet.. kernel-doc:: fs/inode.c
304064174bSJonathan Corbet   :export:
314064174bSJonathan Corbet
324064174bSJonathan Corbet.. kernel-doc:: fs/bad_inode.c
334064174bSJonathan Corbet   :export:
344064174bSJonathan Corbet
354064174bSJonathan CorbetRegistration and Superblocks
364064174bSJonathan Corbet----------------------------
374064174bSJonathan Corbet
384064174bSJonathan Corbet.. kernel-doc:: fs/super.c
394064174bSJonathan Corbet   :export:
404064174bSJonathan Corbet
414064174bSJonathan CorbetFile Locks
424064174bSJonathan Corbet----------
434064174bSJonathan Corbet
444064174bSJonathan Corbet.. kernel-doc:: fs/locks.c
454064174bSJonathan Corbet   :export:
464064174bSJonathan Corbet
474064174bSJonathan Corbet.. kernel-doc:: fs/locks.c
484064174bSJonathan Corbet   :internal:
494064174bSJonathan Corbet
504064174bSJonathan CorbetOther Functions
514064174bSJonathan Corbet---------------
524064174bSJonathan Corbet
534064174bSJonathan Corbet.. kernel-doc:: fs/mpage.c
544064174bSJonathan Corbet   :export:
554064174bSJonathan Corbet
564064174bSJonathan Corbet.. kernel-doc:: fs/namei.c
574064174bSJonathan Corbet   :export:
584064174bSJonathan Corbet
594064174bSJonathan Corbet.. kernel-doc:: block/bio.c
604064174bSJonathan Corbet   :export:
614064174bSJonathan Corbet
624064174bSJonathan Corbet.. kernel-doc:: fs/seq_file.c
634064174bSJonathan Corbet   :export:
644064174bSJonathan Corbet
654064174bSJonathan Corbet.. kernel-doc:: fs/filesystems.c
664064174bSJonathan Corbet   :export:
674064174bSJonathan Corbet
684064174bSJonathan Corbet.. kernel-doc:: fs/fs-writeback.c
694064174bSJonathan Corbet   :export:
704064174bSJonathan Corbet
714064174bSJonathan Corbet.. kernel-doc:: fs/anon_inodes.c
724064174bSJonathan Corbet   :export:
734064174bSJonathan Corbet
744064174bSJonathan Corbet.. kernel-doc:: fs/attr.c
754064174bSJonathan Corbet   :export:
764064174bSJonathan Corbet
774064174bSJonathan Corbet.. kernel-doc:: fs/d_path.c
784064174bSJonathan Corbet   :export:
794064174bSJonathan Corbet
804064174bSJonathan Corbet.. kernel-doc:: fs/dax.c
814064174bSJonathan Corbet   :export:
824064174bSJonathan Corbet
834064174bSJonathan Corbet.. kernel-doc:: fs/libfs.c
844064174bSJonathan Corbet   :export:
854064174bSJonathan Corbet
864064174bSJonathan Corbet.. kernel-doc:: fs/posix_acl.c
874064174bSJonathan Corbet   :export:
884064174bSJonathan Corbet
894064174bSJonathan Corbet.. kernel-doc:: fs/stat.c
904064174bSJonathan Corbet   :export:
914064174bSJonathan Corbet
924064174bSJonathan Corbet.. kernel-doc:: fs/sync.c
934064174bSJonathan Corbet   :export:
944064174bSJonathan Corbet
954064174bSJonathan Corbet.. kernel-doc:: fs/xattr.c
964064174bSJonathan Corbet   :export:
974064174bSJonathan Corbet
98*8be594b2SRandy Dunlap.. kernel-doc:: fs/namespace.c
99*8be594b2SRandy Dunlap   :export:
100*8be594b2SRandy Dunlap
1014064174bSJonathan CorbetThe proc filesystem
1024064174bSJonathan Corbet===================
1034064174bSJonathan Corbet
1044064174bSJonathan Corbetsysctl interface
1054064174bSJonathan Corbet----------------
1064064174bSJonathan Corbet
1074064174bSJonathan Corbet.. kernel-doc:: kernel/sysctl.c
1084064174bSJonathan Corbet   :export:
1094064174bSJonathan Corbet
1104064174bSJonathan Corbetproc filesystem interface
1114064174bSJonathan Corbet-------------------------
1124064174bSJonathan Corbet
1134064174bSJonathan Corbet.. kernel-doc:: fs/proc/base.c
1144064174bSJonathan Corbet   :internal:
1154064174bSJonathan Corbet
1164064174bSJonathan CorbetEvents based on file descriptors
1174064174bSJonathan Corbet================================
1184064174bSJonathan Corbet
1194064174bSJonathan Corbet.. kernel-doc:: fs/eventfd.c
1204064174bSJonathan Corbet   :export:
1214064174bSJonathan Corbet
1224722e2a2SRandy Dunlapeventpoll (epoll) interfaces
1234722e2a2SRandy Dunlap============================
1244722e2a2SRandy Dunlap
1254722e2a2SRandy Dunlap.. kernel-doc:: fs/eventpoll.c
1264722e2a2SRandy Dunlap   :internal:
1274722e2a2SRandy Dunlap
1284064174bSJonathan CorbetThe Filesystem for Exporting Kernel Objects
1294064174bSJonathan Corbet===========================================
1304064174bSJonathan Corbet
1314064174bSJonathan Corbet.. kernel-doc:: fs/sysfs/file.c
1324064174bSJonathan Corbet   :export:
1334064174bSJonathan Corbet
1344064174bSJonathan Corbet.. kernel-doc:: fs/sysfs/symlink.c
1354064174bSJonathan Corbet   :export:
1364064174bSJonathan Corbet
1374064174bSJonathan CorbetThe debugfs filesystem
1384064174bSJonathan Corbet======================
1394064174bSJonathan Corbet
1404064174bSJonathan Corbetdebugfs interface
1414064174bSJonathan Corbet-----------------
1424064174bSJonathan Corbet
1434064174bSJonathan Corbet.. kernel-doc:: fs/debugfs/inode.c
1444064174bSJonathan Corbet   :export:
1454064174bSJonathan Corbet
1464064174bSJonathan Corbet.. kernel-doc:: fs/debugfs/file.c
1474064174bSJonathan Corbet   :export:
148