All of lore.kernel.org
 help / color / mirror / Atom feed
From: Bagas Sanjaya <bagasdotme@gmail.com>
To: Linux Kernel Mailing List <linux-kernel@vger.kernel.org>,
	Linux Documentation <linux-doc@vger.kernel.org>,
	Linux ext4 <linux-ext4@vger.kernel.org>
Cc: "Theodore Ts'o" <tytso@mit.edu>,
	Andreas Dilger <adilger.kernel@dilger.ca>,
	Jonathan Corbet <corbet@lwn.net>,
	"Ritesh Harjani (IBM)" <ritesh.list@gmail.com>,
	"Darrick J. Wong" <djwong@kernel.org>,
	Bagas Sanjaya <bagasdotme@gmail.com>
Subject: [PATCH 1/5] Documentation: ext4: Convert includes into toctrees
Date: Fri, 20 Jun 2025 17:56:40 +0700	[thread overview]
Message-ID: <20250620105643.25141-3-bagasdotme@gmail.com> (raw)
In-Reply-To: <20250620105643.25141-2-bagasdotme@gmail.com>

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>
---
This actually fixes duplicate label to itself warning as tried to be
fixed in another approach [1], hence the Fixes: tag.

[1]: https://lore.kernel.org/linux-doc/20250610091200.54075-2-bagasdotme@gmail.com/

 Documentation/filesystems/ext4/dynamic.rst  | 10 ++++++----
 Documentation/filesystems/ext4/globals.rst  | 14 +++++++------
 Documentation/filesystems/ext4/overview.rst | 22 +++++++++++----------
 3 files changed, 26 insertions(+), 20 deletions(-)

diff --git a/Documentation/filesystems/ext4/dynamic.rst b/Documentation/filesystems/ext4/dynamic.rst
index bb0c84333341a5..bbad439aada262 100644
--- a/Documentation/filesystems/ext4/dynamic.rst
+++ b/Documentation/filesystems/ext4/dynamic.rst
@@ -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
diff --git a/Documentation/filesystems/ext4/globals.rst b/Documentation/filesystems/ext4/globals.rst
index b17418974fd35e..2264b76e873cc9 100644
--- a/Documentation/filesystems/ext4/globals.rst
+++ b/Documentation/filesystems/ext4/globals.rst
@@ -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
diff --git a/Documentation/filesystems/ext4/overview.rst b/Documentation/filesystems/ext4/overview.rst
index 9d4054c17ecb7b..171c3963d7f687 100644
--- a/Documentation/filesystems/ext4/overview.rst
+++ b/Documentation/filesystems/ext4/overview.rst
@@ -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
-- 
An old man doll... just what I always wanted! - Clara


  reply	other threads:[~2025-06-20 10:57 UTC|newest]

Thread overview: 13+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2025-06-20 10:56 [PATCH 0/5] ext4 docs toctree reorganization Bagas Sanjaya
2025-06-20 10:56 ` Bagas Sanjaya [this message]
2025-06-20 10:56 ` [PATCH 2/5] Documentation: ext4: Reduce toctree depth Bagas Sanjaya
2025-06-20 10:56 ` [PATCH 3/5] Documentation: ext4: atomic_writes: Demote last three sections Bagas Sanjaya
2025-06-20 10:56 ` [PATCH 4/5] Documentation: ext4: blockgroup: Add explicit title heading Bagas Sanjaya
2025-06-20 10:56 ` [PATCH 5/5] Documentation: ext4: Move inode table short docs into its own file Bagas Sanjaya
2025-06-30  0:53 ` [PATCH 0/5] ext4 docs toctree reorganization Bagas Sanjaya
2025-06-30 15:22   ` Darrick J. Wong
2025-07-01 19:11 ` Jonathan Corbet
2025-07-01 19:45   ` Darrick J. Wong
2025-07-01 19:52     ` Jonathan Corbet
2025-07-01 21:24   ` Theodore Ts'o
2025-07-02 22:59 ` Jonathan Corbet

Reply instructions:

You may reply publicly to this message via plain-text email
using any one of the following methods:

* Save the following mbox file, import it into your mail client,
  and reply-to-all from there: mbox

  Avoid top-posting and favor interleaved quoting:
  https://en.wikipedia.org/wiki/Posting_style#Interleaved_style

* Reply using the --to, --cc, and --in-reply-to
  switches of git-send-email(1):

  git send-email \
    --in-reply-to=20250620105643.25141-3-bagasdotme@gmail.com \
    --to=bagasdotme@gmail.com \
    --cc=adilger.kernel@dilger.ca \
    --cc=corbet@lwn.net \
    --cc=djwong@kernel.org \
    --cc=linux-doc@vger.kernel.org \
    --cc=linux-ext4@vger.kernel.org \
    --cc=linux-kernel@vger.kernel.org \
    --cc=ritesh.list@gmail.com \
    --cc=tytso@mit.edu \
    /path/to/YOUR_REPLY

  https://kernel.org/pub/software/scm/git/docs/git-send-email.html

* If your mail client supports setting the In-Reply-To header
  via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line before the message body.
This is an external index of several public inboxes,
see mirroring instructions on how to clone and mirror
all data and code used by this external index.