]> git.baikalelectronics.ru Git - kernel.git/commit
docs: filesystems: vfs: Convert vfs.txt to RST
authorTobin C. Harding <tobin@kernel.org>
Wed, 15 May 2019 00:29:13 +0000 (10:29 +1000)
committerJonathan Corbet <corbet@lwn.net>
Wed, 29 May 2019 22:15:20 +0000 (16:15 -0600)
commitb9c4e85abf548e513a254ae38a86e4013bf308ff
treeb1757e1f9ce70f5adb13f1c664b64f38519940ba
parent5be72e0afe5bb86467bb3c4d8037d54bb7e6c7bf
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 <tobin@kernel.org>
Signed-off-by: Jonathan Corbet <corbet@lwn.net>
Documentation/filesystems/index.rst
Documentation/filesystems/vfs.rst [new file with mode: 0644]
Documentation/filesystems/vfs.txt [deleted file]