From: J. Eric Ivancich <ivancich@redhat.com>
Date: Tue, 5 Oct 2021 23:27:27 +0000 (-0400)
Subject: rgw: document rgw_lc_debug_interval configuration option
X-Git-Tag: v16.2.8~101^2
X-Git-Url: http://git-server-git.apps.pok.os.sepia.ceph.com/?a=commitdiff_plain;h=537f9ee1e42474e612887b2c46df77e36a186089;p=ceph.git

rgw: document rgw_lc_debug_interval configuration option

Updates the yaml describing this config option with a "desc" and a
"long_desc".

Signed-off-by: J. Eric Ivancich <ivancich@redhat.com>
(cherry picked from commit 9171d3626b5a0181456a68555d5742109abaabbc)

Conflicts:
	src/common/options/rgw.yaml.in

Cherry-pick notes:
- options not defined in yaml in Pacific
---

diff --git a/src/common/options.cc b/src/common/options.cc
index 82db7846e7f..712a6642631 100644
--- a/src/common/options.cc
+++ b/src/common/options.cc
@@ -6007,7 +6007,12 @@ std::vector<Option> get_rgw_options() {
 
     Option("rgw_lc_debug_interval", Option::TYPE_INT, Option::LEVEL_DEV)
     .set_default(-1)
-    .set_description(""),
+    .set_description("The number of seconds that simulate one \"day\" in order to debug RGW LifeCycle. "
+                     "Do *not* modify for a production cluster.")
+    .set_long_description("For debugging RGW LifeCycle, the number of seconds that are equivalent to "
+                          "one simulated \"day\". Values less than 1 are ignored and do not change LifeCycle behavior. "
+                          "For example, during debugging if one wanted every 10 minutes to be equivalent to one day, "
+                          "then this would be set to 600, the number of seconds in 10 minutes."),
 
     Option("rgw_mp_lock_max_time", Option::TYPE_INT, Option::LEVEL_ADVANCED)
     .set_default(600)