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 2/2] ext4: docs: Take out unneeded escaping
Date: Thu, 16 Sep 2021 11:55:50 +0200 [thread overview]
Message-ID: <20210916095550.GF10610@quack2.suse.cz> (raw)
In-Reply-To: <20210902220854.198850-3-corbet@lwn.net>
On Thu 02-09-21 16:08:54, Jonathan Corbet wrote:
> The new file Documentation/orphan/ext4.rst escapes underscores ("\_")
> throughout. However, RST doesn't actually require that, so the escaping
> only succeeds in making the document less readable. Remove the unneeded
> escapes.
>
> Signed-off-by: Jonathan Corbet <corbet@lwn.net>
> ---
> Documentation/filesystems/ext4/orphan.rst | 20 ++++++++++----------
> 1 file changed, 10 insertions(+), 10 deletions(-)
Hum, probably I saw underscores escaped somewhere and didn't check whether
it is necessary. Thanks for fixing this. You can add:
Reviewed-by: Jan Kara <jack@suse.cz>
Honza
>
> diff --git a/Documentation/filesystems/ext4/orphan.rst b/Documentation/filesystems/ext4/orphan.rst
> index d096fe0ba19e..03cca178864b 100644
> --- a/Documentation/filesystems/ext4/orphan.rst
> +++ b/Documentation/filesystems/ext4/orphan.rst
> @@ -12,31 +12,31 @@ track the inode as orphan so that in case of crash extra blocks allocated to
> the file get truncated.
>
> Traditionally ext4 tracks orphan inodes in a form of single linked list where
> -superblock contains the inode number of the last orphan inode (s\_last\_orphan
> +superblock contains the inode number of the last orphan inode (s_last_orphan
> field) and then each inode contains inode number of the previously orphaned
> -inode (we overload i\_dtime inode field for this). However this filesystem
> +inode (we overload i_dtime inode field for this). However this filesystem
> global single linked list is a scalability bottleneck for workloads that result
> in heavy creation of orphan inodes. When orphan file feature
> -(COMPAT\_ORPHAN\_FILE) is enabled, the filesystem has a special inode
> -(referenced from the superblock through s\_orphan_file_inum) with several
> +(COMPAT_ORPHAN_FILE) is enabled, the filesystem has a special inode
> +(referenced from the superblock through s_orphan_file_inum) with several
> blocks. Each of these blocks has a structure:
>
> ============= ================ =============== ===============================
> Offset Type Name Description
> ============= ================ =============== ===============================
> -0x0 Array of Orphan inode Each \_\_le32 entry is either
> - \_\_le32 entries entries empty (0) or it contains
> +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
> +blocksize-8 __le32 ob_magic Magic value stored in orphan
> block tail (0x0b10ca04)
> -blocksize-4 \_\_le32 ob\_checksum Checksum of the orphan block.
> +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
> +RO_COMPAT_ORPHAN_PRESENT feature in the superblock to indicate there may
> be valid orphan entries. In case we see this feature when mounting the
> filesystem, we read the whole orphan file and process all orphan inodes found
> there as usual. When cleanly unmounting the filesystem we remove the
> -RO\_COMPAT\_ORPHAN\_PRESENT feature to avoid unnecessary scanning of the orphan
> +RO_COMPAT_ORPHAN_PRESENT feature to avoid unnecessary scanning of the orphan
> file and also make the filesystem fully compatible with older kernels.
> --
> 2.31.1
>
--
Jan Kara <jack@suse.com>
SUSE Labs, CR
prev parent reply other threads:[~2021-09-16 9:56 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
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 [this message]
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=20210916095550.GF10610@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).