public inbox for gfs2@lists.linux.dev
 help / color / mirror / Atom feed
* [PATCH v4] Documentation: gfs2: Consolidate GFS2 docs into its own subdirectory
@ 2025-09-11  0:44 Bagas Sanjaya
  2025-09-23 11:00 ` Bagas Sanjaya
  0 siblings, 1 reply; 6+ messages in thread
From: Bagas Sanjaya @ 2025-09-11  0:44 UTC (permalink / raw)
  To: Linux Kernel Mailing List, Linux Documentation, Linux GFS2
  Cc: Jonathan Corbet, Andreas Gruenbacher, Randy Dunlap, Bagas Sanjaya,
	Bjorn Helgaas, Jan Kara, Christian Brauner, Miklos Szeredi,
	Jeff Layton, Darrick J. Wong, James Morse, Bernd Schubert,
	Chen Linxuan, Matthew Wilcox

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 v3 [1]:

  * Merge original gfs2.rst contents into index page (Jon)

[1]: https://lore.kernel.org/linux-doc/20250909014606.15043-1-bagasdotme@gmail.com/

 .../filesystems/{gfs2-glocks.rst => gfs2/glocks.rst} |  0
 .../filesystems/{gfs2.rst => gfs2/index.rst}         | 12 ++++++++++++
 .../{gfs2-uevents.rst => gfs2/uevents.rst}           |  0
 Documentation/filesystems/index.rst                  |  4 +---
 MAINTAINERS                                          |  2 +-
 5 files changed, 14 insertions(+), 4 deletions(-)
 rename Documentation/filesystems/{gfs2-glocks.rst => gfs2/glocks.rst} (100%)
 rename Documentation/filesystems/{gfs2.rst => gfs2/index.rst} (94%)
 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.rst b/Documentation/filesystems/gfs2/index.rst
similarity index 94%
rename from Documentation/filesystems/gfs2.rst
rename to Documentation/filesystems/gfs2/index.rst
index 1bc48a13430c1c..e5e19540356138 100644
--- a/Documentation/filesystems/gfs2.rst
+++ b/Documentation/filesystems/gfs2/index.rst
@@ -4,6 +4,9 @@
 Global File System 2
 ====================
 
+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,
 iSCSI, NBD, etc).  GFS2 reads and writes to the block device like a local
@@ -50,3 +53,12 @@ The following man pages are available from gfs2-utils:
   gfs2_convert		to convert a gfs filesystem to GFS2 in-place
   mkfs.gfs2		to make a filesystem
   ============		=============================================
+
+Implementation Notes
+====================
+
+.. toctree::
+   :maxdepth: 1
+
+   glocks
+   uevents
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: f44a29784f685804d9970cfb0d3439c9e30981d7
-- 
An old man doll... just what I always wanted! - Clara


^ permalink raw reply related	[flat|nested] 6+ messages in thread

end of thread, other threads:[~2025-09-24 12:54 UTC | newest]

Thread overview: 6+ messages (download: mbox.gz follow: Atom feed
-- links below jump to the message on this page --
2025-09-11  0:44 [PATCH v4] Documentation: gfs2: Consolidate GFS2 docs into its own subdirectory Bagas Sanjaya
2025-09-23 11:00 ` Bagas Sanjaya
2025-09-23 11:44   ` Andreas Gruenbacher
2025-09-23 23:03     ` Bagas Sanjaya
2025-09-24 12:17       ` Andreas Gruenbacher
2025-09-24 12:54         ` Bagas Sanjaya

This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox