From 7c9229e7876dfc1bf6e415ed7cce924c3b50925d Mon Sep 17 00:00:00 2001 From: Nathan Cutler Date: Wed, 18 Jul 2018 14:01:42 +0200 Subject: [PATCH] doc: use :command: for subcommands in ceph-bluestore-tool manpage Older versions of Sphinx, such as the one in CentOS 7, do not render ".. option::" lines correctly if the option contains a hyphen but does not start with a hyphen. And ceph-bluestore-tool appears to be the only Ceph manpage affected by this bug. Fixes: http://tracker.ceph.com/issues/24800 Signed-off-by: Nathan Cutler --- doc/man/8/ceph-bluestore-tool.rst | 14 +++++++------- 1 file changed, 7 insertions(+), 7 deletions(-) diff --git a/doc/man/8/ceph-bluestore-tool.rst b/doc/man/8/ceph-bluestore-tool.rst index 6ac9f97417c78..116945be85499 100644 --- a/doc/man/8/ceph-bluestore-tool.rst +++ b/doc/man/8/ceph-bluestore-tool.rst @@ -30,31 +30,31 @@ operations on a BlueStore instance. Commands ======== -.. option:: help +:command:`help` show help -.. option:: fsck +:command:`fsck` [ --deep ] run consistency check on BlueStore metadata. If *--deep* is specified, also read all object data and verify checksums. -.. option:: repair +:command:`repair` Run a consistency check *and* repair any errors we can. -.. option:: bluefs-export +:command:`bluefs-export` Export the contents of BlueFS (i.e., rocksdb files) to an output directory. -.. option:: bluefs-bdev-sizes --path *osd path* +:command:`bluefs-bdev-sizes` --path *osd path* Print the device sizes, as understood by BlueFS, to stdout. -.. option:: bluefs-bdev-expand --path *osd path* +:command:`bluefs-bdev-expand` --path *osd path* Instruct BlueFS to check the size of its block devices and, if they have expanded, make use of the additional space. -.. option:: show-label --dev *device* [...] +:command:`show-label` --dev *device* [...] Show device label(s). -- 2.39.5