From 5db6daa7442f5ffeb5bc95e3d9a47a18041eb828 Mon Sep 17 00:00:00 2001 From: Zac Dover Date: Thu, 16 Nov 2023 21:14:13 +1000 Subject: [PATCH] doc/man: edit ceph-osd description 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 Signed-off-by: Zac Dover (cherry picked from commit 2921dacf1e7b7ad2aa62f52d6e8914d8ec50a610) --- doc/man/8/ceph-osd.rst | 18 ++++++++++-------- 1 file changed, 10 insertions(+), 8 deletions(-) diff --git a/doc/man/8/ceph-osd.rst b/doc/man/8/ceph-osd.rst index 5b631eeff744b..4b038437bbd91 100644 --- a/doc/man/8/ceph-osd.rst +++ b/doc/man/8/ceph-osd.rst @@ -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 -- 2.39.5