linux-kernel - Re: [PATCH v2] Documentation: gfs2: Consolidate GFS2 docs into its own subdirectory

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] [day] [month] [year] [list]

Message-ID: <8696a6c8-c555-4523-b8dc-b41ab14b4380@infradead.org>
Date: Tue, 26 Aug 2025 20:18:57 -0700
From: Randy Dunlap <rdunlap@...radead.org>
To: Bagas Sanjaya <bagasdotme@...il.com>,
 Linux Kernel Mailing List <linux-kernel@...r.kernel.org>,
 Linux Documentation <linux-doc@...r.kernel.org>,
 Linux GFS2 <gfs2@...ts.linux.dev>
Cc: Jonathan Corbet <corbet@....net>,
 Andreas Gruenbacher <agruenba@...hat.com>,
 Bjorn Helgaas <bhelgaas@...gle.com>, "Darrick J. Wong" <djwong@...nel.org>,
 Jeff Layton <jlayton@...nel.org>, Miklos Szeredi <mszeredi@...hat.com>,
 Jan Kara <jack@...e.cz>, Christian Brauner <brauner@...nel.org>,
 Chen Linxuan <chenlinxuan@...ontech.com>, James Morse <james.morse@....com>,
 Bernd Schubert <bschubert@....com>, Matthew Wilcox <willy@...radead.org>
Subject: Re: [PATCH v2] Documentation: gfs2: Consolidate GFS2 docs into its
 own subdirectory



On 8/26/25 7:21 PM, Bagas Sanjaya wrote:
> Documentation for GFS2 is scattered in three docs that are in
> Documentation/filesystems/ directory. As these docs are standing out as
> a group, move them into separate gfs2/ subdirectory.
> 
> Signed-off-by: Bagas Sanjaya <bagasdotme@...il.com>
> ---
>  Changes since v1 [1]:
> 
>    * Strip gfs2- prefix (Matthew)
> 
>  [1]: https://lore.kernel.org/linux-doc/20250826023913.14888-1-bagasdotme@gmail.com/
> 
>  .../filesystems/{gfs2-glocks.rst => gfs2/glocks.rst} |  0
>  Documentation/filesystems/gfs2/index.rst             | 12 ++++++++++++
>  .../filesystems/{gfs2.rst => gfs2/overview.rst}      |  6 +++---
>  .../{gfs2-uevents.rst => gfs2/uevents.rst}           |  0
>  Documentation/filesystems/index.rst                  |  4 +---
>  MAINTAINERS                                          |  2 +-
>  6 files changed, 17 insertions(+), 7 deletions(-)
>  rename Documentation/filesystems/{gfs2-glocks.rst => gfs2/glocks.rst} (100%)
>  create mode 100644 Documentation/filesystems/gfs2/index.rst
>  rename Documentation/filesystems/{gfs2.rst => gfs2/overview.rst} (96%)
>  rename Documentation/filesystems/{gfs2-uevents.rst => gfs2/uevents.rst} (100%)
> 
> diff --git a/Documentation/filesystems/gfs2-glocks.rst b/Documentation/filesystems/gfs2/glocks.rst
> similarity index 100%
> rename from Documentation/filesystems/gfs2-glocks.rst
> rename to Documentation/filesystems/gfs2/glocks.rst
> diff --git a/Documentation/filesystems/gfs2/index.rst b/Documentation/filesystems/gfs2/index.rst
> new file mode 100644
> index 00000000000000..9d9ca84d45a7ae
> --- /dev/null
> +++ b/Documentation/filesystems/gfs2/index.rst
> @@ -0,0 +1,12 @@
> +.. SPDX-License-Identifier: GPL-2.0
> +
> +====================
> +Global File System 2
> +====================
> +
> +.. toctree::
> +   :maxdepth: 1
> +
> +   overview
> +   glocks
> +   uevents
> diff --git a/Documentation/filesystems/gfs2.rst b/Documentation/filesystems/gfs2/overview.rst
> similarity index 96%
> rename from Documentation/filesystems/gfs2.rst
> rename to Documentation/filesystems/gfs2/overview.rst
> index 1bc48a13430c1c..f971353d23611c 100644
> --- a/Documentation/filesystems/gfs2.rst
> +++ b/Documentation/filesystems/gfs2/overview.rst
> @@ -1,8 +1,8 @@
>  .. SPDX-License-Identifier: GPL-2.0
>  
> -====================
> -Global File System 2
> -====================
> +=============
> +GFS2 Overview
> +=============
>  
>  GFS2 is a cluster file system. It allows a cluster of computers to
>  simultaneously use a block device that is shared between them (with FC,
> diff --git a/Documentation/filesystems/gfs2-uevents.rst b/Documentation/filesystems/gfs2/uevents.rst
> similarity index 100%
> rename from Documentation/filesystems/gfs2-uevents.rst
> rename to Documentation/filesystems/gfs2/uevents.rst
> diff --git a/Documentation/filesystems/index.rst b/Documentation/filesystems/index.rst
> index 11a599387266a4..897eabaa30d65d 100644
> --- a/Documentation/filesystems/index.rst
> +++ b/Documentation/filesystems/index.rst
> @@ -90,9 +90,7 @@ Documentation for filesystem implementations.
>     ext3
>     ext4/index
>     f2fs
> -   gfs2
> -   gfs2-uevents
> -   gfs2-glocks
> +   gfs2/index
>     hfs
>     hfsplus
>     hpfs
> diff --git a/MAINTAINERS b/MAINTAINERS
> index dafc1171254406..c685140f78c4e9 100644
> --- a/MAINTAINERS
> +++ b/MAINTAINERS
> @@ -10335,7 +10335,7 @@ L:	gfs2@...ts.linux.dev
>  S:	Supported
>  B:	https://bugzilla.kernel.org/enter_bug.cgi?product=File%20System&component=gfs2
>  T:	git git://git.kernel.org/pub/scm/linux/kernel/git/gfs2/linux-gfs2.git
> -F:	Documentation/filesystems/gfs2*
> +F:	Documentation/filesystems/gfs2/*

I think this should be:

F:	Documentation/filesystems/gfs2/

without the trailing '*'.

See the explanation for F: near the top of the MAINTAINERS file.

>  F:	fs/gfs2/
>  F:	include/uapi/linux/gfs2_ondisk.h
>  
> 
> base-commit: ee9a6691935490dc39605882b41b9452844d5e4e


Reviewed-by: Randy Dunlap <rdunlap@...radead.org>

thanks.

-- 
~Randy