Skip to content

Commit 6a5d721

Browse files
committed
doc/cephfs: Typos and small improvements in scrub.rst
Don't use space in "subdirectory" or "kick-start". Change command syntax introduction text to the common "To ..., run a command of the following form:" when the syntax has placeholders. Use double backticks consistently (same as sections in the beginning) for CLI commands, parameters etc. Linkify "cluster health warnings" to the CephFS health warnings doc. Use admonition and fix a typo in article. Use title case for section titles and trim overly long underline. Minor improvements to language. Don't use unordered lists in two cases when there's no real need, especially when there is only a single item in the latter case. Signed-off-by: Ville Ojamo <[email protected]>
1 parent 4807e02 commit 6a5d721

File tree

1 file changed

+18
-17
lines changed

1 file changed

+18
-17
lines changed

doc/cephfs/scrub.rst

Lines changed: 18 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@ CephFS provides the cluster admin (operator) to check consistency of a file syst
88
via a set of scrub commands. Scrub can be classified into two parts:
99

1010
#. Forward Scrub: In which the scrub operation starts at the root of the file system
11-
(or a sub directory) and looks at everything that can be touched in the hierarchy
11+
(or a subdirectory) and looks at everything that can be touched in the hierarchy
1212
to ensure consistency.
1313

1414
#. Backward Scrub: In which the scrub operation looks at every RADOS object in the
@@ -25,7 +25,7 @@ scrub thereafter).
2525
Initiate File System Scrub
2626
==========================
2727

28-
To start a scrub operation for a directory tree use the following command::
28+
To start a scrub operation for a directory tree, run a command of the following form::
2929

3030
ceph tell mds.<fsname>:0 scrub start <path> [scrubopts] [tag]
3131

@@ -57,7 +57,7 @@ rank 0 and distributed across MDS as appropriate.
5757
Monitor (ongoing) File System Scrubs
5858
====================================
5959

60-
Status of ongoing scrubs can be monitored and polled using in `scrub status`
60+
Status of ongoing scrubs can be monitored and polled using the ``scrub status``
6161
command. This commands lists out ongoing scrubs (identified by the tag) along
6262
with the path and options used to initiate the scrub::
6363

@@ -72,10 +72,10 @@ with the path and options used to initiate the scrub::
7272
}
7373
}
7474

75-
`status` shows the number of inodes that are scheduled to be scrubbed at any point in time,
76-
hence, can change on subsequent `scrub status` invocations. Also, a high level summary of
75+
``status`` shows the number of inodes that are scheduled to be scrubbed at any point in time.
76+
Hence, it can change on subsequent ``scrub status`` invocations. Also, a high level summary of
7777
scrub operation (which includes the operation state and paths on which scrub is triggered)
78-
gets displayed in `ceph status`::
78+
gets displayed in ``ceph status``::
7979

8080
ceph status
8181
[...]
@@ -87,7 +87,8 @@ gets displayed in `ceph status`::
8787
[...]
8888

8989
A scrub is complete when it no longer shows up in this list (although that may
90-
change in future releases). Any damage will be reported via cluster health warnings.
90+
change in future releases). Any damage will be reported via
91+
:ref:`cluster health warnings <cephfs-health-messages>`.
9192

9293
Control (ongoing) File System Scrubs
9394
====================================
@@ -116,7 +117,7 @@ Control (ongoing) File System Scrubs
116117
}
117118
}
118119

119-
- Resume: Resuming kick starts a paused scrub operation::
120+
- Resume: Resuming kick-starts a paused scrub operation::
120121

121122
ceph tell mds.cephfs:0 scrub resume
122123
{
@@ -143,32 +144,32 @@ The types of damage that can be reported and repaired by File System Scrub are:
143144

144145
* BACKTRACE : Inode's backtrace in the data pool is corrupted.
145146

146-
These above named MDS damages can be repaired by using the following command::
147+
These above named MDS damage types can be repaired by running a command of the following form::
147148

148149
ceph tell mds.<fsname>:0 scrub start /path recursive, repair, force
149150

150151
If scrub is able to repair the damage, the corresponding entry is automatically
151152
removed from the damage table.
152153

153-
Note: A scrub invoked with the ``repair`` option can identify an damaged hard link but not repair it.
154+
.. note:: A scrub invoked with the ``repair`` option can identify a damaged hard link but not repair it.
154155

155156

156-
Evaluate strays using recursive scrub
157+
Evaluate Strays Using Recursive Scrub
157158
=====================================
158159

159-
- In order to evaluate strays i.e. purge stray directories in ``~mdsdir`` use the following command::
160+
To evaluate strays i.e. purge stray directories in ``~mdsdir``, run a command of the following form::
160161

161162
ceph tell mds.<fsname>:0 scrub start ~mdsdir recursive
162163

163-
- ``~mdsdir`` is not enqueued by default when scrubbing at the CephFS root. In order to perform stray evaluation
164-
at root, run scrub with flags ``scrub_mdsdir`` and ``recursive``::
164+
``~mdsdir`` is not enqueued by default when scrubbing at the CephFS root. To perform stray evaluation
165+
at root, run scrub with flags ``scrub_mdsdir`` and ``recursive``::
165166

166167
ceph tell mds.<fsname>:0 scrub start / recursive,scrub_mdsdir
167168

168-
Dump stray folder content
169-
=====================================
169+
Dump Stray Folder Content
170+
=========================
170171

171-
- In order to dump stray folder content on a specific MDS, use the following command::
172+
To dump stray folder content on a specific MDS, run a command of the following form::
172173

173174
ceph tell mds.<fsname>:0 dump stray
174175
{

0 commit comments

Comments
 (0)