doc: Fix a Sphinx warning&error and use labels for links in 4 files

Fix Sphinx warning about missing empty line after a label in
cephfs/ceph-dokan.rst.

Fix Sphinx error about invalid indentation in releases/squid.rst.

Fix Sphinx warning about invalid bash prompt block in
dev/crimson/crimson.rst.
Also fix warnings about too short section title text underline and fix
an incorrect link name (and use "above" instead of "below").

Fix Sphinx warning about missing strong emphasis closure, put the
problematic star inside inline preformatted/code in dev/blkin.rst.

Fix Sphinx warning about explicit markup, add the required empty line in
cephfs/mds-config-ref.rst.

Fix Sphinx error about invalid table in radosgw/s3/bucketops.rst.

Use the label at the beginning of the document in cephfs/ceph-dokan.rst
for hyperlinking with :ref: instead of using "external links" feature
from cephfs/createfs.rst cephfs/mount-prerequisites.rst
install/windows-install.rst.

Also use existing label in cephfs/mount-using-kernel-driver.rst
similarly from cephfs/createfs.rst cephfs/mount-prerequisites.rst.

Also use existing label in man/8/cephfs-shell.rst similarly from
cephfs/index.rst.

Add a label in cephfs/mount-using-fuse.rst and use it from
cephfs/createfs.rst cephfs/mount-prerequisites.rst.

Remove space at the end of line in cephfs/createfs.rst
cephfs/mount-prerequisites.rst cephfs/mount-using-fuse.rst
cephfs/cephfs-fuse.rst cephfs/index.rst.

Signed-off-by: Ville Ojamo <14869000+bluikko@users.noreply.github.com>

diff --git a/doc/cephfs/ceph-dokan.rst b/doc/cephfs/ceph-dokan.rst
index f3739bfc177e28be1ea3a9d3ab923577728af3cb..3d8eafde5f277e98a5e300a9971de42dffdd72ef 100644 (file)
--- a/doc/cephfs/ceph-dokan.rst
+++ b/doc/cephfs/ceph-dokan.rst
@@ -1,4 +1,5 @@
 .. _ceph-dokan:
+
 =======================
 Mount CephFS on Windows
 =======================

diff --git a/doc/cephfs/createfs.rst b/doc/cephfs/createfs.rst
index 1054d3f1c279872484507b61df66491de7da9b73..b61a62227848d87b2ee8626de55c3d9fe050cc61 100644 (file)
--- a/doc/cephfs/createfs.rst
+++ b/doc/cephfs/createfs.rst
@@ -108,19 +108,15 @@ Once the file system is created and the MDS is active, you are ready to mount
 the file system.  If you have created more than one file system, you will
 choose which to use when mounting.
 
-  - `Mount CephFS`_
-  - `Mount CephFS as FUSE`_
-  - `Mount CephFS on Windows`_
-
-.. _Mount CephFS: ../../cephfs/mount-using-kernel-driver
-.. _Mount CephFS as FUSE: ../../cephfs/mount-using-fuse
-.. _Mount CephFS on Windows: ../../cephfs/ceph-dokan
+  - :ref:`cephfs_mount_using_kernel_driver`
+  - :ref:`cephfs_mount_using_fuse`
+  - :ref:`ceph-dokan`
 
 If you have created more than one file system, and a client does not
 specify a file system when mounting, you can control which file system
 they will see by using the ``ceph fs set-default`` command.
 
-Adding a Data Pool to the File System 
+Adding a Data Pool to the File System
 -------------------------------------
 
 See :ref:`adding-data-pool-to-file-system`.
@@ -134,7 +130,7 @@ You may use Erasure Coded pools as CephFS data pools as long as they have overwr
 .. code:: bash
 
     ceph osd pool set my_ec_pool allow_ec_overwrites true
-    
+
 Note that EC overwrites are only supported when using OSDs with the BlueStore backend.
 
 If you are storing lots of small files or are frequently modifying files you can improve performance by enabling EC optimizations, which is done as follows:

