From 02a15a81d8199b0156b737cb3716d36fce3380b1 Mon Sep 17 00:00:00 2001 From: Kefu Chai Date: Sun, 18 Apr 2021 00:11:14 +0800 Subject: [PATCH] doc: use ":confval:" role to reference options defined using confval Signed-off-by: Kefu Chai --- doc/_ext/ceph_confval.py | 2 +- doc/rados/configuration/msgr2.rst | 8 ++++---- doc/rados/operations/health-checks.rst | 8 ++++---- 3 files changed, 9 insertions(+), 9 deletions(-) diff --git a/doc/_ext/ceph_confval.py b/doc/_ext/ceph_confval.py index 89aa6a22f7352..b574bc6ae73a6 100644 --- a/doc/_ext/ceph_confval.py +++ b/doc/_ext/ceph_confval.py @@ -208,7 +208,7 @@ def setup(app) -> Dict[str, Any]: app.add_directive('confval', CephOption) app.add_object_type( 'confval_option', - 'confval_option', + 'confval', objname='configuration value', indextemplate='pair: %s; configuration value', doc_field_types=[ diff --git a/doc/rados/configuration/msgr2.rst b/doc/rados/configuration/msgr2.rst index f9ed236c89c6c..f3b5dba5e8f97 100644 --- a/doc/rados/configuration/msgr2.rst +++ b/doc/rados/configuration/msgr2.rst @@ -78,16 +78,16 @@ Bind configuration options Two new configuration options control whether the v1 and/or v2 protocol is used: - * ``ms_bind_msgr1`` [default: true] controls whether a daemon binds + * :confval:`ms_bind_msgr1` [default: true] controls whether a daemon binds to a port speaking the v1 protocol - * ``ms_bind_msgr2`` [default: true] controls whether a daemon binds + * :confval:`ms_bind_msgr2` [default: true] controls whether a daemon binds to a port speaking the v2 protocol Similarly, two options control whether IPv4 and IPv6 addresses are used: - * ``ms_bind_ipv4`` [default: true] controls whether a daemon binds + * :confval:`ms_bind_ipv4` [default: true] controls whether a daemon binds to an IPv4 address - * ``ms_bind_ipv6`` [default: false] controls whether a daemon binds + * :confval:`ms_bind_ipv6` [default: false] controls whether a daemon binds to an IPv6 address .. note:: The ability to bind to multiple ports has paved the way for diff --git a/doc/rados/operations/health-checks.rst b/doc/rados/operations/health-checks.rst index a7dd468c181f5..f1f80c7fc53e9 100644 --- a/doc/rados/operations/health-checks.rst +++ b/doc/rados/operations/health-checks.rst @@ -68,7 +68,7 @@ order for monitor cluster to function properly. MON_MSGR2_NOT_ENABLED _____________________ -The ``ms_bind_msgr2`` option is enabled but one or more monitors is +The :confval:`ms_bind_msgr2` option is enabled but one or more monitors is not configured to bind to a v2 port in the cluster's monmap. This means that features specific to the msgr2 protocol (e.g., encryption) are not available on some or all connections. @@ -1141,9 +1141,9 @@ _______________ One or more PGs has not been scrubbed recently. PGs are normally scrubbed within every configured interval specified by -:ref:`osd_scrub_max_interval ` globally. This +:confval:`osd_scrub_max_interval` globally. This interval can be overriden on per-pool basis with -:ref:`scrub_max_interval `. The warning triggers when +:confval:`scrub_max_interval`. The warning triggers when ``mon_warn_pg_not_scrubbed_ratio`` percentage of interval has elapsed without a scrub since it was due. @@ -1159,7 +1159,7 @@ PG_NOT_DEEP_SCRUBBED ____________________ One or more PGs has not been deep scrubbed recently. PGs are normally -scrubbed every ``osd_deep_scrub_interval`` seconds, and this warning +scrubbed every :confval:`osd_deep_scrub_interval` seconds, and this warning triggers when ``mon_warn_pg_not_deep_scrubbed_ratio`` percentage of interval has elapsed without a scrub since it was due. -- 2.39.5