forked from torvalds/linux
-
Notifications
You must be signed in to change notification settings - Fork 1
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
docs: Bring some order to filesystem documentation
Documentation/filesystems is, like much of the rest of the kernel's documentation, a jumble of unorganized information. Split the documentation into categories and try to bring some order to the top-level index.rst files. No text changes other than a few section-introductory blurbs; this is all just moving stuff around. Cc: [email protected] Cc: Al Viro <[email protected]> Signed-off-by: Jonathan Corbet <[email protected]>
- Loading branch information
Jonathan Corbet
committed
Mar 6, 2019
1 parent
866d65b
commit 4064174
Showing
5 changed files
with
395 additions
and
370 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,150 @@ | ||
============================= | ||
Linux Filesystems API summary | ||
============================= | ||
|
||
This section contains API-level documentation, mostly taken from the source | ||
code itself. | ||
|
||
The Linux VFS | ||
============= | ||
|
||
The Filesystem types | ||
-------------------- | ||
|
||
.. kernel-doc:: include/linux/fs.h | ||
:internal: | ||
|
||
The Directory Cache | ||
------------------- | ||
|
||
.. kernel-doc:: fs/dcache.c | ||
:export: | ||
|
||
.. kernel-doc:: include/linux/dcache.h | ||
:internal: | ||
|
||
Inode Handling | ||
-------------- | ||
|
||
.. kernel-doc:: fs/inode.c | ||
:export: | ||
|
||
.. kernel-doc:: fs/bad_inode.c | ||
:export: | ||
|
||
Registration and Superblocks | ||
---------------------------- | ||
|
||
.. kernel-doc:: fs/super.c | ||
:export: | ||
|
||
File Locks | ||
---------- | ||
|
||
.. kernel-doc:: fs/locks.c | ||
:export: | ||
|
||
.. kernel-doc:: fs/locks.c | ||
:internal: | ||
|
||
Other Functions | ||
--------------- | ||
|
||
.. kernel-doc:: fs/mpage.c | ||
:export: | ||
|
||
.. kernel-doc:: fs/namei.c | ||
:export: | ||
|
||
.. kernel-doc:: fs/buffer.c | ||
:export: | ||
|
||
.. kernel-doc:: block/bio.c | ||
:export: | ||
|
||
.. kernel-doc:: fs/seq_file.c | ||
:export: | ||
|
||
.. kernel-doc:: fs/filesystems.c | ||
:export: | ||
|
||
.. kernel-doc:: fs/fs-writeback.c | ||
:export: | ||
|
||
.. kernel-doc:: fs/block_dev.c | ||
:export: | ||
|
||
.. kernel-doc:: fs/anon_inodes.c | ||
:export: | ||
|
||
.. kernel-doc:: fs/attr.c | ||
:export: | ||
|
||
.. kernel-doc:: fs/d_path.c | ||
:export: | ||
|
||
.. kernel-doc:: fs/dax.c | ||
:export: | ||
|
||
.. kernel-doc:: fs/direct-io.c | ||
:export: | ||
|
||
.. kernel-doc:: fs/file_table.c | ||
:export: | ||
|
||
.. kernel-doc:: fs/libfs.c | ||
:export: | ||
|
||
.. kernel-doc:: fs/posix_acl.c | ||
:export: | ||
|
||
.. kernel-doc:: fs/stat.c | ||
:export: | ||
|
||
.. kernel-doc:: fs/sync.c | ||
:export: | ||
|
||
.. kernel-doc:: fs/xattr.c | ||
:export: | ||
|
||
The proc filesystem | ||
=================== | ||
|
||
sysctl interface | ||
---------------- | ||
|
||
.. kernel-doc:: kernel/sysctl.c | ||
:export: | ||
|
||
proc filesystem interface | ||
------------------------- | ||
|
||
.. kernel-doc:: fs/proc/base.c | ||
:internal: | ||
|
||
Events based on file descriptors | ||
================================ | ||
|
||
.. kernel-doc:: fs/eventfd.c | ||
:export: | ||
|
||
The Filesystem for Exporting Kernel Objects | ||
=========================================== | ||
|
||
.. kernel-doc:: fs/sysfs/file.c | ||
:export: | ||
|
||
.. kernel-doc:: fs/sysfs/symlink.c | ||
:export: | ||
|
||
The debugfs filesystem | ||
====================== | ||
|
||
debugfs interface | ||
----------------- | ||
|
||
.. kernel-doc:: fs/debugfs/inode.c | ||
:export: | ||
|
||
.. kernel-doc:: fs/debugfs/file.c | ||
:export: |
Oops, something went wrong.