]> www.infradead.org Git - users/willy/linux.git/commitdiff
Documentation: ext4: Convert includes into toctrees
authorBagas Sanjaya <bagasdotme@gmail.com>
Fri, 20 Jun 2025 10:56:40 +0000 (17:56 +0700)
committerJonathan Corbet <corbet@lwn.net>
Wed, 2 Jul 2025 22:57:20 +0000 (16:57 -0600)
ext4 docs are organized in three master docs (overview.rst, globals.rst,
and dynamic.rst), in which these include other docs via include::
directive. These docs sturcture is better served by toctrees instead.

Convert the master docs to use toctrees.

Fixes: 0bf1f51e34c4 ("ext4: Add atomic block write documentation")
Signed-off-by: Bagas Sanjaya <bagasdotme@gmail.com>
Acked-by: Theodore Ts'o <tytso@mit.edu>
Acked-by: Darrick J. Wong <djwong@kernel.org>
Signed-off-by: Jonathan Corbet <corbet@lwn.net>
Link: https://lore.kernel.org/r/20250620105643.25141-3-bagasdotme@gmail.com
Documentation/filesystems/ext4/dynamic.rst
Documentation/filesystems/ext4/globals.rst
Documentation/filesystems/ext4/overview.rst

index bb0c84333341a5f70de3b83b5695e678ac16eac7..bbad439aada26217841949759b8c474c795bab7d 100644 (file)
@@ -6,7 +6,9 @@ Dynamic Structures
 Dynamic metadata are created on the fly when files and blocks are
 allocated to files.
 
-.. include:: inodes.rst
-.. include:: ifork.rst
-.. include:: directory.rst
-.. include:: attributes.rst
+.. toctree::
+
+   inodes
+   ifork
+   directory
+   attributes
index b17418974fd35e3e85f68c00fadfa83c96d2d145..2264b76e873cc95b727ae63ca61db015ad159a20 100644 (file)
@@ -6,9 +6,11 @@ Global Structures
 The filesystem is sharded into a number of block groups, each of which
 have static metadata at fixed locations.
 
-.. include:: super.rst
-.. include:: group_descr.rst
-.. include:: bitmaps.rst
-.. include:: mmp.rst
-.. include:: journal.rst
-.. include:: orphan.rst
+.. toctree::
+
+   super
+   group_descr
+   bitmaps
+   mmp
+   journal
+   orphan
index 9d4054c17ecb7b2140c5b8ac3410722ec15a1f08..171c3963d7f687432c070cb3081d55894eeaf5dc 100644 (file)
@@ -16,13 +16,15 @@ All fields in ext4 are written to disk in little-endian order. HOWEVER,
 all fields in jbd2 (the journal) are written to disk in big-endian
 order.
 
-.. include:: blocks.rst
-.. include:: blockgroup.rst
-.. include:: special_inodes.rst
-.. include:: allocators.rst
-.. include:: checksums.rst
-.. include:: bigalloc.rst
-.. include:: inlinedata.rst
-.. include:: eainode.rst
-.. include:: verity.rst
-.. include:: atomic_writes.rst
+.. toctree::
+
+   blocks
+   blockgroup
+   special_inodes
+   allocators
+   checksums
+   bigalloc
+   inlinedata
+   eainode
+   verity
+   atomic_writes