linux-doc.vger.kernel.org archive mirror
 help / color / mirror / Atom feed
* [PATCH] Documentation: fuse: Consolidate FUSE docs into its own subdirectory
@ 2025-06-12  3:22 Bagas Sanjaya
  2025-06-12  9:07 ` Miklos Szeredi
                   ` (2 more replies)
  0 siblings, 3 replies; 4+ messages in thread
From: Bagas Sanjaya @ 2025-06-12  3:22 UTC (permalink / raw)
  To: Linux Kernel Mailing List, Linux Documentation,
	Linux Filesystems Development
  Cc: Jonathan Corbet, Miklos Szeredi, Luis Henriques, Bagas Sanjaya,
	Bernd Schubert, Amir Goldstein, Chen Linxuan, Christian Brauner,
	Darrick J. Wong, Jeff Layton, Jan Kara, James Morse

All four FUSE docs are currently in upper-level
Documentation/filesystems/ directory, but these are distinct as a group
of its own. Move them into Documentation/filesystems/fuse/ subdirectory.

Signed-off-by: Bagas Sanjaya <bagasdotme@gmail.com>
---
 .../filesystems/{ => fuse}/fuse-io-uring.rst       |  0
 Documentation/filesystems/{ => fuse}/fuse-io.rst   |  2 +-
 .../filesystems/{ => fuse}/fuse-passthrough.rst    |  0
 Documentation/filesystems/{ => fuse}/fuse.rst      |  6 +++---
 Documentation/filesystems/fuse/index.rst           | 14 ++++++++++++++
 Documentation/filesystems/index.rst                |  5 +----
 MAINTAINERS                                        |  2 +-
 7 files changed, 20 insertions(+), 9 deletions(-)
 rename Documentation/filesystems/{ => fuse}/fuse-io-uring.rst (100%)
 rename Documentation/filesystems/{ => fuse}/fuse-io.rst (99%)
 rename Documentation/filesystems/{ => fuse}/fuse-passthrough.rst (100%)
 rename Documentation/filesystems/{ => fuse}/fuse.rst (99%)
 create mode 100644 Documentation/filesystems/fuse/index.rst

diff --git a/Documentation/filesystems/fuse-io-uring.rst b/Documentation/filesystems/fuse/fuse-io-uring.rst
similarity index 100%
rename from Documentation/filesystems/fuse-io-uring.rst
rename to Documentation/filesystems/fuse/fuse-io-uring.rst
diff --git a/Documentation/filesystems/fuse-io.rst b/Documentation/filesystems/fuse/fuse-io.rst
similarity index 99%
rename from Documentation/filesystems/fuse-io.rst
rename to Documentation/filesystems/fuse/fuse-io.rst
index 6464de4266ad50..d736ac4cb48370 100644
--- a/Documentation/filesystems/fuse-io.rst
+++ b/Documentation/filesystems/fuse/fuse-io.rst
@@ -1,7 +1,7 @@
 .. SPDX-License-Identifier: GPL-2.0
 
 ==============
-Fuse I/O Modes
+FUSE I/O Modes
 ==============
 
 Fuse supports the following I/O modes:
diff --git a/Documentation/filesystems/fuse-passthrough.rst b/Documentation/filesystems/fuse/fuse-passthrough.rst
similarity index 100%
rename from Documentation/filesystems/fuse-passthrough.rst
rename to Documentation/filesystems/fuse/fuse-passthrough.rst
diff --git a/Documentation/filesystems/fuse.rst b/Documentation/filesystems/fuse/fuse.rst
similarity index 99%
rename from Documentation/filesystems/fuse.rst
rename to Documentation/filesystems/fuse/fuse.rst
index 1e31e87aee68c5..5976828586f8df 100644
--- a/Documentation/filesystems/fuse.rst
+++ b/Documentation/filesystems/fuse/fuse.rst
@@ -1,8 +1,8 @@
 .. SPDX-License-Identifier: GPL-2.0
 
