linux-ext4 - Re: [PATCH 2/2] ext4: docs: Take out unneeded escaping

lists.openwall.net		lists / announce owl-users owl-dev john-users john-dev passwdqc-users yescrypt popa3d-users / oss-security kernel-hardening musl sabotage tlsify passwords / crypt-dev xvendor / Bugtraq Full-Disclosure linux-kernel linux-netdev linux-ext4 linux-hardening linux-cve-announce PHC
Open Source and information security mailing list archives

Hash Suite: Windows password security audit tool. GUI, reports in PDF.

[<prev] [next>] [<thread-prev] [thread-next>] [day] [month] [year] [list]

Message-ID: <20210916095550.GF10610@quack2.suse.cz>
Date:   Thu, 16 Sep 2021 11:55:50 +0200
From:   Jan Kara <jack@...e.cz>
To:     Jonathan Corbet <corbet@....net>
Cc:     Theodore Ts'o <tytso@....edu>, Jan Kara <jack@...e.cz>,
        linux-ext4@...r.kernel.org, linux-doc@...r.kernel.org
Subject: Re: [PATCH 2/2] ext4: docs: Take out unneeded escaping

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@....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@...e.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@...e.com>
SUSE Labs, CR