]> git.apps.os.sepia.ceph.com Git - ceph.git/commitdiff
doc/rados: update mon_host & friends options 43093/head
authorZac Dover <zac.dover@gmail.com>
Wed, 8 Sep 2021 14:37:57 +0000 (00:37 +1000)
committerZac Dover <zac.dover@gmail.com>
Wed, 17 Nov 2021 14:53:44 +0000 (00:53 +1000)
This PR improves the wording of the descriptions of
the mon_host and mon_host_override bootstrap options.

Signed-off-by: Zac Dover <zac.dover@gmail.com>
src/common/options/global.yaml.in

index 223bd5745004c5a92d23624adaee7b2fe908d748..e247f3abddad15086e0eb025e16138e203addb42 100644 (file)
@@ -163,9 +163,7 @@ options:
   type: str
   level: basic
   desc: list of hosts or addresses to search for a monitor
-  long_desc: This is a comma, whitespace, or semicolon separated list of IP addresses
-    or hostnames. Hostnames are resolved via DNS and all A or AAAA records are included
-    in the search list.
+  long_desc: This is a list of IP addresses or hostnames that are separated by commas, whitespace, or semicolons. Hostnames are resolved via DNS. All A and AAAA records are included in the search list.
   services:
   - common
   flags:
@@ -175,11 +173,7 @@ options:
   type: str
   level: advanced
   desc: monitor(s) to use overriding the MonMap
-  fmt_desc: the list of monitors for the cluster to
-    **initially** contact when beginning a new instance of communication with the
-    Ceph cluster.  This overrides the known monitor list derived from MonMap
-    updates sent to older Ceph instances (like librados cluster handles).  It is
-    expected this option is primarily useful for debugging.
+  fmt_desc: This is the list of monitors that the Ceph process **initially** contacts when first establishing communication with the Ceph cluster. This overrides the known monitor list that is derived from MonMap updates sent to older Ceph instances (like librados cluster handles). This option is expected to be useful primarily for debugging.
   services:
   - common
   flags: