doc/man/8/ceph-volume: specify "program" for subcommands

as per
https://www.sphinx-doc.org/en/master/usage/restructuredtext/domains.html

> Like py:currentmodule, this directive produces no output. Instead, it
> serves to notify Sphinx that all following option directives document
> options for the program called name.
> ...
> The program name may contain spaces (in case you want to document
> subcommands like svn add and svn commit separately).

and to avoid the warnings like:

doc/man/8/ceph-volume.rst:424: WARNING: Duplicate explicit target name:
"cmdoption-ceph-volume-h".

we should specify different "program" for different set of options.

Signed-off-by: Kefu Chai <kchai@redhat.com>

diff --git a/doc/man/8/ceph-volume.rst b/doc/man/8/ceph-volume.rst
index 1ead7b4646bccd434b73236bcfc08cd8d88e4c0d..763138ec2e5a6cb7597cd5e7dd91507dbbf0d585 100644 (file)
--- a/doc/man/8/ceph-volume.rst
+++ b/doc/man/8/ceph-volume.rst
@@ -39,6 +39,8 @@ Commands
 inventory
 ---------
 
+.. program:: ceph-volume inventory
+
 This subcommand provides information about a host's physical disc inventory and
 reports metadata about these discs. Among this metadata one can find disc
 specific data items (like model, size, rotational or solid state) as well as
@@ -65,6 +67,8 @@ Optional arguments:
 lvm
 ---
 
+.. program:: ceph-volume lvm
+
 By making use of LVM tags, the ``lvm`` sub-command is able to store and later
 re-discover and query devices associated with OSDs so that they can later
 activated.
@@ -74,6 +78,8 @@ Subcommands:
 batch
 ^^^^^
 
+.. program:: ceph-volume lvm batch
+
 Creates OSDs from a list of devices using a ``filestore``
 or ``bluestore`` (default) setup. It will create all necessary volume groups
 and logical volumes required to have a working OSD.
@@ -145,11 +151,14 @@ Required positional arguments:
    Full path to a raw device, like ``/dev/sda``. Multiple
    ``<DEVICE>`` paths can be passed in.
 
-.. describe:: **activate**
+activate
+^^^^^^^^
+
+.. program:: ceph-volume lvm activate
 
-   Enables a systemd unit that persists the OSD ID and its UUID (also called
-   ``fsid`` in Ceph CLI tools), so that at boot time it can understand what OSD is
-   enabled and needs to be mounted.
+Enables a systemd unit that persists the OSD ID and its UUID (also called
+``fsid`` in Ceph CLI tools), so that at boot time it can understand what OSD is
+enabled and needs to be mounted.
 
 Usage::
 
@@ -191,6 +200,8 @@ Multiple OSDs can be activated at once by using the (idempotent) ``--all`` flag:
 prepare
 ^^^^^^^
 
+.. program:: ceph-volume lvm prepare
+
 Prepares a logical volume to be used as an OSD and journal using a ``filestore``
 or ``bluestore`` (default) setup. It will not create or modify the logical volumes
 except for adding extra metadata.
@@ -357,6 +368,8 @@ Positional arguments:
 new-wal
 ^^^^^^^
 
+.. program:: ceph-volume lvm new-wal
+
 Attaches the given logical volume to OSD as a WAL. Logical volume
 name format is vg/lv. Fails if OSD has already got attached WAL.
 
@@ -379,6 +392,8 @@ Required arguments:
 new-db
 ^^^^^^
 
+.. program:: ceph-volume lvm new-db
+
 Attaches the given logical volume to OSD as a DB. Logical volume
 name format is vg/lv. Fails if OSD has already got attached DB.
 
@@ -401,6 +416,8 @@ Required arguments:
 migrate
 ^^^^^^^
 
+.. program:: ceph-volume lvm migrate
+
 Moves BlueFS data from source volume(s) to the target one, source volumes
 (except the main, i.e. data or block one) are removed on success. LVM volumes
 are permitted for Target only, both already attached or new one. In the latter
@@ -443,6 +460,8 @@ Subcommands:
 activate
 ^^^^^^^^
 
+.. program:: ceph-volume simple activate
+
 Enables a systemd unit that persists the OSD ID and its UUID (also called
 ``fsid`` in Ceph CLI tools), so that at boot time it can understand what OSD is
 enabled and needs to be mounted, while reading information that was previously
@@ -476,6 +495,8 @@ Optional Arguments:
 scan
 ^^^^
 
+.. program:: ceph-volume simple scan
+
 Scan a running OSD or data device for an OSD for metadata that can later be
 used to activate and manage the OSD with ceph-volume. The scan method will
 create a JSON file with the required information plus anything found in the OSD