[PATCH] Documentation: xfs: consolidate XFS docs into its own subdirectory

[PATCH] Documentation: xfs: consolidate XFS docs into its own subdirectory

[Bagas Sanjaya]

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>
---
 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           |  0
 .../{ => xfs}/xfs-self-describing-metadata.rst     |  0
 .../maintainer/maintainer-entry-profile.rst        |  2 +-
 7 files changed, 16 insertions(+), 5 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 (100%)
 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 100%
rename from Documentation/filesystems/xfs-online-fsck-design.rst
rename to Documentation/filesystems/xfs/xfs-online-fsck-design.rst
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

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

Re: [PATCH] Documentation: xfs: consolidate XFS docs into its own subdirectory

[Vegard Nossum]

On 21/11/2023 10:56, 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>
> ---
>   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           |  0
>   .../{ => xfs}/xfs-self-describing-metadata.rst     |  0
>   .../maintainer/maintainer-entry-profile.rst        |  2 +-
>   7 files changed, 16 insertions(+), 5 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 (100%)
>   rename Documentation/filesystems/{ => xfs}/xfs-self-describing-metadata.rst (100%)

I think you need to update MAINTAINERS as well.

A project-wide git grep for the document names should have turned it up.


Vegard

Re: [PATCH] Documentation: xfs: consolidate XFS docs into its own subdirectory

[Bagas Sanjaya]

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

On Tue, Nov 21, 2023 at 11:16:16AM +0100, Vegard Nossum wrote:
> 
> On 21/11/2023 10:56, 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>
> > ---
> >   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           |  0
> >   .../{ => xfs}/xfs-self-describing-metadata.rst     |  0
> >   .../maintainer/maintainer-entry-profile.rst        |  2 +-
> >   7 files changed, 16 insertions(+), 5 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 (100%)
> >   rename Documentation/filesystems/{ => xfs}/xfs-self-describing-metadata.rst (100%)
> 
> I think you need to update MAINTAINERS as well.
> 
> A project-wide git grep for the document names should have turned it up.

OK, will fix in v2.

Thanks for the suggestion.

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

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

Re: [PATCH] Documentation: xfs: consolidate XFS docs into its own subdirectory

[kernel test robot]

Hi Bagas,

kernel test robot noticed the following build warnings:

[auto build test WARNING on 98b1cc82c4affc16f5598d4fa14b1858671b2263]

url:    https://github.com/intel-lab-lkp/linux/commits/Bagas-Sanjaya/Documentation-xfs-consolidate-XFS-docs-into-its-own-subdirectory/20231121-180057
base:   98b1cc82c4affc16f5598d4fa14b1858671b2263
patch link:    https://lore.kernel.org/r/20231121095658.28254-1-bagasdotme%40gmail.com
patch subject: [PATCH] Documentation: xfs: consolidate XFS docs into its own subdirectory
reproduce: (https://download.01.org/0day-ci/archive/20231122/202311220333.acL7LwXY-lkp@intel.com/reproduce)

If you fix the issue in a separate patch/commit (i.e. not just a new version of
the same patch/commit), kindly add following tags
| Reported-by: kernel test robot <lkp@intel.com>
| Closes: https://lore.kernel.org/oe-kbuild-all/202311220333.acL7LwXY-lkp@intel.com/

All warnings (new ones prefixed by >>):

>> Warning: Documentation/filesystems/xfs/xfs-online-fsck-design.rst references a file that doesn't exist: Documentation/filesystems/xfs-self-describing-metadata.rst
>> Warning: MAINTAINERS references a file that doesn't exist: Documentation/filesystems/xfs-maintainer-entry-profile.rst
>> Warning: MAINTAINERS references a file that doesn't exist: Documentation/filesystems/xfs-*
>> MAINTAINERS:53207: WARNING: unknown document: ../filesystems/xfs-maintainer-entry-profile

-- 
0-DAY CI Kernel Test Service
https://github.com/intel/lkp-tests/wiki

Re: [PATCH] Documentation: xfs: consolidate XFS docs into its own subdirectory

[Bagas Sanjaya]

On 11/22/23 03:04, kernel test robot wrote:
> Hi Bagas,
> 
> kernel test robot noticed the following build warnings:
> 
> [auto build test WARNING on 98b1cc82c4affc16f5598d4fa14b1858671b2263]
> 
> url:    https://github.com/intel-lab-lkp/linux/commits/Bagas-Sanjaya/Documentation-xfs-consolidate-XFS-docs-into-its-own-subdirectory/20231121-180057
> base:   98b1cc82c4affc16f5598d4fa14b1858671b2263
> patch link:    https://lore.kernel.org/r/20231121095658.28254-1-bagasdotme%40gmail.com
> patch subject: [PATCH] Documentation: xfs: consolidate XFS docs into its own subdirectory
> reproduce: (https://download.01.org/0day-ci/archive/20231122/202311220333.acL7LwXY-lkp@intel.com/reproduce)
> 
> If you fix the issue in a separate patch/commit (i.e. not just a new version of
> the same patch/commit), kindly add following tags
> | Reported-by: kernel test robot <lkp@intel.com>
> | Closes: https://lore.kernel.org/oe-kbuild-all/202311220333.acL7LwXY-lkp@intel.com/
> 
> All warnings (new ones prefixed by >>):
> 
>>> Warning: Documentation/filesystems/xfs/xfs-online-fsck-design.rst references a file that doesn't exist: Documentation/filesystems/xfs-self-describing-metadata.rst
>>> Warning: MAINTAINERS references a file that doesn't exist: Documentation/filesystems/xfs-maintainer-entry-profile.rst
>>> Warning: MAINTAINERS references a file that doesn't exist: Documentation/filesystems/xfs-*
>>> MAINTAINERS:53207: WARNING: unknown document: ../filesystems/xfs-maintainer-entry-profile
> 

Oh dear, I didn't catch them when building locally. Will fix anyway.

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