From: Zac Dover Date: Wed, 4 Jun 2025 23:52:40 +0000 (+1000) Subject: doc/mgr: edit cli_api X-Git-Tag: v19.2.3~84^2 X-Git-Url: http://git.apps.os.sepia.ceph.com/?a=commitdiff_plain;h=a3d651f4e2e940af3d065aaeff18ee19d39489a4;p=ceph.git doc/mgr: edit cli_api Improve the English in doc/mgr/cli_api.rst. Incorporate the changes suggested by Anthony D'Atri in https://github.com/ceph/ceph/pull/63195. Signed-off-by: Zac Dover (cherry picked from commit 7722272c35044cd4e735427352cd4cef791091ee) --- diff --git a/doc/mgr/cli_api.rst b/doc/mgr/cli_api.rst index 5ac23632bb5af..86dfd281392aa 100644 --- a/doc/mgr/cli_api.rst +++ b/doc/mgr/cli_api.rst @@ -1,20 +1,19 @@ CLI API Commands Module ======================= -The CLI API module exposes most of the ceph-mgr Python API via CLI. This API -can be benchmarked for further testing. +The CLI API module exposes most of the ceph-mgr Python API via CLI commands. +This API can be benchmarked. Enabling -------- -Enable the ``cli api commands`` module by running the following command: +Enable the ``cli api`` module by running the following command: .. prompt:: bash # ceph mgr module enable cli_api -Ensure that the ``cli api commands`` module is enabled by running the following -command: +Ensure that the ``cli api`` module is enabled by running the following command: .. prompt:: bash # @@ -23,7 +22,7 @@ command: Usage -------- -This the the general form of Manager module commands: +This the the general form of Manager CLI commands: .. prompt:: bash # @@ -35,7 +34,7 @@ Print the list of servers by running the following command: ceph mgr cli list_servers -List all available mgr module commands by running the following command: +List all available Manager module commands by running the following command: .. prompt:: bash #