]> git.apps.os.sepia.ceph.com Git - ceph.git/commitdiff
doc: Add section about changing config values
authorColin Patrick McCabe <cmccabe@alumni.cmu.edu>
Fri, 16 Sep 2011 21:58:28 +0000 (14:58 -0700)
committerTommi Virtanen <tommi.virtanen@dreamhost.com>
Fri, 16 Sep 2011 22:41:13 +0000 (15:41 -0700)
Signed-off-by: Colin McCabe <colin.mccabe@dreamhost.com>
doc/dev/config.rst

index 59f1b92989c51d0c941a9c5d3d91eea1aca23049..a4fdb49b169fcacc9bd26afa64a39a8ed100986e 100644 (file)
@@ -51,7 +51,7 @@ There are a few different metavariables:
  - $name: expands to $type.$id
 
 
-Interfacing with the Configuration Management System
+Readin configuration values
 ====================================================
 
 There are two ways for Ceph code to get configuration values. One way is to
@@ -75,3 +75,16 @@ The observer method should be preferred in new code because
 
 For these reasons, reading directly from g_conf should be considered deprecated
 and not done in new code.  Do not ever alter g_conf.
+
+Changing configuration values
+====================================================
+
+Configuration values can be changed by calling g_conf->set_val. After changing
+the configuration, you should call g_conf->apply_changes to re-run all the
+affected configuration observers. For convenience, you can call
+g_conf->set_val_or_die to make a configuration change which you think should
+never fail.
+
+Injectargs, parse_argv, and parse_env are three other functions which modify
+the configuration. Just like with set_val, you should call apply_changes after
+calling these functions to make sure your changes get applied.