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