[PATCH 0/5] ext4 docs toctree reorganization

Bagas Sanjaya posted 5 patches 3 months, 2 weeks ago
.../filesystems/ext4/atomic_writes.rst        | 10 ++++-----
Documentation/filesystems/ext4/bitmaps.rst    |  7 ------
Documentation/filesystems/ext4/blockgroup.rst | 11 ++++++----
Documentation/filesystems/ext4/dynamic.rst    | 10 +++++----
Documentation/filesystems/ext4/globals.rst    | 15 ++++++++-----
Documentation/filesystems/ext4/index.rst      |  2 +-
.../filesystems/ext4/inode_table.rst          |  9 ++++++++
Documentation/filesystems/ext4/overview.rst   | 22 ++++++++++---------
8 files changed, 49 insertions(+), 37 deletions(-)
create mode 100644 Documentation/filesystems/ext4/inode_table.rst
[PATCH 0/5] ext4 docs toctree reorganization
Posted by Bagas Sanjaya 3 months, 2 weeks ago
Hi Jon, hi Ted,

While discussing on my previous ext4 docs reorganization attempt
by merging contents [1], Jon suggested that considering current docs
file structure, a proper toctree would be ideal [2]. So, here's
the patchset that does exactly that.

Actual conversion to toctree structure is in [1/5], while the rest
is cleanups to make the resulting toctree nicer.

This patchset is based on docs-next tree.

Enjoy!

[1]: https://lore.kernel.org/linux-doc/20250618111544.22602-1-bagasdotme@gmail.com/
[2]: https://lore.kernel.org/linux-doc/87bjqjh5dr.fsf@trenco.lwn.net/

Bagas Sanjaya (5):
  Documentation: ext4: Convert includes into toctrees
  Documentation: ext4: Reduce toctree depth
  Documentation: ext4: atomic_writes: Demote last three sections
  Documentation: ext4: blockgroup: Add explicit title heading
  Documentation: ext4: Move inode table short docs into its own file

 .../filesystems/ext4/atomic_writes.rst        | 10 ++++-----
 Documentation/filesystems/ext4/bitmaps.rst    |  7 ------
 Documentation/filesystems/ext4/blockgroup.rst | 11 ++++++----
 Documentation/filesystems/ext4/dynamic.rst    | 10 +++++----
 Documentation/filesystems/ext4/globals.rst    | 15 ++++++++-----
 Documentation/filesystems/ext4/index.rst      |  2 +-
 .../filesystems/ext4/inode_table.rst          |  9 ++++++++
 Documentation/filesystems/ext4/overview.rst   | 22 ++++++++++---------
 8 files changed, 49 insertions(+), 37 deletions(-)
 create mode 100644 Documentation/filesystems/ext4/inode_table.rst


base-commit: d3f825032091fc14c7d5e34bcd54317ae4246903
-- 
An old man doll... just what I always wanted! - Clara
Re: [PATCH 0/5] ext4 docs toctree reorganization
Posted by Jonathan Corbet 3 months, 1 week ago
Bagas Sanjaya <bagasdotme@gmail.com> writes:

> Hi Jon, hi Ted,
>
> While discussing on my previous ext4 docs reorganization attempt
> by merging contents [1], Jon suggested that considering current docs
> file structure, a proper toctree would be ideal [2]. So, here's
> the patchset that does exactly that.
>
> Actual conversion to toctree structure is in [1/5], while the rest
> is cleanups to make the resulting toctree nicer.
>
> This patchset is based on docs-next tree.

So to me this seems like an improvement.  I'm happy to take it, though
would prefer an ack from ext4land if possible.

Thanks,

jon
Re: [PATCH 0/5] ext4 docs toctree reorganization
Posted by Theodore Ts'o 3 months, 1 week ago
On Tue, Jul 01, 2025 at 01:11:25PM -0600, Jonathan Corbet wrote:
> Bagas Sanjaya <bagasdotme@gmail.com> writes:
> 
> > Hi Jon, hi Ted,
> >
> > While discussing on my previous ext4 docs reorganization attempt
> > by merging contents [1], Jon suggested that considering current docs
> > file structure, a proper toctree would be ideal [2]. So, here's
> > the patchset that does exactly that.
> >
> > Actual conversion to toctree structure is in [1/5], while the rest
> > is cleanups to make the resulting toctree nicer.
> >
> > This patchset is based on docs-next tree.
> 
> So to me this seems like an improvement.  I'm happy to take it, though
> would prefer an ack from ext4land if possible.

Acked-by: Theodore Ts'o <tytso@mit.edu>

						- Ted
