AuxXxilium/linux_dsm_epyc7002
1
0
Fork 0
mirror of https://github.com/AuxXxilium/linux_dsm_epyc7002.git synced 2024-11-25 13:51:00 +07:00
Code Issues Actions Packages Projects Releases Wiki Activity

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

Browse Source 
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>
This commit is contained in:
Tobin C. Harding 2019-05-15 10:29:13 +10:00 committed by Jonathan Corbet
parent 1b44ae63de
commit af96c1e304
2 changed files with 292 additions and 274 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

1
Documentation/filesystems/index.rst
View File

@ -16,6 +16,7 @@ algorithms work.
.. toctree:: .. toctree::
:maxdepth: 2 :maxdepth: 2
vfs
path-lookup.rst path-lookup.rst
api-summary api-summary
splice splice

565
Documentation/filesystems/vfs.txt → Documentation/filesystems/vfs.rst
View File

File diff suppressed because it is too large Load Diff