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

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

[Bagas Sanjaya]

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@gmail.com>
---
 Documentation/filesystems/{ => gfs2}/gfs2-glocks.rst |  0
 .../filesystems/{ => gfs2}/gfs2-uevents.rst          |  0
 Documentation/filesystems/{ => gfs2}/gfs2.rst        |  6 +++---
 Documentation/filesystems/gfs2/index.rst             | 12 ++++++++++++
 Documentation/filesystems/index.rst                  |  4 +---
 MAINTAINERS                                          |  2 +-
 6 files changed, 17 insertions(+), 7 deletions(-)
 rename Documentation/filesystems/{ => gfs2}/gfs2-glocks.rst (100%)
 rename Documentation/filesystems/{ => gfs2}/gfs2-uevents.rst (100%)
 rename Documentation/filesystems/{ => gfs2}/gfs2.rst (96%)
 create mode 100644 Documentation/filesystems/gfs2/index.rst

diff --git a/Documentation/filesystems/gfs2-glocks.rst b/Documentation/filesystems/gfs2/gfs2-glocks.rst
similarity index 100%
rename from Documentation/filesystems/gfs2-glocks.rst
rename to Documentation/filesystems/gfs2/gfs2-glocks.rst
diff --git a/Documentation/filesystems/gfs2-uevents.rst b/Documentation/filesystems/gfs2/gfs2-uevents.rst
similarity index 100%
rename from Documentation/filesystems/gfs2-uevents.rst
rename to Documentation/filesystems/gfs2/gfs2-uevents.rst
diff --git a/Documentation/filesystems/gfs2.rst b/Documentation/filesystems/gfs2/gfs2.rst
similarity index 96%
rename from Documentation/filesystems/gfs2.rst
rename to Documentation/filesystems/gfs2/gfs2.rst
index 1bc48a13430c1c..f971353d23611c 100644
--- a/Documentation/filesystems/gfs2.rst
+++ b/Documentation/filesystems/gfs2/gfs2.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/index.rst b/Documentation/filesystems/gfs2/index.rst
new file mode 100644
index 00000000000000..3875b9e1bb5cd7
--- /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
+
+   gfs2
+   gfs2-glocks
+   gfs2-uevents
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@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: ee9a6691935490dc39605882b41b9452844d5e4e
-- 
An old man doll... just what I always wanted! - Clara

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

[Matthew Wilcox]

On Tue, Aug 26, 2025 at 09:39:13AM +0700, 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.

If this is to be done (and I'm not sure that it should be), why preserve
the 'gfs2-' prefix on the file names?  We know the files pertain to
gfs2, they're now in the gfs2 directory.

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

[Bagas Sanjaya]

[-- Attachment #1: Type: text/plain, Size: 687 bytes --]

On Tue, Aug 26, 2025 at 01:02:22PM +0100, Matthew Wilcox wrote:
> On Tue, Aug 26, 2025 at 09:39:13AM +0700, 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.
> 
> If this is to be done (and I'm not sure that it should be), why preserve
> the 'gfs2-' prefix on the file names?  We know the files pertain to
> gfs2, they're now in the gfs2 directory.
> 

I'm just moving files, though.

Anyway, thanks for the suggestion. I'll apply it in v2.

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

[-- Attachment #2: signature.asc --]
[-- Type: application/pgp-signature, Size: 228 bytes --]