From: Kefu Chai <kchai@redhat.com>
Date: Fri, 16 Apr 2021 06:08:59 +0000 (+0800)
Subject: doc: add "confval_section" directive
X-Git-Tag: v17.1.0~2220^2~3
X-Git-Url: http://git-server-git.apps.pok.os.sepia.ceph.com/?a=commitdiff_plain;h=bd9b597242ca27eea7847eeeb6c20ab3a559370f;p=ceph.git

doc: add "confval_section" directive

instead of reusing "confval" directive, define a new directive just
for configration sections

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

diff --git a/doc/_ext/ceph_confval.py b/doc/_ext/ceph_confval.py
index e30f374523e4..592b957dedb5 100644
--- a/doc/_ext/ceph_confval.py
+++ b/doc/_ext/ceph_confval.py
@@ -36,6 +36,18 @@ def setup(app):
             )
         ]
     )
+    app.add_object_type(
+        'confval_section',
+        'confval_section',
+        objname='configuration section',
+        indextemplate='pair: %s; configuration section',
+        doc_field_types=[
+            Field(
+                'example',
+                label=_('Example'),
+                has_arg=False,
+            )]
+    )
     return {
         'version': 'builtin',
         'parallel_read_safe': True,
diff --git a/doc/rados/configuration/ceph-conf.rst b/doc/rados/configuration/ceph-conf.rst
index 8d7119ef954a..9b84e9985632 100644
--- a/doc/rados/configuration/ceph-conf.rst
+++ b/doc/rados/configuration/ceph-conf.rst
@@ -119,14 +119,14 @@ they apply to.
 
 These sections include:
 
-.. confval:: global
+.. confval_section:: global
 
    Settings under ``global`` affect all daemons and clients
    in a Ceph Storage Cluster.
 
    :example: ``log_file = /var/log/ceph/$cluster-$type.$id.log``
 
-.. confval:: mon
+.. confval_section:: mon
 
    Settings under ``mon`` affect all ``ceph-mon`` daemons in
    the Ceph Storage Cluster, and override the same setting in
@@ -134,7 +134,7 @@ These sections include:
 
    :example: ``mon_cluster_log_to_syslog = true``
 
-.. confval:: mgr
+.. confval_section:: mgr
 
    Settings in the ``mgr`` section affect all ``ceph-mgr`` daemons in
    the Ceph Storage Cluster, and override the same setting in
@@ -142,7 +142,7 @@ These sections include:
 
    :example: ``mgr_stats_period = 10``
 
-.. confval:: osd
+.. confval_section:: osd
 
    Settings under ``osd`` affect all ``ceph-osd`` daemons in
    the Ceph Storage Cluster, and override the same setting in
@@ -150,7 +150,7 @@ These sections include:
 
    :example: ``osd_op_queue = wpq``
 
-.. confval:: mds
+.. confval_section:: mds
 
    Settings in the ``mds`` section affect all ``ceph-mds`` daemons in
    the Ceph Storage Cluster, and override the same setting in
@@ -158,7 +158,7 @@ These sections include:
 
    :example: ``mds_cache_memory_limit = 10G``
 
-.. confval:: client
+.. confval_section:: client
 
    Settings under ``client`` affect all Ceph Clients
    (e.g., mounted Ceph File Systems, mounted Ceph Block Devices,