Documentation: xfs: Extend table marker on deprecated mount options table

[PATCH] Documentation: xfs: Extend table marker on deprecated mount options table

Posted by Bagas Sanjaya 2 years, 8 months ago

Sphinx reports htmldocs warning on deprecated mount options table:

/home/bagas/repo/linux-kernel/Documentation/admin-guide/xfs.rst:243: WARNING: Malformed table.
Text in column margin in table line 5.

===========================     ================
  Name                          Removal Schedule
===========================     ================
Mounting with V4 filesystem     September 2030
Mounting ascii-ci filesystem    September 2030
ikeep/noikeep                   September 2025
attr2/noattr2                   September 2025
===========================     ================

Extend the table markers to take account of the second name entry
("Mounting ascii-ci filesystem"), which is now the widest and
to fix the above warning.

Fixes: 7ba83850ca2691 ("xfs: deprecate the ascii-ci feature")
Signed-off-by: Bagas Sanjaya <bagasdotme@gmail.com>
---
 This patch is targeted for next merge window (6.4-rc1).

 Documentation/admin-guide/xfs.rst | 6 +++---
 1 file changed, 3 insertions(+), 3 deletions(-)

diff --git a/Documentation/admin-guide/xfs.rst b/Documentation/admin-guide/xfs.rst
index e85a9404d5c082..3a9c041d7f6c31 100644
--- a/Documentation/admin-guide/xfs.rst
+++ b/Documentation/admin-guide/xfs.rst
@@ -236,14 +236,14 @@ the dates listed above.
 Deprecated Mount Options
 ========================
 
-===========================     ================
+============================    ================
   Name				Removal Schedule
-===========================     ================
+============================    ================
 Mounting with V4 filesystem     September 2030
 Mounting ascii-ci filesystem    September 2030
 ikeep/noikeep			September 2025
 attr2/noattr2			September 2025
-===========================     ================
+============================    ================
 
 
 Removed Mount Options

base-commit: 798352cb25d2c27affbb5c733ed28430057228ca
-- 
An old man doll... just what I always wanted! - Clara

Re: [PATCH] Documentation: xfs: Extend table marker on deprecated mount options table

Posted by Darrick J. Wong 2 years, 8 months ago

On Wed, Apr 19, 2023 at 04:49:21PM +0700, Bagas Sanjaya wrote:
> Sphinx reports htmldocs warning on deprecated mount options table:
> 
> /home/bagas/repo/linux-kernel/Documentation/admin-guide/xfs.rst:243: WARNING: Malformed table.
> Text in column margin in table line 5.
> 
> ===========================     ================
>   Name                          Removal Schedule
> ===========================     ================
> Mounting with V4 filesystem     September 2030
> Mounting ascii-ci filesystem    September 2030
> ikeep/noikeep                   September 2025
> attr2/noattr2                   September 2025
> ===========================     ================
> 
> Extend the table markers to take account of the second name entry
> ("Mounting ascii-ci filesystem"), which is now the widest and
> to fix the above warning.
> 
> Fixes: 7ba83850ca2691 ("xfs: deprecate the ascii-ci feature")
> Signed-off-by: Bagas Sanjaya <bagasdotme@gmail.com>

Looks good.  Dave, could you take this through the xfs tree whenever you
push the duplicate #include fixes, please?

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

--D

> ---
>  This patch is targeted for next merge window (6.4-rc1).
> 
>  Documentation/admin-guide/xfs.rst | 6 +++---
>  1 file changed, 3 insertions(+), 3 deletions(-)
> 
> diff --git a/Documentation/admin-guide/xfs.rst b/Documentation/admin-guide/xfs.rst
> index e85a9404d5c082..3a9c041d7f6c31 100644
> --- a/Documentation/admin-guide/xfs.rst
> +++ b/Documentation/admin-guide/xfs.rst
> @@ -236,14 +236,14 @@ the dates listed above.
>  Deprecated Mount Options
>  ========================
>  
> -===========================     ================
> +============================    ================
>    Name				Removal Schedule
> -===========================     ================
> +============================    ================
>  Mounting with V4 filesystem     September 2030
>  Mounting ascii-ci filesystem    September 2030
>  ikeep/noikeep			September 2025
>  attr2/noattr2			September 2025
> -===========================     ================
> +============================    ================
>  
>  
>  Removed Mount Options
> 
> base-commit: 798352cb25d2c27affbb5c733ed28430057228ca
> -- 
> An old man doll... just what I always wanted! - Clara
>

Re: [PATCH] Documentation: xfs: Extend table marker on deprecated mount options table

Posted by Dave Chinner 2 years, 8 months ago

On Wed, Apr 19, 2023 at 08:15:36AM -0700, Darrick J. Wong wrote:
> On Wed, Apr 19, 2023 at 04:49:21PM +0700, Bagas Sanjaya wrote:
> > Sphinx reports htmldocs warning on deprecated mount options table:
> > 
> > /home/bagas/repo/linux-kernel/Documentation/admin-guide/xfs.rst:243: WARNING: Malformed table.
> > Text in column margin in table line 5.
> > 
> > ===========================     ================
> >   Name                          Removal Schedule
> > ===========================     ================
> > Mounting with V4 filesystem     September 2030
> > Mounting ascii-ci filesystem    September 2030
> > ikeep/noikeep                   September 2025
> > attr2/noattr2                   September 2025
> > ===========================     ================
> > 
> > Extend the table markers to take account of the second name entry
> > ("Mounting ascii-ci filesystem"), which is now the widest and
> > to fix the above warning.
> > 
> > Fixes: 7ba83850ca2691 ("xfs: deprecate the ascii-ci feature")
> > Signed-off-by: Bagas Sanjaya <bagasdotme@gmail.com>
> 
> Looks good.  Dave, could you take this through the xfs tree whenever you
> push the duplicate #include fixes, please?
> 
> Reviewed-by: Darrick J. Wong <djwong@kernel.org>

Applied.

-Dave.
-- 
Dave Chinner
david@fromorbit.com