Skip to content

Commit

Permalink
docs: Bring some order to filesystem documentation
Browse files Browse the repository at this point in the history
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
Show file tree
Hide file tree
Showing 5 changed files with 395 additions and 370 deletions.
150 changes: 150 additions & 0 deletions Documentation/filesystems/api-summary.rst
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:
Loading

0 comments on commit 4064174

Please sign in to comment.