diff --git a/doc/cephfs/index.rst b/doc/cephfs/index.rst
index a1ec0533188d5f7884d0a17c5e9b3f0a65b448f4..fb32ebedffb7f8bea09e8988b007a3de258b1c83 100644 (file)
--- a/doc/cephfs/index.rst
+++ b/doc/cephfs/index.rst
@@ -51,14 +51,13 @@ as needed`_. You can also `create other CephFS volumes`_.
 
 Finally, to mount CephFS on your client nodes, see `Mount CephFS:
 Prerequisites`_ page. Additionally, a command-line shell utility is available
-for interactive access or scripting via the `cephfs-shell`_.
+for interactive access or scripting via the :ref:`cephfs-shell <cephfs-shell>`.
 
 .. _Orchestrator: ../mgr/orchestrator
 .. _deploy MDS manually as needed: add-remove-mds
 .. _create other CephFS volumes: fs-volumes
 .. _Orchestrator deployment table: ../mgr/orchestrator/#current-implementation-status
 .. _Mount CephFS\: Prerequisites: mount-prerequisites
-.. _cephfs-shell: ../man/8/cephfs-shell
 
 
 .. raw:: html
@@ -72,7 +71,7 @@ Administration
 
    --->
 
-.. toctree:: 
+.. toctree::
    :maxdepth: 1
    :hidden:
 
@@ -106,7 +105,7 @@ Mounting CephFS
 
    --->
 
-.. toctree:: 
+.. toctree::
    :maxdepth: 1
    :hidden:
 
@@ -134,7 +133,7 @@ CephFS Concepts
 
    --->
 
-.. toctree:: 
+.. toctree::
    :maxdepth: 1
    :hidden:
 
@@ -163,7 +162,7 @@ Troubleshooting and Disaster Recovery
 
    --->
 
-.. toctree:: 
+.. toctree::
    :hidden:
 
     Client eviction <eviction>
@@ -187,7 +186,7 @@ Developer Guides
 
    --->
 
-.. toctree:: 
+.. toctree::
    :maxdepth: 1
    :hidden:
 

diff --git a/doc/cephfs/mds-config-ref.rst b/doc/cephfs/mds-config-ref.rst
index f0fd891d7bf792fdfaa28344119793075401e4dd..8e759f7e53f594afb36872aeaa2cb1a27bc4bb66 100644 (file)
--- a/doc/cephfs/mds-config-ref.rst
+++ b/doc/cephfs/mds-config-ref.rst
@@ -1,4 +1,5 @@
 .. _MDS Config Reference:
+
 ======================
  MDS Config Reference
 ======================

diff --git a/doc/cephfs/mount-prerequisites.rst b/doc/cephfs/mount-prerequisites.rst
index 02b22fb9ac6a4e535d1fae1696113ac8299ee210..2decb15bc6f0b5d940e380a17eba6ceaa23e9d3f 100644 (file)
--- a/doc/cephfs/mount-prerequisites.rst
+++ b/doc/cephfs/mount-prerequisites.rst
@@ -2,12 +2,14 @@ Mount CephFS: Prerequisites
 ===========================
 
 You can use CephFS by mounting the file system on a machine or by using
-:ref:`cephfs-shell <cephfs-shell>`. A system mount can be performed using `the
-kernel driver`_ as well as `the FUSE driver`_. Both have their own advantages
-and disadvantages. Read the following section to understand more about both of
-these ways to mount CephFS.
+:ref:`cephfs-shell <cephfs-shell>`. A system mount can be performed using
+:ref:`the kernel driver <cephfs_mount_using_kernel_driver>` as well as
+:ref:`the FUSE driver <cephfs_mount_using_fuse>`. Both have their own
+advantages and disadvantages. 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.
+For Windows CephFS mounts, please check the :ref:`ceph-dokan <ceph-dokan>`
+page.
 
 Which CephFS Client?
 --------------------
@@ -68,7 +70,3 @@ Ceph MON resides.
    individually, please check respective mount documents.
 
 .. _Client Authentication: ../client-auth
-.. _cephfs-shell: ..cephfs-shell
-.. _the kernel driver: ../mount-using-kernel-driver
-.. _the FUSE driver: ../mount-using-fuse
-.. _ceph-dokan: ../ceph-dokan

diff --git a/doc/cephfs/mount-using-fuse.rst b/doc/cephfs/mount-using-fuse.rst
index adea645ff55e41e3ced048e7398ecfcbce2b473b..e8929a6a8b7f6799bde2b30d7fada5e409162fcb 100644 (file)
--- a/doc/cephfs/mount-using-fuse.rst
+++ b/doc/cephfs/mount-using-fuse.rst
@@ -5,7 +5,7 @@
 ========================
 
 `ceph-fuse`_ can be used as an alternative to the :ref:`CephFS kernel
