]> git.ipfire.org Git - thirdparty/linux.git/commitdiff
Documentation: xfs: consolidate XFS docs into its own subdirectory
authorBagas Sanjaya <bagasdotme@gmail.com>
Wed, 29 Nov 2023 12:39:47 +0000 (19:39 +0700)
committerChandan Babu R <chandanbabu@kernel.org>
Thu, 7 Dec 2023 09:19:13 +0000 (14:49 +0530)
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>
Reviewed-by: Bill O'Donnell <bodonnel@redhat.com>
Reviewed-by: "Darrick J. Wong" <djwong@kernel.org>
Signed-off-by: Chandan Babu R <chandanbabu@kernel.org>
Documentation/filesystems/index.rst
Documentation/filesystems/xfs/index.rst [new file with mode: 0644]
Documentation/filesystems/xfs/xfs-delayed-logging-design.rst [moved from Documentation/filesystems/xfs-delayed-logging-design.rst with 100% similarity]
Documentation/filesystems/xfs/xfs-maintainer-entry-profile.rst [moved from Documentation/filesystems/xfs-maintainer-entry-profile.rst with 100% similarity]
Documentation/filesystems/xfs/xfs-online-fsck-design.rst [moved from Documentation/filesystems/xfs-online-fsck-design.rst with 99% similarity]
Documentation/filesystems/xfs/xfs-self-describing-metadata.rst [moved from Documentation/filesystems/xfs-self-describing-metadata.rst with 100% similarity]
Documentation/maintainer/maintainer-entry-profile.rst
MAINTAINERS

index 09cade7eaefc8c68e4e733ea011b345a4ce9fc9b..e18bc5ae3b35f89ecc61fc6266d5151c53dbd34d 100644 (file)
@@ -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 (file)
index 0000000..ab66c57
--- /dev/null
@@ -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
similarity index 99%
rename from Documentation/filesystems/xfs-online-fsck-design.rst
rename to Documentation/filesystems/xfs/xfs-online-fsck-design.rst
index a0678101a7d02d1000159bf9ffcd9d0e5c0d78b0..352516feef6ffe2880d3c0e92e3e2dce79d502d2 100644 (file)
@@ -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
 ---------------
index 7ad4bfc2cc038a8123d080a499417036dfa981f4..18cee1edaecb6fd5ba9dfd1d0c55399f4570f526 100644 (file)
@@ -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
index 788be9ab5b733a151bbd1ef85fe07414f374016c..76896b511c6ad2f5f220230b3342bf67d550033e 100644 (file)
@@ -23894,10 +23894,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