bahman/scylla
1
0
Fork 0
Code Issues Pull Requests Actions 2 Packages Projects Releases Wiki Activity

config: start available options with '*'

Browse Source 
use '*' prefix for config option values instead of escape sequences

The custom Sphinx extension that generates documentation from config.cc
help messages has issues with C++ escape sequences. For example,
"\tall: All traffic" renders incorrectly as "tall: All traffic" in HTML
output.

Instead of using escape sequences, switch to bullet-point style with '*'
prefix which works better in both CLI and HTML rendering. This matches
our existing documentation style for available option values in other
configs.

Note: This change puts type/default/liveness info in the same bullet
list as option values. This limitation affects other similar config
options and will need to be addressed comprehensively in a future
change.

Refs scylladb/scylladb#22423
Signed-off-by: Kefu Chai <kefu.chai@scylladb.com>
This commit is contained in:
Kefu Chai
2025-01-29 07:42:03 +08:00
parent 4f5550d7f2
commit a81416862a
1 changed files with 3 additions and 3 deletions
Download Patch File Download Diff File Expand all files Collapse all files

6
db/config.cc
View File

@@ -904,9 +904,9 @@ db::config::config(std::shared_ptr<db::extensions> exts)
"Sets the receiving socket buffer size in bytes for inter-node calls.")
, internode_compression(this, "internode_compression", value_status::Used, "none",
"Controls whether traffic between nodes is compressed. The valid values are:\n"
"\tall: All traffic is compressed.\n"
"\tdc : Traffic between data centers is compressed.\n"
"\tnone : No compression.")
"* all: All traffic is compressed.\n"
"* dc : Traffic between data centers is compressed.\n"
"* none : No compression.")
, internode_compression_zstd_max_cpu_fraction(this, "internode_compression_zstd_max_cpu_fraction", liveness::LiveUpdate, value_status::Used, 0.000,
"ZSTD compression of RPC will consume at most this fraction of each internode_compression_zstd_quota_refresh_period_ms time slice.\n"
"If you wish to try out zstd for RPC compression, 0.05 is a reasonable starting point.")