-driver<cephfs-mount-using-kernel-driver>` to mount CephFS file systems.
+driver<cephfs_mount_using_kernel_driver>` to mount CephFS file systems.
 `ceph-fuse`_ mounts are made in userspace. This means that `ceph-fuse`_ mounts
 are less performant than kernel driver mounts, but they are easier to manage
 and easier to upgrade.
@@ -25,7 +25,7 @@ mounts, as listed on the `Mount CephFS: Prerequisites`_ page.
 
 Synopsis
 ========
-This is the general form of the command for mounting CephFS via FUSE: 
+This is the general form of the command for mounting CephFS via FUSE:
 
 .. prompt:: bash #
 

diff --git a/doc/cephfs/mount-using-kernel-driver.rst b/doc/cephfs/mount-using-kernel-driver.rst
index b9fcd37910c0a241a7a625d0f1f2014371aaebd7..f5847046bb301a1241fb8a7adcd11e6fca96391b 100644 (file)
--- a/doc/cephfs/mount-using-kernel-driver.rst
+++ b/doc/cephfs/mount-using-kernel-driver.rst
@@ -1,4 +1,4 @@
-.. _cephfs-mount-using-kernel-driver:
+.. _cephfs_mount_using_kernel_driver:
 
 =================================
  Mount CephFS using Kernel Driver

diff --git a/doc/dev/blkin.rst b/doc/dev/blkin.rst
index 5cd88f3251f6f69e415797865654ebdfe8cc0e2e..8789ec6cf74f9fa831b9ccdb61135ab1684eea2a 100644 (file)
--- a/doc/dev/blkin.rst
+++ b/doc/dev/blkin.rst
@@ -9,7 +9,7 @@ if you compile code, please use -DWITH_LTTNG option (default: ON)::
 
   ./do_cmake -DWITH_LTTNG=ON
 
-If your Ceph deployment is package-based (YUM, DNF, APT) vs containerized, install the required software packages according to the module which you want to track， otherwise, it may cause a coredump due to missing *tp.solibrary files::
+If your Ceph deployment is package-based (YUM, DNF, APT) vs containerized, install the required software packages according to the module which you want to track， otherwise, it may cause a coredump due to missing ``*tp.solibrary`` files::
 
   librbd-devel    
   librgw-devel    

diff --git a/doc/dev/crimson/crimson.rst b/doc/dev/crimson/crimson.rst
index 1b95c35c8b02b38883660b5119490b38d364228d..e6208e3eccd68a698767e2a1a1c12b2120f21d84 100644 (file)
--- a/doc/dev/crimson/crimson.rst
+++ b/doc/dev/crimson/crimson.rst
@@ -79,7 +79,7 @@ number of CPU cores (``nproc``) divided by the **number of OSDs on that host**.
 
 For example, for deploying a node with eight CPU cores per OSD:
 
-.. code-block:: bash #
+.. prompt:: bash #
 
    ceph config set osd crimson_cpu_num 8
 
@@ -137,7 +137,7 @@ Native backends perform I/O operations using the **Seastar reactor**. These are
    CyanStore **does not store data** and should be used only for measuring OSD overhead, without the cost of actually storing data.
 
 Non-Native Backends
