From 64ca13d4b5107db1f5276f0ca4fbfa1389183060 Mon Sep 17 00:00:00 2001 From: Zac Dover Date: Thu, 14 Sep 2023 13:24:11 +1000 Subject: [PATCH] doc/man: edit ceph-monstore-tool.rst Clean up the English in doc/man/8/ceph-monstore-tool.rst. Put all commands in the imperative mood; make sentences more direct. Follows https://github.com/ceph/ceph/pull/52860. Signed-off-by: Zac Dover (cherry picked from commit 02177f6368532c14b09f84e22efd64a7f7936b34) --- doc/man/8/ceph-monstore-tool.rst | 29 +++++++++++++++-------------- 1 file changed, 15 insertions(+), 14 deletions(-) diff --git a/doc/man/8/ceph-monstore-tool.rst b/doc/man/8/ceph-monstore-tool.rst index 0d7996e8fc00d..369e50a88ea54 100644 --- a/doc/man/8/ceph-monstore-tool.rst +++ b/doc/man/8/ceph-monstore-tool.rst @@ -15,24 +15,24 @@ Synopsis Description =========== -:program:`ceph-monstore-tool` is similar to `ceph-kvstore-tool`. It allows -users to manipulate MonitorDBStore's data (monmap, osdmap, etc.) offline. +:program:`ceph-monstore-tool` is used to manipulate MonitorDBStore's data +(monmap, osdmap, etc.) offline. It is similar to `ceph-kvstore-tool`. + The default RocksDB debug level is `0`. This can be changed using `--debug`. -Please Note: - Ceph-specific options should be in the format `--option-name=VAL` - (specifically, do not forget the '='!!) - Command-specific options need to be passed after a `--` - e.g., `get monmap --debug -- --version 10 --out /tmp/foo` +Note: + Ceph-specific options take the format `--option-name=VAL` + DO NOT FORGET THE EQUALS SIGN. ('=') + Command-specific options must be passed after a `--` + for example, `get monmap --debug -- --version 10 --out /tmp/foo` Commands ======== -:program:`ceph-monstore-tool` utility uses many commands for debugging purpose -which are as follows: +:program:`ceph-monstore-tool` uses many commands for debugging purposes: :command:`store-copy ` - Copies the store to PATH. + Copy the store to PATH. :command:`get monmap [-- options]` Get monmap (version VER if specified) (default: last committed). @@ -53,10 +53,10 @@ which are as follows: Get osd_snap key (`purged_snap` or `purged_epoch`). :command:`dump-keys` - Dumps store keys to FILE (default: stdout). + Dump store keys to FILE (default: stdout). :command:`dump-paxos [-- options]` - Dumps Paxos transactions (-- -- help for more info). + Dump Paxos transactions (-- -- help for more info). :command:`dump-trace FILE [-- options]` Dump contents of trace file FILE (-- --help for more info). @@ -79,8 +79,9 @@ which are as follows: Availability ============ -**ceph-kvstore-tool** is part of Ceph, a massively scalable, open-source, distributed storage system. Please refer to -the Ceph documentation at https://docs.ceph.com for more information. +**ceph-kvstore-tool** is part of Ceph, a massively scalable, open-source, +distributed storage system. See the Ceph documentation at +https://docs.ceph.com for more information. See also -- 2.39.5