]> git.apps.os.sepia.ceph.com Git - ceph-ci.git/commitdiff
doc: use "describe" directive for meta variables
authorKefu Chai <kchai@redhat.com>
Fri, 16 Apr 2021 06:17:57 +0000 (14:17 +0800)
committerKefu Chai <kchai@redhat.com>
Fri, 16 Apr 2021 12:27:24 +0000 (20:27 +0800)
they are not options, so we should not use confval for defining them.

Signed-off-by: Kefu Chai <kchai@redhat.com>
doc/rados/configuration/ceph-conf.rst

index 9b84e9985632256cfc05227cc6a87a501ee2b45a..a88c801a7241485500fa1d838820956992b00d4e 100644 (file)
@@ -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.