]> git.apps.os.sepia.ceph.com Git - ceph.git/commitdiff
doc/man: edit ceph-osd description 54551/head
authorZac Dover <zac.dover@proton.me>
Thu, 16 Nov 2023 11:14:13 +0000 (21:14 +1000)
committerZac Dover <zac.dover@proton.me>
Sat, 18 Nov 2023 18:13:02 +0000 (04:13 +1000)
Improve the English grammar and reduce the ambiguity and unclear writing
in the "Description" section of doc/man/8/ceph-osd.rst.

Co-authored-by: Anthony D'Atri <anthony.datri@gmail.com>
Signed-off-by: Zac Dover <zac.dover@proton.me>
(cherry picked from commit 2921dacf1e7b7ad2aa62f52d6e8914d8ec50a610)

doc/man/8/ceph-osd.rst

index 5b631eeff744b3931196e7c45b40eb07a5ff5d65..4b038437bbd917200e4c0ead7db91c56657dfd59 100644 (file)
@@ -18,14 +18,16 @@ Synopsis
 Description
 ===========
 
-**ceph-osd** is the object storage daemon for the Ceph distributed file
-system. It is responsible for storing objects on a local file system
-and providing access to them over the network.
-
-The datapath argument should be a directory on a xfs file system
-where the object data resides. The journal is optional, and is only
-useful performance-wise when it resides on a different disk than
-datapath with low latency (ideally, an NVRAM device).
+**ceph-osd** is the **o**\bject **s**\torage **d**\aemon for the Ceph
+distributed file system. It manages data on local storage with redundancy and
+provides access to that data over the network. 
+
+For Filestore-backed clusters, the argument of the ``--osd-data datapath``
+option (which is ``datapath`` in this example) should be a directory on an XFS
+file system where the object data resides. The journal is optional. The journal
+improves performance only when it resides on a different disk than the disk
+specified by ``datapath`` . The storage medium on which the journal is stored
+should be a low-latency medium (ideally, an SSD device).
 
 
 Options