* Re: [PATCH v3] Documentation: xfs: consolidate XFS docs into its own subdirectory
2023-11-29 12:39 [PATCH v3] Documentation: xfs: consolidate XFS docs into its own subdirectory Bagas Sanjaya
@ 2023-11-29 14:49 ` Bill O'Donnell
2023-11-29 16:07 ` Darrick J. Wong
2023-12-09 5:26 ` Bagas Sanjaya
2 siblings, 0 replies; 6+ messages in thread
From: Bill O'Donnell @ 2023-11-29 14:49 UTC (permalink / raw)
To: Bagas Sanjaya
Cc: Linux Kernel Mailing List, Linux Documentation, Linux XFS,
Linux Kernel Workflows, Jonathan Corbet, Chandan Babu R,
Darrick J. Wong, Namjae Jeon, Dave Chinner, Steve French,
Matthew Wilcox (Oracle), Allison Henderson, Bjorn Helgaas,
Charles Han, Vegard Nossum
On Wed, Nov 29, 2023 at 07:39:47PM +0700, Bagas Sanjaya wrote:
> XFS docs are currently in upper-level Documentation/filesystems.
> Although these are currently 4 docs, they are already outstanding as
> a group and can be moved to its own subdirectory.
>
> Consolidate them into Documentation/filesystems/xfs/.
>
> Signed-off-by: Bagas Sanjaya <bagasdotme@gmail.com>
Looks good to me.
Reviewed-by: Bill O'Donnell <bodonnel@redhat.com>
> ---
> Changes since v2 [1]:
>
> * Adjust MAINTAINERS pattern to include all docs in the subdirectory
> by using wildcard.
>
> [1]: https://lore.kernel.org/linux-doc/20231128124522.28499-1-bagasdotme@gmail.com/
>
> Documentation/filesystems/index.rst | 5 +----
> Documentation/filesystems/xfs/index.rst | 14 ++++++++++++++
> .../{ => xfs}/xfs-delayed-logging-design.rst | 0
> .../{ => xfs}/xfs-maintainer-entry-profile.rst | 0
> .../{ => xfs}/xfs-online-fsck-design.rst | 2 +-
> .../{ => xfs}/xfs-self-describing-metadata.rst | 0
> .../maintainer/maintainer-entry-profile.rst | 2 +-
> MAINTAINERS | 4 ++--
> 8 files changed, 19 insertions(+), 8 deletions(-)
> create mode 100644 Documentation/filesystems/xfs/index.rst
> rename Documentation/filesystems/{ => xfs}/xfs-delayed-logging-design.rst (100%)
> rename Documentation/filesystems/{ => xfs}/xfs-maintainer-entry-profile.rst (100%)
> rename Documentation/filesystems/{ => xfs}/xfs-online-fsck-design.rst (99%)
> rename Documentation/filesystems/{ => xfs}/xfs-self-describing-metadata.rst (100%)
>
> diff --git a/Documentation/filesystems/index.rst b/Documentation/filesystems/index.rst
> index 09cade7eaefc8c..e18bc5ae3b35f8 100644
> --- a/Documentation/filesystems/index.rst
> +++ b/Documentation/filesystems/index.rst
> @@ -121,8 +121,5 @@ Documentation for filesystem implementations.
> udf
> virtiofs
> vfat
> - xfs-delayed-logging-design
> - xfs-maintainer-entry-profile
> - xfs-self-describing-metadata
> - xfs-online-fsck-design
> + xfs/index
> zonefs
> diff --git a/Documentation/filesystems/xfs/index.rst b/Documentation/filesystems/xfs/index.rst
> new file mode 100644
> index 00000000000000..ab66c57a5d18ea
> --- /dev/null
> +++ b/Documentation/filesystems/xfs/index.rst
> @@ -0,0 +1,14 @@
> +.. SPDX-License-Identifier: GPL-2.0
> +
> +============================
> +XFS Filesystem Documentation
> +============================
> +
> +.. toctree::
> + :maxdepth: 2
> + :numbered:
> +
> + xfs-delayed-logging-design
> + xfs-maintainer-entry-profile
> + xfs-self-describing-metadata
> + xfs-online-fsck-design
> diff --git a/Documentation/filesystems/xfs-delayed-logging-design.rst b/Documentation/filesystems/xfs/xfs-delayed-logging-design.rst
> similarity index 100%
> rename from Documentation/filesystems/xfs-delayed-logging-design.rst
> rename to Documentation/filesystems/xfs/xfs-delayed-logging-design.rst
> diff --git a/Documentation/filesystems/xfs-maintainer-entry-profile.rst b/Documentation/filesystems/xfs/xfs-maintainer-entry-profile.rst
> similarity index 100%
> rename from Documentation/filesystems/xfs-maintainer-entry-profile.rst
> rename to Documentation/filesystems/xfs/xfs-maintainer-entry-profile.rst
> diff --git a/Documentation/filesystems/xfs-online-fsck-design.rst b/Documentation/filesystems/xfs/xfs-online-fsck-design.rst
> similarity index 99%
> rename from Documentation/filesystems/xfs-online-fsck-design.rst
> rename to Documentation/filesystems/xfs/xfs-online-fsck-design.rst
> index a0678101a7d02d..352516feef6ffe 100644
> --- a/Documentation/filesystems/xfs-online-fsck-design.rst
> +++ b/Documentation/filesystems/xfs/xfs-online-fsck-design.rst
> @@ -962,7 +962,7 @@ disk, but these buffer verifiers cannot provide any consistency checking
> between metadata structures.
>
> For more information, please see the documentation for
> -Documentation/filesystems/xfs-self-describing-metadata.rst
> +Documentation/filesystems/xfs/xfs-self-describing-metadata.rst
>
> Reverse Mapping
> ---------------
> diff --git a/Documentation/filesystems/xfs-self-describing-metadata.rst b/Documentation/filesystems/xfs/xfs-self-describing-metadata.rst
> similarity index 100%
> rename from Documentation/filesystems/xfs-self-describing-metadata.rst
> rename to Documentation/filesystems/xfs/xfs-self-describing-metadata.rst
> diff --git a/Documentation/maintainer/maintainer-entry-profile.rst b/Documentation/maintainer/maintainer-entry-profile.rst
> index 7ad4bfc2cc038a..18cee1edaecb6f 100644
> --- a/Documentation/maintainer/maintainer-entry-profile.rst
> +++ b/Documentation/maintainer/maintainer-entry-profile.rst
> @@ -105,4 +105,4 @@ to do something different in the near future.
> ../driver-api/media/maintainer-entry-profile
> ../driver-api/vfio-pci-device-specific-driver-acceptance
> ../nvme/feature-and-quirk-policy
> - ../filesystems/xfs-maintainer-entry-profile
> + ../filesystems/xfs/xfs-maintainer-entry-profile
> diff --git a/MAINTAINERS b/MAINTAINERS
> index ea790149af7951..5ad039cfe9c794 100644
> --- a/MAINTAINERS
> +++ b/MAINTAINERS
> @@ -23893,10 +23893,10 @@ S: Supported
> W: http://xfs.org/
> C: irc://irc.oftc.net/xfs
> T: git git://git.kernel.org/pub/scm/fs/xfs/xfs-linux.git
> -P: Documentation/filesystems/xfs-maintainer-entry-profile.rst
> +P: Documentation/filesystems/xfs/xfs-maintainer-entry-profile.rst
> F: Documentation/ABI/testing/sysfs-fs-xfs
> F: Documentation/admin-guide/xfs.rst
> -F: Documentation/filesystems/xfs-*
> +F: Documentation/filesystems/xfs/*
> F: fs/xfs/
> F: include/uapi/linux/dqblk_xfs.h
> F: include/uapi/linux/fsmap.h
>
> base-commit: 9c235dfc3d3f901fe22acb20f2ab37ff39f2ce02
> --
> An old man doll... just what I always wanted! - Clara
>
>
^ permalink raw reply [flat|nested] 6+ messages in thread* Re: [PATCH v3] Documentation: xfs: consolidate XFS docs into its own subdirectory
2023-11-29 12:39 [PATCH v3] Documentation: xfs: consolidate XFS docs into its own subdirectory Bagas Sanjaya
2023-11-29 14:49 ` Bill O'Donnell
@ 2023-11-29 16:07 ` Darrick J. Wong
2023-12-09 5:26 ` Bagas Sanjaya
2 siblings, 0 replies; 6+ messages in thread
From: Darrick J. Wong @ 2023-11-29 16:07 UTC (permalink / raw)
To: Bagas Sanjaya
Cc: Linux Kernel Mailing List, Linux Documentation, Linux XFS,
Linux Kernel Workflows, Jonathan Corbet, Chandan Babu R,
Namjae Jeon, Dave Chinner, Steve French, Matthew Wilcox (Oracle),
Allison Henderson, Bjorn Helgaas, Charles Han, Vegard Nossum
On Wed, Nov 29, 2023 at 07:39:47PM +0700, Bagas Sanjaya wrote:
> XFS docs are currently in upper-level Documentation/filesystems.
> Although these are currently 4 docs, they are already outstanding as
> a group and can be moved to its own subdirectory.
>
> Consolidate them into Documentation/filesystems/xfs/.
>
> Signed-off-by: Bagas Sanjaya <bagasdotme@gmail.com>
Looks good!
Reviewed-by: Darrick J. Wong <djwong@kernel.org>
--D
> ---
> Changes since v2 [1]:
>
> * Adjust MAINTAINERS pattern to include all docs in the subdirectory
> by using wildcard.
>
> [1]: https://lore.kernel.org/linux-doc/20231128124522.28499-1-bagasdotme@gmail.com/
>
> Documentation/filesystems/index.rst | 5 +----
> Documentation/filesystems/xfs/index.rst | 14 ++++++++++++++
> .../{ => xfs}/xfs-delayed-logging-design.rst | 0
> .../{ => xfs}/xfs-maintainer-entry-profile.rst | 0
> .../{ => xfs}/xfs-online-fsck-design.rst | 2 +-
> .../{ => xfs}/xfs-self-describing-metadata.rst | 0
> .../maintainer/maintainer-entry-profile.rst | 2 +-
> MAINTAINERS | 4 ++--
> 8 files changed, 19 insertions(+), 8 deletions(-)
> create mode 100644 Documentation/filesystems/xfs/index.rst
> rename Documentation/filesystems/{ => xfs}/xfs-delayed-logging-design.rst (100%)
> rename Documentation/filesystems/{ => xfs}/xfs-maintainer-entry-profile.rst (100%)
> rename Documentation/filesystems/{ => xfs}/xfs-online-fsck-design.rst (99%)
> rename Documentation/filesystems/{ => xfs}/xfs-self-describing-metadata.rst (100%)
>
> diff --git a/Documentation/filesystems/index.rst b/Documentation/filesystems/index.rst
> index 09cade7eaefc8c..e18bc5ae3b35f8 100644
> --- a/Documentation/filesystems/index.rst
> +++ b/Documentation/filesystems/index.rst
> @@ -121,8 +121,5 @@ Documentation for filesystem implementations.
> udf
> virtiofs
> vfat
> - xfs-delayed-logging-design
> - xfs-maintainer-entry-profile
> - xfs-self-describing-metadata
> - xfs-online-fsck-design
> + xfs/index
> zonefs
> diff --git a/Documentation/filesystems/xfs/index.rst b/Documentation/filesystems/xfs/index.rst
> new file mode 100644
> index 00000000000000..ab66c57a5d18ea
> --- /dev/null
> +++ b/Documentation/filesystems/xfs/index.rst
> @@ -0,0 +1,14 @@
> +.. SPDX-License-Identifier: GPL-2.0
> +
> +============================
> +XFS Filesystem Documentation
> +============================
> +
> +.. toctree::
> + :maxdepth: 2
> + :numbered:
> +
> + xfs-delayed-logging-design
> + xfs-maintainer-entry-profile
> + xfs-self-describing-metadata
> + xfs-online-fsck-design
> diff --git a/Documentation/filesystems/xfs-delayed-logging-design.rst b/Documentation/filesystems/xfs/xfs-delayed-logging-design.rst
> similarity index 100%
> rename from Documentation/filesystems/xfs-delayed-logging-design.rst
> rename to Documentation/filesystems/xfs/xfs-delayed-logging-design.rst
> diff --git a/Documentation/filesystems/xfs-maintainer-entry-profile.rst b/Documentation/filesystems/xfs/xfs-maintainer-entry-profile.rst
> similarity index 100%
> rename from Documentation/filesystems/xfs-maintainer-entry-profile.rst
> rename to Documentation/filesystems/xfs/xfs-maintainer-entry-profile.rst
> diff --git a/Documentation/filesystems/xfs-online-fsck-design.rst b/Documentation/filesystems/xfs/xfs-online-fsck-design.rst
> similarity index 99%
> rename from Documentation/filesystems/xfs-online-fsck-design.rst
> rename to Documentation/filesystems/xfs/xfs-online-fsck-design.rst
> index a0678101a7d02d..352516feef6ffe 100644
> --- a/Documentation/filesystems/xfs-online-fsck-design.rst
> +++ b/Documentation/filesystems/xfs/xfs-online-fsck-design.rst
> @@ -962,7 +962,7 @@ disk, but these buffer verifiers cannot provide any consistency checking
> between metadata structures.
>
> For more information, please see the documentation for
> -Documentation/filesystems/xfs-self-describing-metadata.rst
> +Documentation/filesystems/xfs/xfs-self-describing-metadata.rst
>
> Reverse Mapping
> ---------------
> diff --git a/Documentation/filesystems/xfs-self-describing-metadata.rst b/Documentation/filesystems/xfs/xfs-self-describing-metadata.rst
> similarity index 100%
> rename from Documentation/filesystems/xfs-self-describing-metadata.rst
> rename to Documentation/filesystems/xfs/xfs-self-describing-metadata.rst
> diff --git a/Documentation/maintainer/maintainer-entry-profile.rst b/Documentation/maintainer/maintainer-entry-profile.rst
> index 7ad4bfc2cc038a..18cee1edaecb6f 100644
> --- a/Documentation/maintainer/maintainer-entry-profile.rst
> +++ b/Documentation/maintainer/maintainer-entry-profile.rst
> @@ -105,4 +105,4 @@ to do something different in the near future.
> ../driver-api/media/maintainer-entry-profile
> ../driver-api/vfio-pci-device-specific-driver-acceptance
> ../nvme/feature-and-quirk-policy
> - ../filesystems/xfs-maintainer-entry-profile
> + ../filesystems/xfs/xfs-maintainer-entry-profile
> diff --git a/MAINTAINERS b/MAINTAINERS
> index ea790149af7951..5ad039cfe9c794 100644
> --- a/MAINTAINERS
> +++ b/MAINTAINERS
> @@ -23893,10 +23893,10 @@ S: Supported
> W: http://xfs.org/
> C: irc://irc.oftc.net/xfs
> T: git git://git.kernel.org/pub/scm/fs/xfs/xfs-linux.git
> -P: Documentation/filesystems/xfs-maintainer-entry-profile.rst
> +P: Documentation/filesystems/xfs/xfs-maintainer-entry-profile.rst
> F: Documentation/ABI/testing/sysfs-fs-xfs
> F: Documentation/admin-guide/xfs.rst
> -F: Documentation/filesystems/xfs-*
> +F: Documentation/filesystems/xfs/*
> F: fs/xfs/
> F: include/uapi/linux/dqblk_xfs.h
> F: include/uapi/linux/fsmap.h
>
> base-commit: 9c235dfc3d3f901fe22acb20f2ab37ff39f2ce02
> --
> An old man doll... just what I always wanted! - Clara
>
>
^ permalink raw reply [flat|nested] 6+ messages in thread* Re: [PATCH v3] Documentation: xfs: consolidate XFS docs into its own subdirectory
2023-11-29 12:39 [PATCH v3] Documentation: xfs: consolidate XFS docs into its own subdirectory Bagas Sanjaya
2023-11-29 14:49 ` Bill O'Donnell
2023-11-29 16:07 ` Darrick J. Wong
@ 2023-12-09 5:26 ` Bagas Sanjaya
2023-12-09 8:00 ` Chandan Babu R
2 siblings, 1 reply; 6+ messages in thread
From: Bagas Sanjaya @ 2023-12-09 5:26 UTC (permalink / raw)
To: Jonathan Corbet, Chandan Babu R, Darrick J. Wong,
Linux Kernel Mailing List, Linux Documentation, Linux XFS,
Linux Kernel Workflows
Cc: Namjae Jeon, Dave Chinner, Steve French, Matthew Wilcox (Oracle),
Allison Henderson, Bjorn Helgaas, Charles Han, Vegard Nossum
[-- Attachment #1: Type: text/plain, Size: 715 bytes --]
On Wed, Nov 29, 2023 at 07:39:47PM +0700, Bagas Sanjaya wrote:
> XFS docs are currently in upper-level Documentation/filesystems.
> Although these are currently 4 docs, they are already outstanding as
> a group and can be moved to its own subdirectory.
>
> Consolidate them into Documentation/filesystems/xfs/.
>
> Signed-off-by: Bagas Sanjaya <bagasdotme@gmail.com>
Hi Jon, Chandan, and Darrick,
FYI, XFS tree [1] is not updated since 2 weeks ago (and this patch doesn't get
picked up). Would you like to route this patch through docs-next tree or
xfs/for-next?
Thanks.
[1]: https://git.kernel.org/pub/scm/fs/xfs/xfs-linux.git/
--
An old man doll... just what I always wanted! - Clara
[-- Attachment #2: signature.asc --]
[-- Type: application/pgp-signature, Size: 228 bytes --]
^ permalink raw reply [flat|nested] 6+ messages in thread
* Re: [PATCH v3] Documentation: xfs: consolidate XFS docs into its own subdirectory
2023-12-09 5:26 ` Bagas Sanjaya
@ 2023-12-09 8:00 ` Chandan Babu R
2023-12-09 8:17 ` Bagas Sanjaya
0 siblings, 1 reply; 6+ messages in thread
From: Chandan Babu R @ 2023-12-09 8:00 UTC (permalink / raw)
To: Bagas Sanjaya
Cc: Jonathan Corbet, Darrick J. Wong, Linux Kernel Mailing List,
Linux Documentation, Linux XFS, Linux Kernel Workflows,
Namjae Jeon, Dave Chinner, Steve French, Matthew Wilcox (Oracle),
Allison Henderson, Bjorn Helgaas, Charles Han, Vegard Nossum
On Sat, Dec 09, 2023 at 12:26:43 PM +0700, Bagas Sanjaya wrote:
> [[PGP Signed Part:No public key for F6B9894955514EA3 created at 2023-12-09T10:56:39+0530 using EDDSA]]
> On Wed, Nov 29, 2023 at 07:39:47PM +0700, Bagas Sanjaya wrote:
>> XFS docs are currently in upper-level Documentation/filesystems.
>> Although these are currently 4 docs, they are already outstanding as
>> a group and can be moved to its own subdirectory.
>>
>> Consolidate them into Documentation/filesystems/xfs/.
>>
>> Signed-off-by: Bagas Sanjaya <bagasdotme@gmail.com>
>
> Hi Jon, Chandan, and Darrick,
>
> FYI, XFS tree [1] is not updated since 2 weeks ago (and this patch doesn't get
> picked up). Would you like to route this patch through docs-next tree or
> xfs/for-next?
>
This patch is part of a collection of patches that I am planning to include in
the pull request for v6.8-rc1. I am currently running fstests to make sure
that there are no regressions.
--
Chandan
^ permalink raw reply [flat|nested] 6+ messages in thread
* Re: [PATCH v3] Documentation: xfs: consolidate XFS docs into its own subdirectory
2023-12-09 8:00 ` Chandan Babu R
@ 2023-12-09 8:17 ` Bagas Sanjaya
0 siblings, 0 replies; 6+ messages in thread
From: Bagas Sanjaya @ 2023-12-09 8:17 UTC (permalink / raw)
To: Chandan Babu R
Cc: Jonathan Corbet, Darrick J. Wong, Linux Kernel Mailing List,
Linux Documentation, Linux XFS, Linux Kernel Workflows,
Namjae Jeon, Dave Chinner, Steve French, Matthew Wilcox (Oracle),
Allison Henderson, Bjorn Helgaas, Charles Han, Vegard Nossum
On 12/9/23 15:00, Chandan Babu R wrote:
> On Sat, Dec 09, 2023 at 12:26:43 PM +0700, Bagas Sanjaya wrote:
>> [[PGP Signed Part:No public key for F6B9894955514EA3 created at 2023-12-09T10:56:39+0530 using EDDSA]]
>> On Wed, Nov 29, 2023 at 07:39:47PM +0700, Bagas Sanjaya wrote:
>>> XFS docs are currently in upper-level Documentation/filesystems.
>>> Although these are currently 4 docs, they are already outstanding as
>>> a group and can be moved to its own subdirectory.
>>>
>>> Consolidate them into Documentation/filesystems/xfs/.
>>>
>>> Signed-off-by: Bagas Sanjaya <bagasdotme@gmail.com>
>>
>> Hi Jon, Chandan, and Darrick,
>>
>> FYI, XFS tree [1] is not updated since 2 weeks ago (and this patch doesn't get
>> picked up). Would you like to route this patch through docs-next tree or
>> xfs/for-next?
>>
>
> This patch is part of a collection of patches that I am planning to include in
> the pull request for v6.8-rc1. I am currently running fstests to make sure
> that there are no regressions.
>
OK, thanks!
--
An old man doll... just what I always wanted! - Clara
^ permalink raw reply [flat|nested] 6+ messages in thread