doc/rados/configuration/general-config-ref: use confval directive

for defining options

Signed-off-by: Kefu Chai <kchai@redhat.com>

diff --git a/doc/rados/configuration/general-config-ref.rst b/doc/rados/configuration/general-config-ref.rst
index fc837c3958ebe630cb4478d42cc4415090f8e350..c4ec118f757697ea05f70bf267718915283836f5 100644 (file)
--- a/doc/rados/configuration/general-config-ref.rst
+++ b/doc/rados/configuration/general-config-ref.rst
@@ -2,65 +2,18 @@
  General Config Reference
 ==========================
 
-
-``fsid``
-
-:Description: The file system ID. One per cluster.
-:Type: UUID
-:Required: No. 
-:Default: N/A. Usually generated by deployment tools.
-
-
-``admin_socket``
-
-:Description: The socket for executing administrative commands on a daemon, 
-              irrespective of whether Ceph Monitors have established a quorum.
-
-:Type: String
-:Required: No
-:Default: ``/var/run/ceph/$cluster-$name.asok`` 
-
-
-``pid_file``
-
-:Description: The file in which the mon, osd or mds will write its
-              PID.  For instance, ``/var/run/$cluster/$type.$id.pid``
-              will create /var/run/ceph/mon.a.pid for the ``mon`` with
-              id ``a`` running in the ``ceph`` cluster. The ``pid
-              file`` is removed when the daemon stops gracefully. If
-              the process is not daemonized (i.e. runs with the ``-f``
-              or ``-d`` option), the ``pid file`` is not created. 
-:Type: String
-:Required: No
-:Default: No
-
-
-``chdir``
-
-:Description: The directory Ceph daemons change to once they are 
-              up and running. Default ``/`` directory recommended.
-
-:Type: String
-:Required: No
-:Default: ``/``
-
-
-``max_open_files``
-
-:Description: If set, when the :term:`Ceph Storage Cluster` starts, Ceph sets 
-              the max open FDs at the OS level (i.e., the max # of file 
-              descriptors). A suitably large value prevents Ceph Daemons from running out
-              of file descriptors.
-
-:Type: 64-bit Integer
-:Required: No
-:Default: ``0``
-
-
-``fatal_signal_handlers``
-
-:Description: If set, we will install signal handlers for SEGV, ABRT, BUS, ILL,
-              FPE, XCPU, XFSZ, SYS signals to generate a useful log message
-
-:Type: Boolean
-:Default: ``true``
+.. confval:: admin_socket
+   :default: /var/run/ceph/$cluster-$name.asok
+.. confval:: pid_file
+.. confval:: chdir
+.. confval:: fatal_signal_handlers
+.. confval_option:: max_open_files
+
+   If set, when the :term:`Ceph Storage Cluster` starts, Ceph sets
+   the max open FDs at the OS level (i.e., the max # of file
+   descriptors). A suitably large value prevents Ceph Daemons from running out
+   of file descriptors.
+
+   :Type: 64-bit Integer
+   :Required: No
+   :Default: ``0``

diff --git a/src/common/options/global.yaml.in b/src/common/options/global.yaml.in
index e38b562666393c0e6903ac1973ffe3a06627b915..7bd032dcd0472c65a81ffffbdbce1902d33a92fe 100644 (file)
--- a/src/common/options/global.yaml.in
+++ b/src/common/options/global.yaml.in
@@ -260,6 +260,8 @@ options:
   type: str
   level: advanced
   desc: path for the runtime control socket file, used by the 'ceph daemon' command
+  fmt_desc: The socket for executing administrative commands on a daemon,
+    irrespective of whether Ceph Monitors have established a quorum.
   daemon_default: $run_dir/$cluster-$name.asok
   services:
   - common
@@ -360,6 +362,13 @@ options:
   type: str
   level: advanced
   desc: path to write a pid file (if any)
+  fmt_desc: The file in which the mon, osd or mds will write its
+    PID.  For instance, ``/var/run/$cluster/$type.$id.pid``
+    will create /var/run/ceph/mon.a.pid for the ``mon`` with
+    id ``a`` running in the ``ceph`` cluster. The ``pid
+    file`` is removed when the daemon stops gracefully. If
+    the process is not daemonized (i.e. runs with the ``-f``
+    or ``-d`` option), the ``pid file`` is not created.
   tags:
   - service
   services:
@@ -374,6 +383,8 @@ options:
   type: str
   level: advanced
   desc: path to chdir(2) to after daemonizing
+  fmt_desc: The directory Ceph daemons change to once they are
+    up and running. Default ``/`` directory recommended.
   tags:
   - service
   services:
@@ -392,6 +403,8 @@ options:
   level: advanced
   desc: whether to register signal handlers for SIGABRT etc that dump a stack trace
   long_desc: This is normally true for daemons and values for libraries.
+  fmt_desc: If set, we will install signal handlers for SEGV, ABRT, BUS, ILL,
+    FPE, XCPU, XFSZ, SYS signals to generate a useful log message
   default: true
   tags:
   - service