]> git-server-git.apps.pok.os.sepia.ceph.com Git - ceph.git/commit
common/options,doc: extract formatted desc into .yaml.in
authorKefu Chai <kchai@redhat.com>
Fri, 16 Apr 2021 05:51:23 +0000 (13:51 +0800)
committerKefu Chai <kchai@redhat.com>
Fri, 16 Apr 2021 16:02:45 +0000 (00:02 +0800)
commit4da18aaf572e4d2db6493752a1aabefda47a9085
tree4cfd42aa42df14977a5d7eab29dd7e7faa8c7d57
parentbfb4d7720a431527c0b3cd0cfe736c7d380b9966
common/options,doc: extract formatted desc into .yaml.in

* add a field named "fmt_desc", which is the description formatted using
  reStructuredText. it is preserved as it is if it's different from the
  desc or long_desc of an option. we can consolidate it with long_desc
  in future, and use pretty printer which has minimal support for
  reStructuredText for printing the formatted descriptions for a better
  user experience of command line. but at this moment, fmt_desc has
  only one consumer: the "ceph_confval" sphinx extension which extracts
  and translate the options yaml file to reStructuredText, which is in
  turn rendered by sphinx.
* remove unused options from the doc
  - journal_queue_max_ops
  - journal_queue_max_bytes

Signed-off-by: Kefu Chai <kchai@redhat.com>
doc/_ext/ceph_confval.py
doc/conf.py
doc/rados/configuration/auth-config-ref.rst
doc/rados/configuration/journal-ref.rst
doc/rados/configuration/network-config-ref.rst
src/common/options/global.yaml.in