From: Ville Ojamo <14869000+bluikko@users.noreply.github.com>
Date: Mon, 2 Mar 2026 07:00:45 +0000 (+0700)
Subject: doc: Remove markup from CLI example commands
X-Git-Url: http://git-server-git.apps.pok.os.sepia.ceph.com/?a=commitdiff_plain;h=de9e6021ae917067b8aae7ef99e227572565a89c;p=ceph.git

doc: Remove markup from CLI example commands

Remove all the remaining stars in the preformatted block CLI example
commands.
Several example CLI commands had stars around placeholder text in
addition to the standard angle brackets. The stars could make sense in
man pages or in text to make the placeholder italic but it will just be
rendered as-is in preformatted text blocks.

Signed-off-by: Ville Ojamo <git2233+ceph@ojamo.eu>
---

diff --git a/doc/cephadm/services/mon.rst b/doc/cephadm/services/mon.rst
index 86cc121c9d5..ba695cea03b 100644
--- a/doc/cephadm/services/mon.rst
+++ b/doc/cephadm/services/mon.rst
@@ -41,7 +41,7 @@ format (e.g., ``10.1.2.0/24``):
 
   .. prompt:: bash #
 
-     ceph config set mon public_network *<mon-cidr-network>*
+     ceph config set mon public_network <mon-cidr-network>
 
   For example:
 
@@ -56,7 +56,7 @@ You can also specify two public networks by using a list of networks:
 
   .. prompt:: bash #
 
-     ceph config set mon public_network *<mon-cidr-network1>,<mon-cidr-network2>*
+     ceph config set mon public_network <mon-cidr-network1>,<mon-cidr-network2>
 
   For example:
 
@@ -80,7 +80,7 @@ run this command:
 
   .. prompt:: bash #
 
-    ceph orch daemon add mon *<host1:ip-or-network1>
+    ceph orch daemon add mon <host1:ip-or-network1>
 
   For example, to deploy a second monitor on ``newhost1`` using an IP
   address ``10.1.2.123`` and a third monitor on ``newhost2`` in
@@ -125,7 +125,7 @@ To deploy each additional monitor:
 
   .. prompt:: bash #
 
-    ceph orch daemon add mon *<newhost1:ip-or-network1>*
+    ceph orch daemon add mon <newhost1:ip-or-network1>
 
 For example, to deploy a second monitor on ``newhost1`` using an IP
 address ``10.1.2.123`` and a third monitor on ``newhost2`` in
@@ -147,7 +147,7 @@ network ``10.1.2.0/24``, run the following commands:
 
   .. prompt:: bash #
 
-     ceph config set mon public_network *<mon-cidr-network>*
+     ceph config set mon public_network <mon-cidr-network>
 
   For example:
 
diff --git a/doc/cephadm/services/nfs.rst b/doc/cephadm/services/nfs.rst
index f7b2caabc37..d1d34677a86 100644
--- a/doc/cephadm/services/nfs.rst
+++ b/doc/cephadm/services/nfs.rst
@@ -22,7 +22,7 @@ To deploy a NFS Ganesha gateway, run the following command:
 
 .. prompt:: bash #
 
-    ceph orch apply nfs *<svc_id>* [--port *<port>*] [--placement ...]
+    ceph orch apply nfs <svc_id> [--port <port>] [--placement ...]
 
 For example, to deploy NFS with a service id of *foo* on the default
 port 2049 with the default placement of a single daemon:
@@ -206,7 +206,7 @@ A few notes:
 
     .. prompt:: bash #
 
-	ceph config-key get mgr/cephadm/ingress.*{svc_id}*/monitor_password
+	ceph config-key get mgr/cephadm/ingress.<svc_id>/monitor_password
 
     For example:
 
diff --git a/doc/mgr/alerts.rst b/doc/mgr/alerts.rst
index dae1f78acfc..d794b36be59 100644
--- a/doc/mgr/alerts.rst
+++ b/doc/mgr/alerts.rst
@@ -31,23 +31,23 @@ separating them with commas.
 
 .. prompt:: bash #
 
-   ceph config set mgr mgr/alerts/smtp_host *<smtp-server>*
-   ceph config set mgr mgr/alerts/smtp_destination *<email-address-to-send-to>*
-   ceph config set mgr mgr/alerts/smtp_sender *<from-email-address>*
+   ceph config set mgr mgr/alerts/smtp_host <smtp-server>
+   ceph config set mgr mgr/alerts/smtp_destination <email-address-to-send-to>
+   ceph config set mgr mgr/alerts/smtp_sender <from-email-address>
 
 The alerts module uses SSL and port 465 by default. These settings can be changed by running commands of the following forms:
 
 .. prompt:: bash #
 
    ceph config set mgr mgr/alerts/smtp_ssl false   # if not SSL
-   ceph config set mgr mgr/alerts/smtp_port *<port-number>*  # if not 465
+   ceph config set mgr mgr/alerts/smtp_port <port-number>  # if not 465
 
 To authenticate to the SMTP server, you must set the user and password:
 
 .. prompt:: bash #
 
-   ceph config set mgr mgr/alerts/smtp_user *<username>*
-   ceph config set mgr mgr/alerts/smtp_password *<password>*
+   ceph config set mgr mgr/alerts/smtp_user <username>
+   ceph config set mgr mgr/alerts/smtp_password <password>
 
 By default, the name in the ``From:`` line is simply ``Ceph``.  To change this
 default (that is, to identify which cluster this is), run a command of the
@@ -63,7 +63,7 @@ frequency of the alert module's cluster health checks by running a command of th
 
 .. prompt:: bash #
 
-   ceph config set mgr mgr/alerts/interval *<interval>*   # e.g., "5m" for 5 minutes
+   ceph config set mgr mgr/alerts/interval <interval>   # e.g., "5m" for 5 minutes
 
 Commands
 --------
diff --git a/doc/mgr/nfs.rst b/doc/mgr/nfs.rst
index 485200e1f5c..acbc6395c69 100644
--- a/doc/mgr/nfs.rst
+++ b/doc/mgr/nfs.rst
@@ -466,14 +466,14 @@ An existing export can be dumped in JSON format with:
 
 .. prompt:: bash #
 
-    ceph nfs export info *<cluster_id>* *<pseudo_path>*
+    ceph nfs export info <cluster_id> <pseudo_path>
 
 An export can be created or modified by importing a JSON description in the
 same format:
 
 .. prompt:: bash #
 
-   ceph nfs export apply *<cluster_id>* -i <json_file>
+   ceph nfs export apply <cluster_id> -i <json_file>
 
 For example: