add patch improve-code-readability-in-ext4_iget
[ext4-patch-queue.git] / docs-create-filesystem-internal-section
blob2bddd5a5857b8ecd9221d6c9028cd48c38e3645a
1 docs: create filesystem internal section
3 From: Darrick J. Wong <darrick.wong@oracle.com>
5 Create a new top-level section for documentation of filesystem usage,
6 on-disk format information, and anything else.
8 Signed-off-by: Darrick J. Wong <darrick.wong@oracle.com>
9 Signed-off-by: Theodore Ts'o <tytso@mit.edu>
10 ---
11  Documentation/filesystems/ext4/index.rst |    6 +++---
12  Documentation/filesystems/index.rst      |    8 --------
13  Documentation/index.rst                  |   11 +++++++++++
14  3 files changed, 14 insertions(+), 11 deletions(-)
17 diff --git a/Documentation/filesystems/ext4/index.rst b/Documentation/filesystems/ext4/index.rst
18 index 8fe4f7693e8c..71121605558c 100644
19 --- a/Documentation/filesystems/ext4/index.rst
20 +++ b/Documentation/filesystems/ext4/index.rst
21 @@ -1,8 +1,8 @@
22  .. SPDX-License-Identifier: GPL-2.0
24 -====
25 -ext4
26 -====
27 +===============
28 +ext4 Filesystem
29 +===============
31  General usage and on-disk artifacts writen by ext4.  More documentation may
32  be ported from the wiki as time permits.  This should be considered the
33 diff --git a/Documentation/filesystems/index.rst b/Documentation/filesystems/index.rst
34 index 7c57b3927308..53b89d0edc15 100644
35 --- a/Documentation/filesystems/index.rst
36 +++ b/Documentation/filesystems/index.rst
37 @@ -2,14 +2,6 @@
38  Linux Filesystems API
39  =====================
41 -The documentation in this section are provided by specific filesystem
42 -subprojects.
44 -.. toctree::
45 -   :maxdepth: 2
47 -   ext4/index
49  The Linux VFS
50  =============
52 diff --git a/Documentation/index.rst b/Documentation/index.rst
53 index fdc585703498..65c22b1ff5f2 100644
54 --- a/Documentation/index.rst
55 +++ b/Documentation/index.rst
56 @@ -102,6 +102,17 @@ implementation.
58     sh/index
60 +Filesystem Documentation
61 +------------------------
63 +The documentation in this section are provided by specific filesystem
64 +subprojects.
66 +.. toctree::
67 +   :maxdepth: 4
69 +   filesystems/ext4/index
71  Korean translations
72  -------------------