forked from Minki/linux
af96c1e304
vfs.txt is currently stale. If we convert it to RST this is a good first step in the process of getting the VFS documentation up to date. This patch does the following (all as a single patch so as not to introduce any new SPHINX build warnings) - Use '.. code-block:: c' for C code blocks and indent the code blocks. - Use double backticks for struct member descriptions. - Fix a couple of build warnings by guarding pointers (*) with double backticks .e.g ``*ptr``. - Add vfs to Documentation/filesystems/index.rst The member descriptions paragraph indentation was not touched. It is not pretty but these do not cause build warnings. These descriptions all need updating anyways so leave it as it is for now. Signed-off-by: Tobin C. Harding <tobin@kernel.org> Signed-off-by: Jonathan Corbet <corbet@lwn.net>
45 lines
947 B
ReStructuredText
45 lines
947 B
ReStructuredText
===============================
|
|
Filesystems in the Linux kernel
|
|
===============================
|
|
|
|
This under-development manual will, some glorious day, provide
|
|
comprehensive information on how the Linux virtual filesystem (VFS) layer
|
|
works, along with the filesystems that sit below it. For now, what we have
|
|
can be found below.
|
|
|
|
Core VFS documentation
|
|
======================
|
|
|
|
See these manuals for documentation about the VFS layer itself and how its
|
|
algorithms work.
|
|
|
|
.. toctree::
|
|
:maxdepth: 2
|
|
|
|
vfs
|
|
path-lookup.rst
|
|
api-summary
|
|
splice
|
|
|
|
Filesystem support layers
|
|
=========================
|
|
|
|
Documentation for the support code within the filesystem layer for use in
|
|
filesystem implementations.
|
|
|
|
.. toctree::
|
|
:maxdepth: 2
|
|
|
|
journalling
|
|
fscrypt
|
|
|
|
Filesystem-specific documentation
|
|
=================================
|
|
|
|
Documentation for individual filesystem types can be found here.
|
|
|
|
.. toctree::
|
|
:maxdepth: 2
|
|
|
|
binderfs.rst
|