From bfb4d7720a431527c0b3cd0cfe736c7d380b9966 Mon Sep 17 00:00:00 2001 From: Kefu Chai Date: Fri, 16 Apr 2021 14:17:57 +0800 Subject: [PATCH] doc: use "describe" directive for meta variables they are not options, so we should not use confval for defining them. Signed-off-by: Kefu Chai --- doc/rados/configuration/ceph-conf.rst | 12 ++++++------ 1 file changed, 6 insertions(+), 6 deletions(-) diff --git a/doc/rados/configuration/ceph-conf.rst b/doc/rados/configuration/ceph-conf.rst index 9b84e998563..a88c801a724 100644 --- a/doc/rados/configuration/ceph-conf.rst +++ b/doc/rados/configuration/ceph-conf.rst @@ -198,7 +198,7 @@ configuration value is used. Ceph metavariables are similar to variable expansio Ceph supports the following metavariables: -.. confval:: $cluster +.. describe:: $cluster Expands to the Ceph Storage Cluster name. Useful when running multiple Ceph Storage Clusters on the same hardware. @@ -206,13 +206,13 @@ Ceph supports the following metavariables: :example: ``/etc/ceph/$cluster.keyring`` :default: ``ceph`` -.. confval:: $type +.. describe:: $type Expands to a daemon or process type (e.g., ``mds``, ``osd``, or ``mon``) :example: ``/var/lib/ceph/$type`` -.. confval:: $id +.. describe:: $id Expands to the daemon or client identifier. For ``osd.0``, this would be ``0``; for ``mds.a``, it would @@ -220,17 +220,17 @@ Ceph supports the following metavariables: :example: ``/var/lib/ceph/$type/$cluster-$id`` -.. confval:: $host +.. describe:: $host Expands to the host name where the process is running. -.. confval:: $name +.. describe:: $name Expands to ``$type.$id``. :example: ``/var/run/ceph/$cluster-$name.asok`` -.. confval:: $pid +.. describe:: $pid Expands to daemon pid. -- 2.39.5