From: Kefu Chai <kchai@redhat.com>
Date: Mon, 19 Apr 2021 06:37:34 +0000 (+0800)
Subject: doc/rados/configuration/msgr2: use confval directive
X-Git-Tag: v17.1.0~2202^2~1
X-Git-Url: http://git.apps.os.sepia.ceph.com/?a=commitdiff_plain;h=536f0960556cc984063b4d926d25978c914c91a6;p=ceph.git

doc/rados/configuration/msgr2: use confval directive

for defining options

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

diff --git a/doc/rados/configuration/msgr2.rst b/doc/rados/configuration/msgr2.rst
index f3b5dba5e8f97..685422720cfe2 100644
--- a/doc/rados/configuration/msgr2.rst
+++ b/doc/rados/configuration/msgr2.rst
@@ -134,27 +134,17 @@ Connection mode configuration options
 
 For most connections, there are options that control which modes are used:
 
-* ``ms_cluster_mode`` is the connection mode (or permitted modes) used
-  for intra-cluster communication between Ceph daemons.  If multiple
-  modes are listed, the modes listed first are preferred.
-* ``ms_service_mode`` is a list of permitted modes for clients to use
-  when connecting to the cluster.
-* ``ms_client_mode`` is a list of connection modes, in order of
-  preference, for clients to use (or allow) when talking to a Ceph
-  cluster.
+.. confval:: ms_cluster_mode
+.. confval:: ms_service_mode
+.. confval:: ms_client_mode
 
 There are a parallel set of options that apply specifically to
 monitors, allowing administrators to set different (usually more
 secure) requirements on communication with the monitors.
 
-* ``ms_mon_cluster_mode`` is the connection mode (or permitted modes)
-  to use between monitors.
-* ``ms_mon_service_mode`` is a list of permitted modes for clients or
-  other Ceph daemons to use when connecting to monitors.
-* ``ms_mon_client_mode`` is a list of connection modes, in order of
-  preference, for clients or non-monitor daemons to use when
-  connecting to monitors.
-
+.. confval:: ms_mon_cluster_mode
+.. confval:: ms_mon_service_mode
+.. confval:: ms_mon_client_mode
 
 Transitioning from v1-only to v2-plus-v1
 ----------------------------------------
diff --git a/src/common/options/global.yaml.in b/src/common/options/global.yaml.in
index 8f72aea0f7006..f654896f0508b 100644
--- a/src/common/options/global.yaml.in
+++ b/src/common/options/global.yaml.in
@@ -976,6 +976,7 @@ options:
   type: str
   level: basic
   desc: Connection modes (crc, secure) for intra-mon connections in order of preference
+  fmt_desc: the connection mode (or permitted modes) to use between monitors.
   default: secure crc
   see_also:
   - ms_mon_service_mode
@@ -989,6 +990,8 @@ options:
   type: str
   level: basic
   desc: Allowed connection modes (crc, secure) for connections to mons
+  fmt_desc: a list of permitted modes for clients or
+    other Ceph daemons to use when connecting to monitors.
   default: secure crc
   see_also:
   - ms_service_mode
@@ -1003,6 +1006,9 @@ options:
   level: basic
   desc: Connection modes (crc, secure) for connections from clients to monitors in
     order of preference
+  fmt_desc: a list of connection modes, in order of
+    preference, for clients or non-monitor daemons to use when
+    connecting to monitors.
   default: secure crc
   see_also:
   - ms_mon_service_mode
@@ -1016,6 +1022,9 @@ options:
   type: str
   level: basic
   desc: Connection modes (crc, secure) for intra-cluster connections in order of preference
+  fmt_desc: connection mode (or permitted modes) used
+    for intra-cluster communication between Ceph daemons.  If multiple
+    modes are listed, the modes listed first are preferred.
   default: crc secure
   see_also:
   - ms_service_mode
@@ -1026,6 +1035,8 @@ options:
   type: str
   level: basic
   desc: Allowed connection modes (crc, secure) for connections to daemons
+  fmt_desc: a list of permitted modes for clients to use
+    when connecting to the cluster.
   default: crc secure
   see_also:
   - ms_cluster_mode
@@ -1036,6 +1047,9 @@ options:
   type: str
   level: basic
   desc: Connection modes (crc, secure) for connections from clients in order of preference
+  fmt_desc: a list of connection modes, in order of
+    preference, for clients to use (or allow) when talking to a Ceph
+    cluster.
   default: crc secure
   see_also:
   - ms_cluster_mode