Skip to content

Commit 166abb6

Browse files
committed
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 <[email protected]>
1 parent fa93d68 commit 166abb6

File tree

13 files changed

+31
-36
lines changed

13 files changed

+31
-36
lines changed

doc/cephfs/ceph-dokan.rst

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,5 @@
11
.. _ceph-dokan:
2+
23
=======================
34
Mount CephFS on Windows
45
=======================

doc/cephfs/createfs.rst

Lines changed: 5 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -108,19 +108,15 @@ Once the file system is created and the MDS is active, you are ready to mount
108108
the file system. If you have created more than one file system, you will
109109
choose which to use when mounting.
110110

111-
- `Mount CephFS`_
112-
- `Mount CephFS as FUSE`_
113-
- `Mount CephFS on Windows`_
114-
115-
.. _Mount CephFS: ../../cephfs/mount-using-kernel-driver
116-
.. _Mount CephFS as FUSE: ../../cephfs/mount-using-fuse
117-
.. _Mount CephFS on Windows: ../../cephfs/ceph-dokan
111+
- :ref:`cephfs_mount_using_kernel_driver`
112+
- :ref:`cephfs_mount_using_fuse`
113+
- :ref:`ceph-dokan`
118114

119115
If you have created more than one file system, and a client does not
120116
specify a file system when mounting, you can control which file system
121117
they will see by using the ``ceph fs set-default`` command.
122118

123-
Adding a Data Pool to the File System
119+
Adding a Data Pool to the File System
124120
-------------------------------------
125121

126122
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
134130
.. code:: bash
135131
136132
ceph osd pool set my_ec_pool allow_ec_overwrites true
137-
133+
138134
Note that EC overwrites are only supported when using OSDs with the BlueStore backend.
139135

140136
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:

doc/cephfs/index.rst

Lines changed: 6 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -51,14 +51,13 @@ as needed`_. You can also `create other CephFS volumes`_.
5151

5252
Finally, to mount CephFS on your client nodes, see `Mount CephFS:
5353
Prerequisites`_ page. Additionally, a command-line shell utility is available
54-
for interactive access or scripting via the `cephfs-shell`_.
54+
for interactive access or scripting via the :ref:`cephfs-shell <cephfs-shell>`.
5555

5656
.. _Orchestrator: ../mgr/orchestrator
5757
.. _deploy MDS manually as needed: add-remove-mds
5858
.. _create other CephFS volumes: fs-volumes
5959
.. _Orchestrator deployment table: ../mgr/orchestrator/#current-implementation-status
6060
.. _Mount CephFS\: Prerequisites: mount-prerequisites
61-
.. _cephfs-shell: ../man/8/cephfs-shell
6261

6362

6463
.. raw:: html
@@ -72,7 +71,7 @@ Administration
7271
7372
--->
7473

75-
.. toctree::
74+
.. toctree::
7675
:maxdepth: 1
7776
:hidden:
7877

@@ -106,7 +105,7 @@ Mounting CephFS
106105
107106
--->
108107

109-
.. toctree::
108+
.. toctree::
110109
:maxdepth: 1
111110
:hidden:
112111

@@ -134,7 +133,7 @@ CephFS Concepts
134133
135134
--->
136135

137-
.. toctree::
136+
.. toctree::
138137
:maxdepth: 1
139138
:hidden:
140139

@@ -163,7 +162,7 @@ Troubleshooting and Disaster Recovery
163162
164163
--->
165164

166-
.. toctree::
165+
.. toctree::
167166
:hidden:
168167

169168
Client eviction <eviction>
@@ -187,7 +186,7 @@ Developer Guides
187186
188187
--->
189188

190-
.. toctree::
189+
.. toctree::
191190
:maxdepth: 1
192191
:hidden:
193192

doc/cephfs/mds-config-ref.rst

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,5 @@
11
.. _MDS Config Reference:
2+
23
======================
34
MDS Config Reference
45
======================

doc/cephfs/mount-prerequisites.rst

Lines changed: 7 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -2,12 +2,14 @@ Mount CephFS: Prerequisites
22
===========================
33

44
You can use CephFS by mounting the file system on a machine or by using
5-
:ref:`cephfs-shell <cephfs-shell>`. A system mount can be performed using `the
6-
kernel driver`_ as well as `the FUSE driver`_. Both have their own advantages
7-
and disadvantages. Read the following section to understand more about both of
8-
these ways to mount CephFS.
5+
:ref:`cephfs-shell <cephfs-shell>`. A system mount can be performed using
6+
:ref:`the kernel driver <cephfs_mount_using_kernel_driver>` as well as
7+
:ref:`the FUSE driver <cephfs_mount_using_fuse>`. Both have their own
8+
advantages and disadvantages. Read the following section to understand
9+
more about both of these ways to mount CephFS.
910

10-
For Windows CephFS mounts, please check the `ceph-dokan`_ page.
11+
For Windows CephFS mounts, please check the :ref:`ceph-dokan <ceph-dokan>`
12+
page.
1113

1214
Which CephFS Client?
1315
--------------------
@@ -68,7 +70,3 @@ Ceph MON resides.
6870
individually, please check respective mount documents.
6971

7072
.. _Client Authentication: ../client-auth
71-
.. _cephfs-shell: ..cephfs-shell
72-
.. _the kernel driver: ../mount-using-kernel-driver
73-
.. _the FUSE driver: ../mount-using-fuse
74-
.. _ceph-dokan: ../ceph-dokan

doc/cephfs/mount-using-fuse.rst

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@
55
========================
66

77
`ceph-fuse`_ can be used as an alternative to the :ref:`CephFS kernel
8-
driver<cephfs-mount-using-kernel-driver>` to mount CephFS file systems.
8+
driver<cephfs_mount_using_kernel_driver>` to mount CephFS file systems.
99
`ceph-fuse`_ mounts are made in userspace. This means that `ceph-fuse`_ mounts
1010
are less performant than kernel driver mounts, but they are easier to manage
1111
and easier to upgrade.
@@ -25,7 +25,7 @@ mounts, as listed on the `Mount CephFS: Prerequisites`_ page.
2525

