diff options
| author | Tobin C. Harding | 2019-05-15 02:29:13 +0200 |
|---|---|---|
| committer | Jonathan Corbet | 2019-05-30 00:15:20 +0200 |
| commit | af96c1e304f7051bf2ee64c9957724bdace05c58 (patch) | |
| tree | b1757e1f9ce70f5adb13f1c664b64f38519940ba /Documentation/filesystems/index.rst | |
| parent | docs: filesystems: vfs: Convert spaces to tabs (diff) | |
| download | kernel-qcow2-linux-af96c1e304f7051bf2ee64c9957724bdace05c58.tar.gz kernel-qcow2-linux-af96c1e304f7051bf2ee64c9957724bdace05c58.tar.xz kernel-qcow2-linux-af96c1e304f7051bf2ee64c9957724bdace05c58.zip | |
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>
Diffstat (limited to 'Documentation/filesystems/index.rst')
| -rw-r--r-- | Documentation/filesystems/index.rst | 1 |
1 files changed, 1 insertions, 0 deletions
diff --git a/Documentation/filesystems/index.rst b/Documentation/filesystems/index.rst index 1131c34d77f6..35644840a690 100644 --- a/Documentation/filesystems/index.rst +++ b/Documentation/filesystems/index.rst @@ -16,6 +16,7 @@ algorithms work. .. toctree:: :maxdepth: 2 + vfs path-lookup.rst api-summary splice |