linux-kernel - Re: [PATCH] Documentation: fuse: Consolidate FUSE 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] [thread-next>] [day] [month] [year] [list]

Message-ID: <deb943481f781000642b795a49d8a524e8924724.camel@kernel.org>
Date: Thu, 12 Jun 2025 06:53:46 -0400
From: Jeff Layton <jlayton@...nel.org>
To: Bagas Sanjaya <bagasdotme@...il.com>, Linux Kernel Mailing List	
 <linux-kernel@...r.kernel.org>, Linux Documentation
 <linux-doc@...r.kernel.org>,  Linux Filesystems Development	
 <linux-fsdevel@...r.kernel.org>
Cc: Jonathan Corbet <corbet@....net>, Miklos Szeredi <miklos@...redi.hu>, 
 Luis Henriques	 <luis@...lia.com>, Bernd Schubert <bschubert@....com>, Amir
 Goldstein	 <amir73il@...il.com>, Chen Linxuan <chenlinxuan@...ontech.com>,
 Christian Brauner <brauner@...nel.org>, "Darrick J. Wong"
 <djwong@...nel.org>, Jan Kara <jack@...e.cz>,  James Morse
 <james.morse@....com>
Subject: Re: [PATCH] Documentation: fuse: Consolidate FUSE docs into its own
 subdirectory

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@...il.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@...r.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@...nel.org>