[v3] Documentation: gfs2: Consolidate GFS2 docs into its own subdirectory

[PATCH v3] Documentation: gfs2: Consolidate GFS2 docs into its own subdirectory

Posted by Bagas Sanjaya 5 months ago

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.

Reviewed-by: Randy Dunlap <rdunlap@infradead.org>
Signed-off-by: Bagas Sanjaya <bagasdotme@gmail.com>
---
Changes since v2 [1]:

  * Do not use wildcard on MAINTAINERS file entry and add review tag (Randy)

[1]: https://lore.kernel.org/linux-doc/20250827022122.12132-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 ef87548b8f88c6..1b19137f50a6b7 100644
--- a/MAINTAINERS
+++ b/MAINTAINERS
@@ -10336,7 +10336,7 @@ L:	gfs2@lists.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/
 F:	fs/gfs2/
 F:	include/uapi/linux/gfs2_ondisk.h
 

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

Re: [PATCH v3] Documentation: gfs2: Consolidate GFS2 docs into its own subdirectory

Posted by Jonathan Corbet 5 months ago

Bagas Sanjaya <bagasdotme@gmail.com> writes:

> 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.
>
> Reviewed-by: Randy Dunlap <rdunlap@infradead.org>
> Signed-off-by: Bagas Sanjaya <bagasdotme@gmail.com>
> ---
> Changes since v2 [1]:
>
>   * Do not use wildcard on MAINTAINERS file entry and add review tag (Randy)
>
> [1]: https://lore.kernel.org/linux-doc/20250827022122.12132-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%)

I'm not sure which tree this is meant to go through ...

I do have one suggestion: the changes seem good as far as I go, but I
would have made gfs2.rst into the new index.rst and avoided creating an
essentially no-content file there.

Thanks,

jon

Re: [PATCH v3] Documentation: gfs2: Consolidate GFS2 docs into its own subdirectory

Posted by Bagas Sanjaya 5 months ago

On Tue, Sep 09, 2025 at 01:48:56PM -0600, Jonathan Corbet wrote:
> Bagas Sanjaya <bagasdotme@gmail.com> writes:
> 
> > 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.
> >
> > Reviewed-by: Randy Dunlap <rdunlap@infradead.org>
> > Signed-off-by: Bagas Sanjaya <bagasdotme@gmail.com>
> > ---
> > Changes since v2 [1]:
> >
> >   * Do not use wildcard on MAINTAINERS file entry and add review tag (Randy)
> >
> > [1]: https://lore.kernel.org/linux-doc/20250827022122.12132-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%)
> 
> I'm not sure which tree this is meant to go through ...

There's linux-gfs2 tree (see MAINTAINERS)

> 
> I do have one suggestion: the changes seem good as far as I go, but I
> would have made gfs2.rst into the new index.rst and avoided creating an
> essentially no-content file there.

As gfs2 docs currently only has not many (only three), I'm fine with your
suggestion.

Thanks.

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

Re: [PATCH v3] Documentation: gfs2: Consolidate GFS2 docs into its own subdirectory

Posted by Andreas Gruenbacher 5 months ago

On Wed, Sep 10, 2025 at 1:28 AM Bagas Sanjaya <bagasdotme@gmail.com> wrote:
> On Tue, Sep 09, 2025 at 01:48:56PM -0600, Jonathan Corbet wrote:
> > Bagas Sanjaya <bagasdotme@gmail.com> writes:
> >
> > > 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.
> > >
> > > Reviewed-by: Randy Dunlap <rdunlap@infradead.org>
> > > Signed-off-by: Bagas Sanjaya <bagasdotme@gmail.com>
> > > ---
> > > Changes since v2 [1]:
> > >
> > >   * Do not use wildcard on MAINTAINERS file entry and add review tag (Randy)
> > >
> > > [1]: https://lore.kernel.org/linux-doc/20250827022122.12132-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%)
> >
> > I'm not sure which tree this is meant to go through ...
>
> There's linux-gfs2 tree (see MAINTAINERS)

Sure, I can take it. Can you please send your v4 patch to gfs2@lists.linux.dev?

Thanks,
Andreas

Re: [PATCH v3] Documentation: gfs2: Consolidate GFS2 docs into its own subdirectory

Posted by Bagas Sanjaya 4 months, 4 weeks ago

On Wed, Sep 10, 2025 at 01:25:13PM +0200, Andreas Gruenbacher wrote:
> Sure, I can take it. Can you please send your v4 patch to gfs2@lists.linux.dev?

Of course! I will prepare it shortly.

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