2626
Synopsis
2727
========
28-
This is the general form of the command for mounting CephFS via FUSE:
28+
This is the general form of the command for mounting CephFS via FUSE:
2929

3030
.. prompt:: bash #
3131

doc/cephfs/mount-using-kernel-driver.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
.. _cephfs-mount-using-kernel-driver:
1+
.. _cephfs_mount_using_kernel_driver:
22

33
=================================
44
Mount CephFS using Kernel Driver

doc/dev/blkin.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@ if you compile code, please use -DWITH_LTTNG option (default: ON)::
99

1010
./do_cmake -DWITH_LTTNG=ON
1111

12-
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::
12+
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::
1313

1414
librbd-devel
1515
librgw-devel

doc/dev/crimson/crimson.rst

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -79,7 +79,7 @@ number of CPU cores (``nproc``) divided by the **number of OSDs on that host**.
7979

8080
For example, for deploying a node with eight CPU cores per OSD:
8181

82-
.. code-block:: bash #
82+
.. prompt:: bash #
8383

8484
ceph config set osd crimson_cpu_num 8
8585

@@ -137,7 +137,7 @@ Native backends perform I/O operations using the **Seastar reactor**. These are
137137
CyanStore **does not store data** and should be used only for measuring OSD overhead, without the cost of actually storing data.
138138

139139
Non-Native Backends
140-
------------------
140+
-------------------
141141

142142
Non-native backends operate through a **thread pool proxy**, which interfaces with object stores running in **alien threads**—worker threads not managed by Seastar.
143143
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``.
187187
(as determined by `nproc`) will be assigned to the object store.
188188

189189
``--bluestore``
190-
Use the alienized BlueStore as the object store backend. This is the default (see below section on the `object store backend`_ for more details)
190+
Use the alienized BlueStore as the object store backend. This is the default (see above section on the `object store backends`_ for more details)
191191

192192
``--cyanstore``
193193
Use CyanStore as the object store backend.

doc/install/windows-install.rst

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -79,10 +79,9 @@ Further reading
7979
===============
8080

8181
* `RBD Windows documentation`_
82-
* `CephFS Windows documentation`_
82+
* :ref:`CephFS Windows documentation <ceph-dokan>`
8383
* `Windows troubleshooting`_
8484

85-
.. _CephFS Windows documentation: ../../cephfs/ceph-dokan
8685
.. _Windows configuration sample: ../windows-basic-config
8786
.. _RBD Windows documentation: ../../rbd/rbd-windows/
8887
.. _Windows troubleshooting: ../windows-troubleshooting

0 commit comments

Comments
 (0)