2022-08-09 08:22:27

by Bagas Sanjaya

[permalink] [raw]
Subject: [PATCH 5.19] Documentation: ext4: fix cell spacing of table heading on blockmap table

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: [email protected]
Cc: Andreas Dilger <[email protected]>
Cc: Jonathan Corbet <[email protected]>
Cc: Wang Jianjian <[email protected]>
Cc: [email protected]
Cc: [email protected]
Signed-off-by: Bagas Sanjaya <[email protected]>
Link: https://lore.kernel.org/r/[email protected]
Signed-off-by: Theodore Ts'o <[email protected]>
Signed-off-by: Bagas Sanjaya <[email protected]>
---

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


2022-08-09 15:09:30

by Darrick J. Wong

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

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: [email protected]
> Cc: Andreas Dilger <[email protected]>
> Cc: Jonathan Corbet <[email protected]>
> Cc: Wang Jianjian <[email protected]>
> Cc: [email protected]
> Cc: [email protected]
> Signed-off-by: Bagas Sanjaya <[email protected]>
> Link: https://lore.kernel.org/r/[email protected]
> Signed-off-by: Theodore Ts'o <[email protected]>
> Signed-off-by: Bagas Sanjaya <[email protected]>
> ---
>
> 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 <[email protected]>

--D

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

2022-08-09 18:01:21

by Theodore Ts'o

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

Begas,

You sent me a patch to address this and it's fixed upstream, landing
in Linus's tree after 5.19 release during the current merge window.
It's cc'ed to [email protected], so it's not necessary for you to send
it to stable@ as a separate patch.

This upstream commit is 442ec1e5bb7c ("Documentation: ext4: fix cell
spacing of table heading on blockmap table").

- Ted

2022-08-10 08:33:44

by Bagas Sanjaya

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

On 8/10/22 00:59, Theodore Ts'o wrote:
> Begas,
>
> You sent me a patch to address this and it's fixed upstream, landing
> in Linus's tree after 5.19 release during the current merge window.
> It's cc'ed to [email protected], so it's not necessary for you to send
> it to stable@ as a separate patch.
>
> This upstream commit is 442ec1e5bb7c ("Documentation: ext4: fix cell
> spacing of table heading on blockmap table").
>
> - Ted

Hi Ted, thanks for reminding me.

As stated earlier, I was wonder why 442ec1e5bb7c is applied as 6.0 merge
window material, although the problem had been identified in 5.19 release
cycle.

--
An old man doll... just what I always wanted! - Clara