ARCHIVE/clio
1
0
Fork 0
mirror of https://github.com/XRPLF/clio.git synced 2026-06-03 08:46:42 +00:00
Code Issues Packages Projects Releases Wiki Activity

refactor: Add kCONFIG_DESCRIPTION_HEADER (#2463)

Browse Source
This commit is contained in:
Ayaz Salikhov
2025-08-20 15:29:55 +01:00
committed by GitHub
parent 7a2090bc00
commit d833d36896
2 changed files with 17 additions and 8 deletions
Download Patch File Download Diff File Expand all files Collapse all files

4
docs/config-description.md
View File

@@ -3,7 +3,9 @@
This document provides a list of all available Clio configuration properties in detail.
> [!NOTE]
> Dot notation in configuration key names represents nested fields. For example, **database.scylladb** refers to the _scylladb_ field inside the _database_ object. If a key name includes "[]", it indicates that the nested field is an array (e.g., etl_sources.[]).
> Dot notation in configuration key names represents nested fields.
> For example, **database.scylladb** refers to the _scylladb_ field inside the _database_ object.
> If a key name includes "[]", it indicates that the nested field is an array (e.g., etl_sources.[]).
## Configuration Details

21
src/util/config/ConfigDescription.hpp
View File

@@ -110,13 +110,7 @@ public:
static void
writeConfigDescriptionToFile(std::ostream& file)
{
file << "# Clio Config Description\n\n";
file << "This document provides a list of all available Clio configuration properties in detail.\n\n";
file << "> [!NOTE]\n";
file << "> Dot notation in configuration key names represents nested fields. For example, "
"**database.scylladb** refers to the _scylladb_ field inside the _database_ object. If a key name "
"includes \"[]\", it indicates that the nested field is an array (e.g., etl_sources.[]).\n\n";
file << "## Configuration Details\n";
file << kCONFIG_DESCRIPTION_HEADER;
for (auto const& [key, val] : kCONFIG_DESCRIPTION) {
file << "\n### " << key << "\n\n";
@@ -133,6 +127,19 @@ public:
}
private:
static constexpr auto kCONFIG_DESCRIPTION_HEADER =
R"(# Clio Config Description
This document provides a list of all available Clio configuration properties in detail.
> [!NOTE]
> Dot notation in configuration key names represents nested fields.
> For example, **database.scylladb** refers to the _scylladb_ field inside the _database_ object.
> If a key name includes "[]", it indicates that the nested field is an array (e.g., etl_sources.[]).
## Configuration Details
)";
static constexpr auto kCONFIG_DESCRIPTION = std::array{
KV{
.key = "database.type",