Skip to content

Commit d4eadb5

Browse files
committed
doc/man/8: Fix small errors and small improvements in mount.ceph.rst
Fix two cases of a stray space in the middle of syntax causing invalid rendering in `man` output (introduced in ceph#49630). Fix a missing apostrophe in "its" and expand another "it's" to the same "it is". Harmonize usage of single and double backticks (for ceph commands and parameters respectively) and quotation marks (for reference to single characters in syntax). Harmonize command parameter descriptions to always begin with capital case and end in full stop. Other minor capitalization fixes. Fix "scale with" that supposedly should be "scales with". Signed-off-by: Ville Ojamo <[email protected]>
1 parent be4fc03 commit d4eadb5

File tree

1 file changed

+28
-28
lines changed

1 file changed

+28
-28
lines changed

doc/man/8/mount.ceph.rst

Lines changed: 28 additions & 28 deletions
Original file line numberDiff line numberDiff line change
@@ -26,7 +26,7 @@ where "name" is the RADOS client name (referred to hereafter as "RADOS user",
2626
and meaning any individual or system actor such as an application).
2727

2828
Mount helper can fill in the cluster FSID by reading the ceph configuration file.
29-
Its recommended to call the mount helper via mount(8) as per::
29+
It is recommended to call the mount helper via mount(8) as per::
3030

3131
mount -t ceph [email protected]_name=/ /mnt/mycephfs -o mon_addr=1.2.3.4
3232

@@ -37,7 +37,7 @@ RADOS user for authentication, the file system name and a path within CephFS
3737
that will be mounted at the mount point.
3838

3939
Monitor addresses can be passed using ``mon_addr`` mount option. Multiple monitor
40-
addresses can be passed by separating addresses with a slash (`/`). Only one
40+
addresses can be passed by separating addresses with a slash ("/"). Only one
4141
monitor is needed to mount successfully; the client will learn about all monitors
4242
from any responsive monitor. However, it is a good idea to specify more than one
4343
in case the one happens to be down at the time of mount. Monitor addresses takes
@@ -78,49 +78,49 @@ Basic
7878
Set the connection mode that the client uses for transport. The available
7979
modes are:
8080

81-
- ``legacy``: use messenger v1 protocol to talk to the cluster
81+
- ``legacy``: Use messenger v1 protocol to talk to the cluster.
8282

83-
- ``crc``: use messenger v2, without on-the-wire encryption
83+
- ``crc``: Use messenger v2, without on-the-wire encryption.
8484

85-
- ``secure``: use messenger v2, with on-the-wire encryption
85+
- ``secure``: Use messenger v2, with on-the-wire encryption.
8686

87-
- ``prefer-crc``: crc mode, if denied agree to secure mode
87+
- ``prefer-crc``: ``crc`` mode, if denied agree to ``secure`` mode.
8888

89-
- ``prefer-secure``: secure mode, if denied agree to crc mode
89+
- ``prefer-secure``: ``secure`` mode, if denied agree to ``crc`` mode.
9090

9191
:command:`mon_addr`
92-
Monitor address of the cluster in the form of ip_address[:port]
92+
Monitor address of the cluster in the form of ip_address[:port].
9393

9494
:command:`fsid`
9595
Cluster FSID. This can be found using `ceph fsid` command.
9696

9797
:command:`secret`
98-
secret key for use with CephX. This option is insecure because it exposes
99-
the secret on the command line. To avoid this, use the secretfile option.
98+
Secret key for use with CephX. This option is insecure because it exposes
99+
the secret on the command line. To avoid this, use the ``secretfile`` option.
100100

101101
:command:`secretfile`
102-
path to file containing the secret key to use with CephX
102+
Path to file containing the secret key to use with CephX.
103103

104104
:command:`recover_session=<no|clean>`
105105
Set auto reconnect mode in the case where the client is blocklisted. The
106106
available modes are ``no`` and ``clean``. The default is ``no``.
107107

108-
- ``no``: never attempt to reconnect when client detects that it has been
108+
- ``no``: Never attempt to reconnect when client detects that it has been
109109
blocklisted. Blocklisted clients will not attempt to reconnect and
110110
their operations will fail too.
111111

112-
- ``clean``: client reconnects to the Ceph cluster automatically when it
112+
- ``clean``: Client reconnects to the Ceph cluster automatically when it
113113
detects that it has been blocklisted. During reconnect, client drops
114114
dirty data/metadata, invalidates page caches and writable file handles.
115115
After reconnect, file locks become stale because the MDS loses track of
116116
them. If an inode contains any stale file locks, read/write on the inode
117117
is not allowed until applications release all stale file locks.
118118

119-
:command: `fs=<fs-name>`
119+
:command:`fs=<fs-name>`
120120
Specify the non-default file system to be mounted, when using the old syntax.
121121

122-
:command: `mds_namespace=<fs-name>`
123-
A synonym of "fs=" (Deprecated).
122+
:command:`mds_namespace=<fs-name>`
123+
A synonym of "fs=" (deprecated).
124124

125125
Advanced
126126
--------
@@ -149,8 +149,8 @@ Advanced
149149
no data crc on writes
150150

151151
:command:`noshare`
152-
create a new client instance, instead of sharing an existing instance of
153-
a client mounting the same cluster
152+
Create a new client instance, instead of sharing an existing instance of
153+
a client mounting the same cluster.
154154

155155
:command:`osdkeepalive`
156156
int, Default: 5
@@ -182,7 +182,7 @@ Advanced
182182
string, set the name of the hidden snapdir. Default: .snap
183183

184184
:command:`write_congestion_kb`
185-
int (kb), max writeback in flight. scale with available
185+
int (kb), max writeback in flight. Scales with available
186186
memory. Default: calculated from available memory
187187

188188
:command:`wsize`
@@ -202,8 +202,8 @@ Advanced
202202

203203
:command:`crush_location=x`
204204
Specify the location of the client in terms of CRUSH hierarchy (since 5.8).
205-
This is a set of key-value pairs separated from each other by '|', with
206-
keys separated from values by ':'. Note that '|' may need to be quoted
205+
This is a set of key-value pairs separated from each other by "|", with
206+
keys separated from values by ":". Note that "|" may need to be quoted
207207
or escaped to avoid it being interpreted as a pipe by the shell. The key
208208
is the bucket type name (e.g. rack, datacenter or region with default
209209
bucket types) and the value is the bucket name. For example, to indicate
@@ -227,19 +227,19 @@ Advanced
227227
- ``balance``: When a replicated pool receives a read request, pick a random
228228
OSD from the PG's acting set to serve it (since 5.8).
229229

230-
This mode is safe for general use only since Octopus (i.e. after "ceph osd
231-
require-osd-release octopus"). Otherwise it should be limited to read-only
230+
This mode is safe for general use only since Octopus (i.e. after `ceph osd
231+
require-osd-release octopus`). Otherwise it should be limited to read-only
232232
workloads such as snapshots.
233233

234234
- ``localize``: When a replicated pool receives a read request, pick the most
235235
local OSD to serve it (since 5.8). The locality metric is calculated against
236-
the location of the client given with crush_location; a match with the
236+
the location of the client given with ``crush_location``; a match with the
237237
lowest-valued bucket type wins. For example, an OSD in a matching rack
238238
is closer than an OSD in a matching data center, which in turn is closer
239239
than an OSD in a matching region.
240240

241-
This mode is safe for general use only since Octopus (i.e. after "ceph osd
242-
require-osd-release octopus"). Otherwise it should be limited to read-only
241+
This mode is safe for general use only since Octopus (i.e. after `ceph osd
242+
require-osd-release octopus`). Otherwise it should be limited to read-only
243243
workloads such as snapshots.
244244

245245

@@ -259,11 +259,11 @@ Pass the monitor host's IP address, optionally::
259259

260260
mount.ceph [email protected]=/ /mnt/mycephfs -o mon_addr=192.168.0.1
261261

262-
Pass the port along with IP address if it's running on a non-standard port::
262+
Pass the port along with IP address if it is running on a non-standard port::
263263

264264
mount.ceph [email protected]=/ /mnt/mycephfs -o mon_addr=192.168.0.1:7000
265265

266-
If there are multiple monitors, pass each address separated by a `/`::
266+
If there are multiple monitors, pass each address separated by a "/"::
267267

268268
mount.ceph [email protected]=/ /mnt/mycephfs -o mon_addr=192.168.0.1/192.168.0.2/192.168.0.3
269269

0 commit comments

Comments
 (0)