From: Jan Kara <jack@suse.cz>
To: Jonathan Corbet <corbet@lwn.net>
Cc: Theodore Ts'o <tytso@mit.edu>, Jan Kara <jack@suse.cz>,
linux-ext4@vger.kernel.org, linux-doc@vger.kernel.org
Subject: Re: [PATCH 1/2] ext4: docs: switch away from list-table
Date: Thu, 16 Sep 2021 11:54:55 +0200 [thread overview]
Message-ID: <20210916095455.GE10610@quack2.suse.cz> (raw)
In-Reply-To: <20210902220854.198850-2-corbet@lwn.net>
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
> ---
> 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 <jack@suse.com>
SUSE Labs, CR
next prev parent reply other threads:[~2021-09-16 9:54 UTC|newest]
Thread overview: 15+ messages / expand[flat|nested] mbox.gz Atom feed top
2021-09-02 22:08 [PATCH 0/2] ext4: docs: de-uglify Documentation/ext4/orphan.rst Jonathan Corbet
2021-09-02 22:08 ` [PATCH 1/2] ext4: docs: switch away from list-table Jonathan Corbet
2021-09-03 6:34 ` Akira Yokosawa
2021-09-03 15:11 ` Jonathan Corbet
2021-09-04 1:23 ` Akira Yokosawa
2021-09-04 7:45 ` Markus Heiser
2021-09-06 14:17 ` Jonathan Corbet
2021-09-06 14:41 ` Markus Heiser
2021-09-16 9:54 ` Jan Kara [this message]
2021-09-21 23:18 ` Jonathan Corbet
2021-10-07 14:28 ` Theodore Ts'o
2021-10-07 14:48 ` Jonathan Corbet
2021-10-07 19:13 ` Jani Nikula
2021-09-02 22:08 ` [PATCH 2/2] ext4: docs: Take out unneeded escaping Jonathan Corbet
2021-09-16 9:55 ` Jan Kara
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=20210916095455.GE10610@quack2.suse.cz \
--to=jack@suse.cz \
--cc=corbet@lwn.net \
--cc=linux-doc@vger.kernel.org \
--cc=linux-ext4@vger.kernel.org \
--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;
as well as URLs for NNTP newsgroup(s).