Skip to content

Commit 7de5ed3

Browse files
committed
chore(configuration_options.md): bulk update
lots of update are missed from docs, and now we introduce a check for it, we should have everything updated
1 parent 1308833 commit 7de5ed3

File tree

2 files changed

+12
-3
lines changed

2 files changed

+12
-3
lines changed

docs/configuration_options.md

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -3417,6 +3417,15 @@ Forces GossipingPropertyFileSnitch (regardless `endpoint_snitch`) to simulate ra
34173417
**type:** int
34183418

34193419

3420+
## **rack_aware_loader** / SCT_RACK_AWARE_LOADER
3421+
3422+
When enabled, loaders will look for nodes on the same rack.
3423+
3424+
**default:** N/A
3425+
3426+
**type:** boolean
3427+
3428+
34203429
## **use_dns_names** / SCT_USE_DNS_NAMES
34213430

34223431
Use dns names instead of ip addresses for nodes in cluster

sdcm/sct_config.py

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -2831,7 +2831,6 @@ def dump_help_config_markdown(self):
28312831
`export SCT_APPEND_SCYLLA_ARGS="++ --overprovisioned 1"`
28322832
* **list:** can be appended by adding `++` as the first item of the list
28332833
`export SCT_SCYLLA_D_OVERRIDES_FILES='["++", "extra_file/scylla.d/io.conf"]'`
2834-
28352834
"""
28362835

28372836
def strip_help_text(text):
@@ -2841,17 +2840,18 @@ def strip_help_text(text):
28412840
output = [l.strip() for l in text.splitlines()]
28422841
return '\n'.join(output[1 if not output[0] else 0:-1 if not output[-1] else None])
28432842

2844-
ret = strip_help_text(header) + '\n'
2843+
ret = strip_help_text(header)
28452844

28462845
for opt in self.config_options:
2846+
ret += '\n\n'
28472847
if opt['help']:
28482848
help_text = '<br>'.join(strip_help_text(opt['help']).splitlines())
28492849
else:
28502850
help_text = ''
28512851
appendable = ' (appendable)' if is_config_option_appendable(opt.get('name')) else ''
28522852
default = self.get_default_value(opt['name'])
28532853
default_text = default if default else 'N/A'
2854-
ret += f"""## **{opt['name']}** / {opt['env']}\n\n{help_text}\n\n**default:** {default_text}\n\n**type:** {opt.get('type').__name__}{appendable}\n\n\n"""
2854+
ret += f"""## **{opt['name']}** / {opt['env']}\n\n{help_text}\n\n**default:** {default_text}\n\n**type:** {opt.get('type').__name__}{appendable}\n"""
28552855

28562856
return ret
28572857

0 commit comments

Comments
 (0)