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 4/5] Documentation: ext4: blockgroup: Add explicit title heading
Date: Fri, 20 Jun 2025 17:56:43 +0700 [thread overview]
Message-ID: <20250620105643.25141-6-bagasdotme@gmail.com> (raw)
In-Reply-To: <20250620105643.25141-2-bagasdotme@gmail.com>
Block groups documentation has three, first-level section headings.
These headings' text become toctree entries and the first one "Layout"
becomes docs title in the output, which isn't conveying the docs
contents.
Add explicit title heading and demote the rest.
Signed-off-by: Bagas Sanjaya <bagasdotme@gmail.com>
---
Documentation/filesystems/ext4/blockgroup.rst | 11 +++++++----
1 file changed, 7 insertions(+), 4 deletions(-)
diff --git a/Documentation/filesystems/ext4/blockgroup.rst b/Documentation/filesystems/ext4/blockgroup.rst
index ed5a5cac6d40e1..7cbf0b2b778eab 100644
--- a/Documentation/filesystems/ext4/blockgroup.rst
+++ b/Documentation/filesystems/ext4/blockgroup.rst
@@ -1,7 +1,10 @@
.. SPDX-License-Identifier: GPL-2.0
+Block Groups
+------------
+
Layout
-------
+~~~~~~
The layout of a standard block group is approximately as follows (each
of these fields is discussed in a separate section below):
@@ -60,7 +63,7 @@ groups (flex_bg). Leftover space is used for file data blocks, indirect
block maps, extent tree blocks, and extended attributes.
Flexible Block Groups
----------------------
+~~~~~~~~~~~~~~~~~~~~~
Starting in ext4, there is a new feature called flexible block groups
(flex_bg). In a flex_bg, several block groups are tied together as one
@@ -78,7 +81,7 @@ if flex_bg is enabled. The number of block groups that make up a
flex_bg is given by 2 ^ ``sb.s_log_groups_per_flex``.
Meta Block Groups
------------------
+~~~~~~~~~~~~~~~~~
Without the option META_BG, for safety concerns, all block group
descriptors copies are kept in the first block group. Given the default
@@ -117,7 +120,7 @@ Please see an important note about ``BLOCK_UNINIT`` in the section about
block and inode bitmaps.
Lazy Block Group Initialization
--------------------------------
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
A new feature for ext4 are three block group descriptor flags that
enable mkfs to skip initializing other parts of the block group
--
An old man doll... just what I always wanted! - Clara
next prev parent 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 ` [PATCH 1/5] Documentation: ext4: Convert includes into toctrees Bagas Sanjaya
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 ` Bagas Sanjaya [this message]
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-6-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 a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox