]> git.apps.os.sepia.ceph.com Git - ceph.git/commitdiff
doc/mgr: edit iostat.rst 63514/head
authorZac Dover <zac.dover@proton.me>
Thu, 22 May 2025 06:48:49 +0000 (16:48 +1000)
committerZac Dover <zac.dover@proton.me>
Tue, 27 May 2025 03:57:52 +0000 (13:57 +1000)
Edit doc/mgr/iostat.rst. Improve the English where necessary.

This is part of a project to separate out the twenty-five files that
were committed to https://github.com/ceph/ceph/pull/62782.

Signed-off-by: Zac Dover <zac.dover@proton.me>
(cherry picked from commit 98708a7f7f3c470758063e21e840393440450381)

doc/mgr/iostat.rst

index f9f8493831bca5ec5673848d59253286d40e1f3d..ff24f1758604e7cb8c7d046e33397af765f92c4b 100644 (file)
@@ -3,30 +3,43 @@
 iostat
 ======
 
-This module shows the current throughput and IOPS done on the Ceph cluster.
+The ``iostat`` module shows the current throughput and IOPS done on the Ceph
+cluster.
 
 Enabling
 --------
 
-To check if the *iostat* module is enabled, run::
+To determine whether the ``iostat`` module is enabled, run the following
+command:
 
-  ceph mgr module ls
+.. prompt:: bash #
 
-The module can be enabled with::
+   ceph mgr module ls
 
-  ceph mgr module enable iostat
+To enable the ``iostat`` module, run the following command:
 
-To execute the module, run::
+.. prompt:: bash #
 
-  ceph iostat
+   ceph mgr module enable iostat
+
+To execute the module, run the following command:
+
+.. prompt:: bash #
+
+   ceph iostat
 
 To change the frequency at which the statistics are printed, use the ``-p``
-option::
+option:
+
+.. prompt:: bash #
+
+   ceph iostat -p <period in seconds>
 
-  ceph iostat -p <period in seconds>
+For example, use the following command to print the statistics every 5
+seconds:
 
-For example, use the following command to print the statistics every 5 seconds::
+.. prompt:: bash #
 
-  ceph iostat -p 5
+   ceph iostat -p 5
 
-To stop the module, press Ctrl-C.
+To stop the module, press ``Ctrl-C``.