Re: [PATCH 1/2] ext4: docs: switch away from list-table
From: Jan Kara <jack@suse.cz>
Date: 2021-09-16 09:54:59
Also in:
linux-ext4
On Thu 02-09-21 16:08:53, Jonathan Corbet wrote:
Commit 3a6541e97c03 (Add documentation about the orphan file feature) added a new document on orphan files, which is great. But the use of "list-table" results in documents that are absolutely unreadable in their plain-text form. Switch this file to the regular RST table format instead; the rendered (HTML) output is identical. Signed-off-by: Jonathan Corbet <corbet@lwn.net>
Thanks! Definitely looks more readable :). You can add: Reviewed-by: Jan Kara <jack@suse.cz> Honza
quoted hunk ↗ jump to hunk
--- Documentation/filesystems/ext4/orphan.rst | 32 ++++++++--------------- 1 file changed, 11 insertions(+), 21 deletions(-)diff --git a/Documentation/filesystems/ext4/orphan.rst b/Documentation/filesystems/ext4/orphan.rst index bb19ecd1b626..d096fe0ba19e 100644 --- a/Documentation/filesystems/ext4/orphan.rst +++ b/Documentation/filesystems/ext4/orphan.rst@@ -21,27 +21,17 @@ in heavy creation of orphan inodes. When orphan file feature (referenced from the superblock through s\_orphan_file_inum) with several blocks. Each of these blocks has a structure: -.. list-table:: - :widths: 8 8 24 40 - :header-rows: 1 - - * - Offset - - Type - - Name - - Description - * - 0x0 - - Array of \_\_le32 entries - - Orphan inode entries - - Each \_\_le32 entry is either empty (0) or it contains inode number of - an orphan inode. - * - blocksize - 8 - - \_\_le32 - - ob\_magic - - Magic value stored in orphan block tail (0x0b10ca04) - * - blocksize - 4 - - \_\_le32 - - ob\_checksum - - Checksum of the orphan block. +============= ================ =============== =============================== +Offset Type Name Description +============= ================ =============== =============================== +0x0 Array of Orphan inode Each \_\_le32 entry is either + \_\_le32 entries entries empty (0) or it contains + inode number of an orphan + inode. +blocksize-8 \_\_le32 ob\_magic Magic value stored in orphan + block tail (0x0b10ca04) +blocksize-4 \_\_le32 ob\_checksum Checksum of the orphan block. +============= ================ =============== =============================== When a filesystem with orphan file feature is writeably mounted, we set RO\_COMPAT\_ORPHAN\_PRESENT feature in the superblock to indicate there may-- 2.31.1
-- Jan Kara [off-list ref] SUSE Labs, CR