thevar1able/ClickHouse
1
0
Fork 0
mirror of https://github.com/ClickHouse/ClickHouse.git synced 2024-11-29 11:02:08 +00:00
Code Issues Packages Projects Releases Wiki Activity

Merge branch 'feature/cmake-flags-doc-generator' of github.com:myrrc/ClickHouse into myrrc-feature-cmake-flags-doc-generator

Browse Source
This commit is contained in:
alesapin 2020-09-23 17:48:23 +03:00
commit ee5fc9e3f9
1 changed files with 14 additions and 12 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

26
docs/tools/cmake_in_clickhouse_generator.py
View File

@ -39,13 +39,15 @@ def build_entity(path: str, entity: Entity, line_comment: Tuple[int, str]) -> No
if name in entities: if name in entities:
return return
# cannot escape the { in macro option description -> invalid AMP html
# Skipping "USE_INTERNAL_${LIB_NAME_UC}_LIBRARY"
if "LIB_NAME_UC" in name:
return
if len(default) == 0: if len(default) == 0:
formatted_default: str = "`OFF`" formatted_default: str = "`OFF`"
elif default[0] == "$": elif default[0] == "$":
formatted_default: str = default[2:-1] formatted_default: str = "`{}`".format(default[2:-1])
formatted_default: str = default_anchor_str.format(
name=formatted_default,
anchor=make_anchor(formatted_default))
else: else:
formatted_default: str = "`" + default + "`" formatted_default: str = "`" + default + "`"
@ -88,18 +90,18 @@ def process_file(root_path: str, input_name: str) -> None:
if matches: if matches:
for entity in matches: for entity in matches:
build_entity(input_name, entity, get_line_and_comment(entity[0])) build_entity(os.path.join(root_path[6:], input_name), entity, get_line_and_comment(entity[0]))
def process_folder(root_path:str, name: str) -> None: def process_folder(root_path:str, name: str) -> None:
for root, _, files in os.walk(name): for root, _, files in os.walk(os.path.join(root_path, name)):
for f in files: for f in files:
if f == "CMakeLists.txt" or ".cmake" in f: if f == "CMakeLists.txt" or ".cmake" in f:
process_file(root_path, os.path.join(root, f)) process_file(root, f)
def generate_cmake_flags_files(root_path: str) -> None: def generate_cmake_flags_files(root_path: str) -> None:
output_file_name: str = root_path + "docs/en/development/cmake-in-clickhouse.md" output_file_name: str = os.path.join(root_path, "docs/en/development/cmake-in-clickhouse.md")
header_file_name: str = root_path + "docs/_includes/cmake_in_clickhouse_header.md" header_file_name: str = os.path.join(root_path, "docs/_includes/cmake_in_clickhouse_header.md")
footer_file_name: str = root_path + "docs/_includes/cmake_in_clickhouse_footer.md" footer_file_name: str = os.path.join(root_path, "docs/_includes/cmake_in_clickhouse_footer.md")
process_file(root_path, "CMakeLists.txt") process_file(root_path, "CMakeLists.txt")
process_file(root_path, "programs/CMakeLists.txt") process_file(root_path, "programs/CMakeLists.txt")
@ -122,11 +124,11 @@ def generate_cmake_flags_files(root_path: str) -> None:
f.write(entities[k][1] + "\n") f.write(entities[k][1] + "\n")
ignored_keys.append(k) ignored_keys.append(k)
f.write("### External libraries\nNote that ClickHouse uses forks of these libraries, see https://github.com/ClickHouse-Extras.\n" + f.write("\n### External libraries\nNote that ClickHouse uses forks of these libraries, see https://github.com/ClickHouse-Extras.\n" +
table_header) table_header)
for k in sorted_keys: for k in sorted_keys:
if k.startswith("ENABLE_") and entities[k][0].startswith("cmake"): if k.startswith("ENABLE_") and ".cmake" in entities[k][0]:
f.write(entities[k][1] + "\n") f.write(entities[k][1] + "\n")
ignored_keys.append(k) ignored_keys.append(k)