Re: [PATCH 5.19] Documentation: ext4: fix cell spacing of table heading on blockmap table

Darrick J. Wong
2022-08-09T15:04:02Z

On Tue, Aug 09, 2022 at 03:08:28PM +0700, Bagas Sanjaya wrote:
> commit 442ec1e5bb7c46c72c41898e13a5744c84cadf51 upstream.
>
> Commit 3103084afcf234 ("ext4, doc: remove unnecessary escaping") removes
> redundant underscore escaping, however the cell spacing in heading row of
> blockmap table became not aligned anymore, hence triggers malformed table
> warning:
>
> Documentation/filesystems/ext4/blockmap.rst:3: WARNING: Malformed table.
>
> +---------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
> | i.i_block Offset | Where It Points |
> <snipped>...
>
> The warning caused the table not being loaded.
>
> Realign the heading row cell by adding missing space at the first cell
> to fix the warning.
>
> Fixes: 3103084afcf234 ("ext4, doc: remove unnecessary escaping")
> Cc: stable@kernel.org
> Cc: Andreas Dilger <adilger.kernel@dilger.ca>
> Cc: Jonathan Corbet <corbet@lwn.net>
> Cc: Wang Jianjian <wangjianjian3@huawei.com>
> Cc: linux-ext4@vger.kernel.org
> Cc: linux-kernel@vger.kernel.org
> Signed-off-by: Bagas Sanjaya <bagasdotme@gmail.com>
> Link: https://lore.kernel.org/r/20220619072938.7334-1-bagasdotme@gmail.com
> Signed-off-by: Theodore Ts'o <tytso@mit.edu>
> Signed-off-by: Bagas Sanjaya <bagasdotme@gmail.com>
> ---
>
> Seems like this patch is merged to Linus's tree as merge window
> material for 6.0, but it should have been -rc fix material for 5.19
> cycle. Now that the version have been stabilized (and now on 6.0 merge
> window), it should be logical to submit this backport for 5.19 tree.
>
> Documentation/filesystems/ext4/blockmap.rst | 2 +-
> 1 file changed, 1 insertion(+), 1 deletion(-)
>
> diff --git a/Documentation/filesystems/ext4/blockmap.rst b/Documentation/filesystems/ext4/blockmap.rst
> index 2bd990402a5c49..cc596541ce7921 100644
> --- a/Documentation/filesystems/ext4/blockmap.rst
> +++ b/Documentation/filesystems/ext4/blockmap.rst
> @@ -1,7 +1,7 @@
> .. SPDX-License-Identifier: GPL-2.0
>
> +---------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
> -| i.i_block Offset | Where It Points |
> +| i.i_block Offset | Where It Points |

AHA, that's why I kept getting screenfuls of sphinx complaints when I
was building the XFS documentation. Thanks for fixing this...

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

--D

> +=====================+==============================================================================================================================================================================================================================+
> | 0 to 11 | Direct map to file blocks 0 to 11. |
> +---------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
> --
> An old man doll... just what I always wanted! - Clara
>