]> git.apps.os.sepia.ceph.com Git - ceph.git/commitdiff
doc/cephfs: update cephfs-shell link 58370/head
authorZac Dover <zac.dover@proton.me>
Mon, 1 Jul 2024 05:57:40 +0000 (15:57 +1000)
committerZac Dover <zac.dover@proton.me>
Mon, 1 Jul 2024 11:13:58 +0000 (21:13 +1000)
Repair the link to cephfs-shell.rst in doc/cephfs/cephfs-shell.rst that
was broken in https://github.com/ceph/ceph/pull/41165/ when
doc/cephfs/cephfs-shell.rst was moved to doc/man/8/cephfs-shell.rst.

This commit is made in response to a request by Lander Duncan that was
made on the [ceph-users] mailing list, and can be seen here: https://lists.ceph.io/hyperkitty/list/ceph-users@ceph.io/thread/F7V4CWLIYCAJ4JXI2JLNY6QPCFPR4SLA/

Signed-off-by: Zac Dover <zac.dover@proton.me>
(cherry picked from commit 4f8903cf80a94596a1b17b4a07affb874f21ae76)

doc/cephfs/mount-prerequisites.rst
doc/man/8/cephfs-shell.rst

index 6ed8a19b620584e7f4fee608158adf70694e00bf..d1acbe081fa4dd690f8636b98c0b2163c98b75f9 100644 (file)
@@ -2,11 +2,11 @@ Mount CephFS: Prerequisites
 ===========================
 
 You can use CephFS by mounting it to your local filesystem or by using
-`cephfs-shell`_. Mounting CephFS requires superuser privileges to trim
-dentries by issuing a remount of itself. CephFS can be mounted
-`using kernel`_ as well as `using FUSE`_. Both have their own
-advantages. Read the following section to understand more about both of
-these ways to mount CephFS.
+:ref:`cephfs-shell <cephfs-shell>`. Mounting CephFS requires superuser
+privileges to trim dentries by issuing a remount of itself. CephFS can be
+mounted `using kernel`_ as well as `using FUSE`_. Both have their own
+advantages. Read the following section to understand more about both of these
+ways to mount CephFS.
 
 For Windows CephFS mounts, please check the `ceph-dokan`_ page.
 
@@ -69,7 +69,7 @@ Ceph MON resides.
    individually, please check respective mount documents.
 
 .. _Client Authentication: ../client-auth
-.. _cephfs-shell: ../cephfs-shell
+.. _cephfs-shell: ..cephfs-shell
 .. _using kernel: ../mount-using-kernel-driver
 .. _using FUSE: ../mount-using-fuse
 .. _ceph-dokan: ../ceph-dokan
index 974ba37d91109e516f7509df0ddb15e92cd1cb56..47947022bb533ce48ab964767d2a4a8b76d02695 100644 (file)
@@ -1,5 +1,7 @@
 :orphan:
 
+.. _cephfs-shell:
+
 ===================================================
 cephfs-shell -- Shell-like tool talking with CephFS
 ===================================================