From: Zac Dover <zac.dover@proton.me>
Date: Fri, 7 Jun 2024 01:24:00 +0000 (+1000)
Subject: doc/src: add inline literals (``) to variables
X-Git-Tag: v20.0.0~1795^2
X-Git-Url: http://git-server-git.apps.pok.os.sepia.ceph.com/?a=commitdiff_plain;h=refs%2Fpull%2F57923%2Fhead;p=ceph.git

doc/src: add inline literals (``) to variables

Add inline-literal RST markup (``) (double backticks) around variable
names in src/common/options/global.yaml.in.

This follows https://github.com/ceph/ceph/pull/57887.

Signed-off-by: Zac Dover <zac.dover@proton.me>
---

diff --git a/src/common/options/global.yaml.in b/src/common/options/global.yaml.in
index 7366bbb31c64..a83cc5894e72 100644
--- a/src/common/options/global.yaml.in
+++ b/src/common/options/global.yaml.in
@@ -104,8 +104,8 @@ options:
 - name: public_network_interface
   type: str
   level: advanced
-  desc: Interface name(s) from which to choose an address from a public_network to
-    bind to; public_network must also be specified.
+  desc: Interface name(s) from which to choose an address from a ``public_network`` to
+    bind to; ``public_network`` must also be specified.
   tags:
   - network
   services:
@@ -135,8 +135,8 @@ options:
 - name: cluster_network_interface
   type: str
   level: advanced
-  desc: Interface name(s) from which to choose an address from a cluster_network to
-    bind to; cluster_network must also be specified.
+  desc: Interface name(s) from which to choose an address from a ``cluster_network`` to
+    bind to; ``cluster_network`` must also be specified.
   tags:
   - network
   services: