From: Kefu Chai <kchai@redhat.com>
Date: Wed, 25 Jul 2018 04:56:12 +0000 (+0800)
Subject: common/config_proxy: document Config{Values,Proxy}
X-Git-Tag: v14.0.1~777^2
X-Git-Url: http://git-server-git.apps.pok.os.sepia.ceph.com/?a=commitdiff_plain;h=4f34c56e7c9e576d43882fab256e12e013f7c8ff;p=ceph.git

common/config_proxy: document Config{Values,Proxy}

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

diff --git a/src/common/config_proxy.h b/src/common/config_proxy.h
index af4e48c0f402..2bcc7a44e6c9 100644
--- a/src/common/config_proxy.h
+++ b/src/common/config_proxy.h
@@ -9,6 +9,9 @@
 #include "common/config_obs_mgr.h"
 #include "common/Mutex.h"
 
+// @c ConfigProxy is a facade of multiple config related classes. it exposes
+// the legacy settings with arrow operator, and the new-style config with its
+// member methods.
 class ConfigProxy {
   /**
    * The current values of all settings described by the schema
diff --git a/src/common/config_values.h b/src/common/config_values.h
index b21bfb43426d..b5f10b6cb47e 100644
--- a/src/common/config_values.h
+++ b/src/common/config_values.h
@@ -14,6 +14,9 @@
 #include "log/SubsystemMap.h"
 #include "msg/msg_types.h"
 
+// @c ConfigValues keeps track of mappings from the config names to their values,
+// debug logging settings, and some other "unnamed" settings, like entity name of
+// the daemon.
 class ConfigValues {
   using values_t = std::map<std::string, map<int32_t,Option::value_t>>;
   values_t values;