docs: filesystems: vfs: Convert vfs.txt to RST

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 <[email protected]>
Signed-off-by: Jonathan Corbet <[email protected]>
This commit is contained in:
Tobin C. Harding authored and Jonathan Corbet committed 2019-05-29 16:15:20 -06:00
1 parent 1b44ae63de
commit af96c1e304
2 files changed
+292 -274

No files matched your search

+1
View File
@@ -16,6 +16,7 @@ algorithms work.
.. toctree::
:maxdepth: 2
vfs
path-lookup.rst
api-summary
splice
File diff suppressed because it is too large. Load diff