]> git.apps.os.sepia.ceph.com Git - ceph.git/commit
doc/dev/config: Document how to use :confval: directive for config options 64160/head
authorKefu Chai <tchaikov@gmail.com>
Wed, 25 Jun 2025 03:50:24 +0000 (11:50 +0800)
committerKefu Chai <tchaikov@gmail.com>
Wed, 25 Jun 2025 04:19:18 +0000 (12:19 +0800)
commitd61f9fffac0a1a0c18cbba89e8c43f469ee55c44
tree96d32390d548fd42ebd2c5278df10ca7cdfaed82
parent0e4eb9936c7beb9c6847cb896dbb12c5b6dfe781
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>
doc/dev/config.rst