Re: [PATCH 0/5] ext4 docs toctree reorganization
Posted by Darrick J. Wong 3 months, 1 week ago
On Tue, Jul 01, 2025 at 01:11:25PM -0600, Jonathan Corbet wrote:
> Bagas Sanjaya <bagasdotme@gmail.com> writes:
> 
> > Hi Jon, hi Ted,
> >
> > While discussing on my previous ext4 docs reorganization attempt
> > by merging contents [1], Jon suggested that considering current docs
> > file structure, a proper toctree would be ideal [2]. So, here's
> > the patchset that does exactly that.
> >
> > Actual conversion to toctree structure is in [1/5], while the rest
> > is cleanups to make the resulting toctree nicer.
> >
> > This patchset is based on docs-next tree.
> 
> So to me this seems like an improvement.  I'm happy to take it, though
> would prefer an ack from ext4land if possible.

I did, yesterday:
https://lore.kernel.org/linux-ext4/87y0t7rajm.fsf@trenco.lwn.net/T/#mc3ea7f04fc1b0e4294bce6bd60f5f605017f6f7c

Though I'm also happy not to be thought of as part of 'ext4land' ;)

--D

> Thanks,
> 
> jon
>
Re: [PATCH 0/5] ext4 docs toctree reorganization
Posted by Jonathan Corbet 3 months, 1 week ago
"Darrick J. Wong" <djwong@kernel.org> writes:

> On Tue, Jul 01, 2025 at 01:11:25PM -0600, Jonathan Corbet wrote:
>> Bagas Sanjaya <bagasdotme@gmail.com> writes:
>> 
>> > Hi Jon, hi Ted,
>> >
>> > While discussing on my previous ext4 docs reorganization attempt
>> > by merging contents [1], Jon suggested that considering current docs
>> > file structure, a proper toctree would be ideal [2]. So, here's
>> > the patchset that does exactly that.
>> >
>> > Actual conversion to toctree structure is in [1/5], while the rest
>> > is cleanups to make the resulting toctree nicer.
>> >
>> > This patchset is based on docs-next tree.
>> 
>> So to me this seems like an improvement.  I'm happy to take it, though
>> would prefer an ack from ext4land if possible.
>
> I did, yesterday:
> https://lore.kernel.org/linux-ext4/87y0t7rajm.fsf@trenco.lwn.net/T/#mc3ea7f04fc1b0e4294bce6bd60f5f605017f6f7c
>
> Though I'm also happy not to be thought of as part of 'ext4land' ;)

Yup, I have your ack ... if that's good enough I'll proceed.  You can be
from wherever you want as far as I'm concerned :)

Thanks,

jon
Re: [PATCH 0/5] ext4 docs toctree reorganization
Posted by Bagas Sanjaya 3 months, 1 week ago
On Fri, Jun 20, 2025 at 05:56:39PM +0700, Bagas Sanjaya wrote:
> Hi Jon, hi Ted,
> 
> While discussing on my previous ext4 docs reorganization attempt
> by merging contents [1], Jon suggested that considering current docs
> file structure, a proper toctree would be ideal [2]. So, here's
> the patchset that does exactly that.
> 
> Actual conversion to toctree structure is in [1/5], while the rest
> is cleanups to make the resulting toctree nicer.
> 

review ping

-- 
An old man doll... just what I always wanted! - Clara
Re: [PATCH 0/5] ext4 docs toctree reorganization
Posted by Darrick J. Wong 3 months, 1 week ago
On Mon, Jun 30, 2025 at 07:53:43AM +0700, Bagas Sanjaya wrote:
> On Fri, Jun 20, 2025 at 05:56:39PM +0700, Bagas Sanjaya wrote:
> > Hi Jon, hi Ted,
> > 
> > While discussing on my previous ext4 docs reorganization attempt
> > by merging contents [1], Jon suggested that considering current docs
> > file structure, a proper toctree would be ideal [2]. So, here's
> > the patchset that does exactly that.
> > 
> > Actual conversion to toctree structure is in [1/5], while the rest
> > is cleanups to make the resulting toctree nicer.
> > 
> 
> review ping

This sounds a lot better than dumping everything into a single huge rst
file. :)

The structural changes to the documents look ok to me, though I'm no rst
expert so I trust you built the documentation and it didn't spawn DOOM
II or anything... ;)

Acked-by: "Darrick J. Wong" <djwong@kernel.org>

--D

> 
> -- 
> An old man doll... just what I always wanted! - Clara
Re: [PATCH 0/5] ext4 docs toctree reorganization
Posted by Jonathan Corbet 3 months, 1 week ago
Bagas Sanjaya <bagasdotme@gmail.com> writes:

> Hi Jon, hi Ted,
>
> While discussing on my previous ext4 docs reorganization attempt
> by merging contents [1], Jon suggested that considering current docs
> file structure, a proper toctree would be ideal [2]. So, here's
> the patchset that does exactly that.
>
> Actual conversion to toctree structure is in [1/5], while the rest
> is cleanups to make the resulting toctree nicer.
>
> This patchset is based on docs-next tree.

Applied, thanks.

jon