-====
-FUSE
-====
+=============
+FUSE Overview
+=============
 
 Definitions
 ===========
diff --git a/Documentation/filesystems/fuse/index.rst b/Documentation/filesystems/fuse/index.rst
new file mode 100644
index 00000000000000..393a845214da95
--- /dev/null
+++ b/Documentation/filesystems/fuse/index.rst
@@ -0,0 +1,14 @@
+.. SPDX-License-Identifier: GPL-2.0
+
+======================================================
+FUSE (Filesystem in Userspace) Technical Documentation
+======================================================
+
+.. toctree::
+   :maxdepth: 2
+   :numbered:
+
+   fuse
+   fuse-io
+   fuse-io-uring
+   fuse-passthrough
diff --git a/Documentation/filesystems/index.rst b/Documentation/filesystems/index.rst
index 11a599387266a4..84c5a0d11b6df7 100644
--- a/Documentation/filesystems/index.rst
+++ b/Documentation/filesystems/index.rst
@@ -96,10 +96,7 @@ Documentation for filesystem implementations.
    hfs
    hfsplus
    hpfs
-   fuse
-   fuse-io
-   fuse-io-uring
-   fuse-passthrough
+   fuse/index
    inotify
    isofs
    nilfs2
diff --git a/MAINTAINERS b/MAINTAINERS
index a92290fffa163f..026afb50000346 100644
--- a/MAINTAINERS
+++ b/MAINTAINERS
@@ -9898,7 +9898,7 @@ L:	linux-fsdevel@vger.kernel.org
 S:	Maintained
 W:	https://github.com/libfuse/
 T:	git git://git.kernel.org/pub/scm/linux/kernel/git/mszeredi/fuse.git
-F:	Documentation/filesystems/fuse*
+F:	Documentation/filesystems/fuse/*
 F:	fs/fuse/
 F:	include/uapi/linux/fuse.h
 

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


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

* Re: [PATCH] Documentation: fuse: Consolidate FUSE docs into its own subdirectory
  2025-06-12  3:22 [PATCH] Documentation: fuse: Consolidate FUSE docs into its own subdirectory Bagas Sanjaya
@ 2025-06-12  9:07 ` Miklos Szeredi
  2025-06-12  9:09 ` Bernd Schubert
  2025-06-12 10:53 ` Jeff Layton
  2 siblings, 0 replies; 4+ messages in thread
From: Miklos Szeredi @ 2025-06-12  9:07 UTC (permalink / raw)
  To: Bagas Sanjaya
  Cc: Linux Kernel Mailing List, Linux Documentation,
	Linux Filesystems Development, Jonathan Corbet, Luis Henriques,
	Bernd Schubert, Amir Goldstein, Chen Linxuan, Christian Brauner,
	Darrick J. Wong, Jeff Layton, Jan Kara, James Morse

On Thu, 12 Jun 2025 at 05:22, Bagas Sanjaya <bagasdotme@gmail.com> wrote:
>
> All four FUSE docs are currently in upper-level
> Documentation/filesystems/ directory, but these are distinct as a group
> of its own. Move them into Documentation/filesystems/fuse/ subdirectory.
>
> Signed-off-by: Bagas Sanjaya <bagasdotme@gmail.com>

Applied, thanks.

Miklos

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

* Re: [PATCH] Documentation: fuse: Consolidate FUSE docs into its own subdirectory
  2025-06-12  3:22 [PATCH] Documentation: fuse: Consolidate FUSE docs into its own subdirectory Bagas Sanjaya
  2025-06-12  9:07 ` Miklos Szeredi
@ 2025-06-12  9:09 ` Bernd Schubert
  2025-06-12 10:53 ` Jeff Layton
  2 siblings, 0 replies; 4+ messages in thread
From: Bernd Schubert @ 2025-06-12  9:09 UTC (permalink / raw)
  To: Bagas Sanjaya, Linux Kernel Mailing List, Linux Documentation,
	Linux Filesystems Development
  Cc: Jonathan Corbet, Miklos Szeredi, Luis Henriques, Amir Goldstein,
	Chen Linxuan, Christian Brauner, Darrick J. Wong, Jeff Layton,
	Jan Kara, James Morse



On 6/12/25 05:22, Bagas Sanjaya wrote:
> [You don't often get email from bagasdotme@gmail.com. Learn why this is important at https://aka.ms/LearnAboutSenderIdentification ]
> 
> All four FUSE docs are currently in upper-level
> Documentation/filesystems/ directory, but these are distinct as a group
> of its own. Move them into Documentation/filesystems/fuse/ subdirectory.
Good idea, thank you!

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

* Re: [PATCH] Documentation: fuse: Consolidate FUSE docs into its own subdirectory
  2025-06-12  3:22 [PATCH] Documentation: fuse: Consolidate FUSE docs into its own subdirectory Bagas Sanjaya
  2025-06-12  9:07 ` Miklos Szeredi
  2025-06-12  9:09 ` Bernd Schubert
@ 2025-06-12 10:53 ` Jeff Layton
  2 siblings, 0 replies; 4+ messages in thread
From: Jeff Layton @ 2025-06-12 10:53 UTC (permalink / raw)
  To: Bagas Sanjaya, Linux Kernel Mailing List, Linux Documentation,
	Linux Filesystems Development
  Cc: Jonathan Corbet, Miklos Szeredi, Luis Henriques, Bernd Schubert,
	Amir Goldstein, Chen Linxuan, Christian Brauner, Darrick J. Wong,
	Jan Kara, James Morse

On Thu, 2025-06-12 at 10:22 +0700, Bagas Sanjaya wrote:
> All four FUSE docs are currently in upper-level
> Documentation/filesystems/ directory, but these are distinct as a group
> of its own. Move them into Documentation/filesystems/fuse/ subdirectory.
> 
> Signed-off-by: Bagas Sanjaya <bagasdotme@gmail.com>
> ---
>  .../filesystems/{ => fuse}/fuse-io-uring.rst       |  0
>  Documentation/filesystems/{ => fuse}/fuse-io.rst   |  2 +-
>  .../filesystems/{ => fuse}/fuse-passthrough.rst    |  0
>  Documentation/filesystems/{ => fuse}/fuse.rst      |  6 +++---
>  Documentation/filesystems/fuse/index.rst           | 14 ++++++++++++++
>  Documentation/filesystems/index.rst                |  5 +----
>  MAINTAINERS                                        |  2 +-
>  7 files changed, 20 insertions(+), 9 deletions(-)
>  rename Documentation/filesystems/{ => fuse}/fuse-io-uring.rst (100%)
>  rename Documentation/filesystems/{ => fuse}/fuse-io.rst (99%)
>  rename Documentation/filesystems/{ => fuse}/fuse-passthrough.rst (100%)
>  rename Documentation/filesystems/{ => fuse}/fuse.rst (99%)
>  create mode 100644 Documentation/filesystems/fuse/index.rst
> 
> diff --git a/Documentation/filesystems/fuse-io-uring.rst b/Documentation/filesystems/fuse/fuse-io-uring.rst
> similarity index 100%
> rename from Documentation/filesystems/fuse-io-uring.rst
> rename to Documentation/filesystems/fuse/fuse-io-uring.rst
> diff --git a/Documentation/filesystems/fuse-io.rst b/Documentation/filesystems/fuse/fuse-io.rst
> similarity index 99%
> rename from Documentation/filesystems/fuse-io.rst
> rename to Documentation/filesystems/fuse/fuse-io.rst
> index 6464de4266ad50..d736ac4cb48370 100644
> --- a/Documentation/filesystems/fuse-io.rst
> +++ b/Documentation/filesystems/fuse/fuse-io.rst
> @@ -1,7 +1,7 @@
>  .. SPDX-License-Identifier: GPL-2.0
>  
>  ==============
> -Fuse I/O Modes
> +FUSE I/O Modes
>  ==============
>  
>  Fuse supports the following I/O modes:
> diff --git a/Documentation/filesystems/fuse-passthrough.rst b/Documentation/filesystems/fuse/fuse-passthrough.rst
> similarity index 100%
> rename from Documentation/filesystems/fuse-passthrough.rst
> rename to Documentation/filesystems/fuse/fuse-passthrough.rst
> diff --git a/Documentation/filesystems/fuse.rst b/Documentation/filesystems/fuse/fuse.rst
> similarity index 99%
> rename from Documentation/filesystems/fuse.rst
> rename to Documentation/filesystems/fuse/fuse.rst
> index 1e31e87aee68c5..5976828586f8df 100644
> --- a/Documentation/filesystems/fuse.rst
> +++ b/Documentation/filesystems/fuse/fuse.rst
> @@ -1,8 +1,8 @@
>  .. SPDX-License-Identifier: GPL-2.0
>  
> -====
> -FUSE
> -====
> +=============
> +FUSE Overview
> +=============
>  
>  Definitions
>  ===========
> diff --git a/Documentation/filesystems/fuse/index.rst b/Documentation/filesystems/fuse/index.rst
> new file mode 100644
> index 00000000000000..393a845214da95
> --- /dev/null
> +++ b/Documentation/filesystems/fuse/index.rst
> @@ -0,0 +1,14 @@
> +.. SPDX-License-Identifier: GPL-2.0
> +
> +======================================================
> +FUSE (Filesystem in Userspace) Technical Documentation
> +======================================================
> +
> +.. toctree::
> +   :maxdepth: 2
> +   :numbered:
> +
> +   fuse
> +   fuse-io
> +   fuse-io-uring
> +   fuse-passthrough
> diff --git a/Documentation/filesystems/index.rst b/Documentation/filesystems/index.rst
> index 11a599387266a4..84c5a0d11b6df7 100644
> --- a/Documentation/filesystems/index.rst
> +++ b/Documentation/filesystems/index.rst
> @@ -96,10 +96,7 @@ Documentation for filesystem implementations.
>     hfs
>     hfsplus
>     hpfs
> -   fuse
> -   fuse-io
> -   fuse-io-uring
> -   fuse-passthrough
> +   fuse/index
>     inotify
>     isofs
>     nilfs2
> diff --git a/MAINTAINERS b/MAINTAINERS
> index a92290fffa163f..026afb50000346 100644
> --- a/MAINTAINERS
> +++ b/MAINTAINERS
> @@ -9898,7 +9898,7 @@ L:	linux-fsdevel@vger.kernel.org
>  S:	Maintained
>  W:	https://github.com/libfuse/
>  T:	git git://git.kernel.org/pub/scm/linux/kernel/git/mszeredi/fuse.git
> -F:	Documentation/filesystems/fuse*
> +F:	Documentation/filesystems/fuse/*
>  F:	fs/fuse/
>  F:	include/uapi/linux/fuse.h
>  
> 
> base-commit: d3f825032091fc14c7d5e34bcd54317ae4246903

Seems like a good idea.

Acked-by: Jeff Layton <jlayton@kernel.org>

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

end of thread, other threads:[~2025-06-12 10:53 UTC | newest]

Thread overview: 4+ messages (download: mbox.gz follow: Atom feed
-- links below jump to the message on this page --
2025-06-12  3:22 [PATCH] Documentation: fuse: Consolidate FUSE docs into its own subdirectory Bagas Sanjaya
2025-06-12  9:07 ` Miklos Szeredi
2025-06-12  9:09 ` Bernd Schubert
2025-06-12 10:53 ` Jeff Layton

This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for NNTP newsgroup(s).