-------------------
+-------------------
 
 Non-native backends operate through a **thread pool proxy**, which interfaces with object stores running in **alien threads**—worker threads not managed by Seastar.
 These backends allow Crimson to interact with legacy or external object store implementations:
@@ -187,7 +187,7 @@ The following options can be used with ``vstart.sh``.
     (as determined by `nproc`) will be assigned to the object store.
 
 ``--bluestore``
-    Use the alienized BlueStore as the object store backend. This is the default (see below section on the `object store backend`_ for more details)
+    Use the alienized BlueStore as the object store backend. This is the default (see above section on the `object store backends`_ for more details)
 
 ``--cyanstore``
     Use CyanStore as the object store backend.

diff --git a/doc/install/windows-install.rst b/doc/install/windows-install.rst
index 0768a36a6305a6d018ead61422fb6b7102cc22e6..7789d96622034346a5c0cef06e51eb0025e1bef8 100644 (file)
--- a/doc/install/windows-install.rst
+++ b/doc/install/windows-install.rst
@@ -79,10 +79,9 @@ Further reading
 ===============
 
 * `RBD Windows documentation`_
-* `CephFS Windows documentation`_
+* :ref:`CephFS Windows documentation <ceph-dokan>`
 * `Windows troubleshooting`_
 
-.. _CephFS Windows documentation: ../../cephfs/ceph-dokan
 .. _Windows configuration sample: ../windows-basic-config
 .. _RBD Windows documentation: ../../rbd/rbd-windows/
 .. _Windows troubleshooting: ../windows-troubleshooting

diff --git a/doc/man/8/ceph-fuse.rst b/doc/man/8/ceph-fuse.rst
index cccca87fa730e632ab3b5b4f411ba4de2c4924f0..93841f459845c663b95fbd769622b71f421548c6 100644 (file)
--- a/doc/man/8/ceph-fuse.rst
+++ b/doc/man/8/ceph-fuse.rst
@@ -1,6 +1,6 @@
 :orphan:
 
-.. _man-ceph-fuse: 
+.. _man-ceph-fuse:
 
 =========================================
  ceph-fuse -- FUSE-based client for ceph

diff --git a/doc/radosgw/s3/bucketops.rst b/doc/radosgw/s3/bucketops.rst
index 3d5b3f70ee483e091beef06a0b4c094916907f82..8daefe7bd8e1fc8ee74c5489511a100ec522c031 100644 (file)
--- a/doc/radosgw/s3/bucketops.rst
+++ b/doc/radosgw/s3/bucketops.rst
@@ -793,7 +793,7 @@ Parameters are XML encoded in the body of the request, in the following format:
 |                               |           | between different source buckets writing log records to the same log bucket.         |          |
 +-------------------------------+-----------+--------------------------------------------------------------------------------------+----------+
 | ``LoggingType``               | String    | The type of logging. Valid values are:                                               | No       |
-|                               |           | ``Standard`` (default) all bucket operations are logged after being performed.        |          |
+|                               |           | ``Standard`` (default) all bucket operations are logged after being performed.       |          |
 |                               |           | The log record will contain all fields.                                              |          |
 |                               |           | ``Journal`` only operations that modify and object are logged.                       |          |
 |                               |           | Will record the minimum subset of fields in the log record that is needed            |          |

diff --git a/doc/releases/squid.rst b/doc/releases/squid.rst
index 60df2dff8b275f598b078c3fac6302e0f4e5f0cd..a52aa9f7447d4ebd18d311cf2cdb5f08b7ed7656 100644 (file)
--- a/doc/releases/squid.rst
+++ b/doc/releases/squid.rst
@@ -20,6 +20,7 @@ Notable Changes
 
    - https://tracker.ceph.com/issues/67179
    - https://tracker.ceph.com/issues/66867
+
 * RBD: Moving an image that is a member of a group to trash is no longer
   allowed.  `rbd trash mv` command now behaves the same way as `rbd rm` in this
   scenario.