]> git.apps.os.sepia.ceph.com Git - ceph.git/commit
doc/dev/config: Document how to use :confval: directive for config options 64167/head
authorKefu Chai <tchaikov@gmail.com>
Wed, 25 Jun 2025 03:50:24 +0000 (11:50 +0800)
committerZac Dover <zac.dover@proton.me>
Wed, 25 Jun 2025 05:12:20 +0000 (15:12 +1000)
commitd1356b7c7e37a14587fdaf7105e6483c11e02e78
tree36f74028bbdff308bf83fb95b0d799e068c8ae9a
parent8e6bf8180d8938b0b5f9f932c4245839b863656b
doc/dev/config: Document how to use :confval: directive for config options

Add comprehensive guide for documenting configuration options using the
:confval: directive, including naming conventions and cross-referencing.

Previously, the documentation lacked guidance on using the :confval:
directive and the important distinction between regular config options
and mgr module options (which require the mgr/<module>/ namespace
prefix). This change provides detailed examples and best practices for
properly documenting and referencing both types of configuration options.

Signed-off-by: Kefu Chai <tchaikov@gmail.com>
(cherry picked from commit d61f9fffac0a1a0c18cbba89e8c43f469ee55c44)
doc/dev/config.rst