]> git.apps.os.sepia.ceph.com Git - ceph-ci.git/commit
doc/man/8/ceph-volume: specify "program" for subcommands
authorKefu Chai <kchai@redhat.com>
Wed, 14 Jul 2021 12:54:50 +0000 (20:54 +0800)
committerKefu Chai <kchai@redhat.com>
Wed, 21 Jul 2021 17:13:54 +0000 (01:13 +0800)
commitf54574d1ac5d2956a152be809eb00fbd1d567a87
tree58585fdcd24e522caf9f312cdb162042df5bf8b3
parent351e0df4a27efbfe3096645c025b1d3a282f7996
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>
doc/man/8/ceph-volume.rst