Skip to content

Commit d1bbcdf

Browse files
bluikkozdover23
authored andcommitted
doc: Fix missing blank line Sphinx warnings
Fix four warnings from Sphinx about missing blank line after explicit markup. Indent content in list items correctly, fixing formatting errors. Signed-off-by: Ville Ojamo <[email protected]> (cherry picked from commit 5e1b3cd)
1 parent 77a7c83 commit d1bbcdf

File tree

2 files changed

+23
-19
lines changed

2 files changed

+23
-19
lines changed

doc/cephfs/troubleshooting.rst

Lines changed: 20 additions & 19 deletions
Original file line numberDiff line numberDiff line change
@@ -81,13 +81,13 @@ things to do:
8181
* **Deny all reconnect to clients.** This effectively blocklists all existing
8282
CephFS sessions so all mounts will hang or become unavailable.
8383

84-
.. code:: bash
84+
.. code:: bash
8585
86-
ceph config set mds mds_deny_all_reconnect true
86+
ceph config set mds mds_deny_all_reconnect true
8787
8888
Remember to undo this after the MDS becomes active.
8989

90-
.. note:: This does not prevent new sessions from connecting. For that, see the ``refuse_client_session`` file system setting.
90+
.. note:: This does not prevent new sessions from connecting. For that, see the ``refuse_client_session`` file system setting.
9191

9292
* **Extend the MDS heartbeat grace period**. This avoids replacing an MDS that appears
9393
"stuck" doing some operation. Sometimes recovery of an MDS may involve an
@@ -96,23 +96,23 @@ things to do:
9696
normal amount of time to complete (indicated by your reading this document).
9797
Avoid unnecessary replacement loops by extending the heartbeat graceperiod:
9898

99-
.. code:: bash
99+
.. code:: bash
100100
101-
ceph config set mds mds_heartbeat_grace 3600
101+
ceph config set mds mds_heartbeat_grace 3600
102102
103-
.. note:: This has the effect of having the MDS continue to send beacons to the monitors
104-
even when its internal "heartbeat" mechanism has not been reset (beat) in one
105-
hour. The previous mechanism for achieving this was via the
106-
`mds_beacon_grace` monitor setting.
103+
.. note:: This has the effect of having the MDS continue to send beacons to the monitors
104+
even when its internal "heartbeat" mechanism has not been reset (beat) in one
105+
hour. The previous mechanism for achieving this was via the
106+
`mds_beacon_grace` monitor setting.
107107

108108
* **Disable open file table prefetch.** Normally, the MDS will prefetch
109109
directory contents during recovery to heat up its cache. During long
110110
recovery, the cache is probably already hot **and large**. So this behavior
111111
can be undesirable. Disable using:
112112

113-
.. code:: bash
113+
.. code:: bash
114114
115-
ceph config set mds mds_oft_prefetch_dirfrags false
115+
ceph config set mds mds_oft_prefetch_dirfrags false
116116
117117
* **Turn off clients.** Clients reconnecting to the newly ``up:active`` MDS may
118118
cause new load on the file system when it's just getting back on its feet.
@@ -122,9 +122,9 @@ things to do:
122122

123123
You can do this manually or use the new file system tunable:
124124

125-
.. code:: bash
125+
.. code:: bash
126126
127-
ceph fs set <fs_name> refuse_client_session true
127+
ceph fs set <fs_name> refuse_client_session true
128128
129129
That prevents any clients from establishing new sessions with the MDS.
130130

@@ -139,26 +139,27 @@ things to do:
139139
asynchronously purging trashed/deleted subvolumes. To help troubleshooting or
140140
recovery effort, these purge threads can be disabled using:
141141

142-
.. code:: bash
142+
.. code:: bash
143143
144-
ceph config set mgr mgr/volumes/pause_purging true
144+
ceph config set mgr mgr/volumes/pause_purging true
145145
146146
To resume purging run::
147147

148-
ceph config set mgr mgr/volumes/pause_purging false
148+
ceph config set mgr mgr/volumes/pause_purging false
149149

150150
.. _pause-clone-threads:
151+
151152
* **Turn off async cloner threads** The volumes plugin spawns threads for
152153
asynchronously cloning subvolume snapshots. To help troubleshooting or
153154
recovery effort, these cloner threads can be disabled using:
154155

155-
.. code:: bash
156+
.. code:: bash
156157
157-
ceph config set mgr mgr/volumes/pause_cloning true
158+
ceph config set mgr mgr/volumes/pause_cloning true
158159
159160
To resume cloning run::
160161

161-
ceph config set mgr mgr/volumes/pause_cloning false
162+
ceph config set mgr mgr/volumes/pause_cloning false
162163

163164

164165

doc/dev/cephfs-mirroring.rst

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -207,6 +207,7 @@ mirroring module. This means that ``/a/b/../b`` is equivalent to ``/a/b``:
207207
mkdir -p /d0/d1/d2
208208
ceph fs snapshot mirror add cephfs /d0/d1/d2 {}
209209
ceph fs snapshot mirror add cephfs /d0/d1/../d1/d2
210+
210211
::
211212

212213
Error EEXIST: directory /d0/d1/d2 is already tracked
@@ -217,13 +218,15 @@ directories are not allowed to be added for mirroring:
217218
.. prompt:: bash $
218219

219220
ceph fs snapshot mirror add cephfs /d0/d1
221+
220222
::
221223

222224
Error EINVAL: /d0/d1 is a ancestor of tracked path /d0/d1/d2
223225

224226
.. prompt:: bash $
225227

226228
ceph fs snapshot mirror add cephfs /d0/d1/d2/d3
229+
227230
::
228231

229232
Error EINVAL: /d0/d1/d2/d3 is a subtree of tracked path /d0/d1/d2

0 commit comments

Comments
 (0)