This is an automated email from the ASF dual-hosted git repository.
adoroszlai pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/ozone.git
The following commit(s) were added to refs/heads/master by this push:
new e1b02e7f51a HDDS-14736. Escape `{...}` in xml_to_md.py, rename
appendix.md (#9846)
e1b02e7f51a is described below
commit e1b02e7f51a89c9408bf25e3055a6e3f4f4d2f64
Author: Sarveksha Yeshavantha Raju
<[email protected]>
AuthorDate: Sat Feb 28 12:35:34 2026 +0530
HDDS-14736. Escape `{...}` in xml_to_md.py, rename appendix.md (#9846)
---
.github/workflows/update-ozone-site-config-doc.yml | 2 +-
dev-support/ci/xml_to_md.py | 8 ++++++--
2 files changed, 7 insertions(+), 3 deletions(-)
diff --git a/.github/workflows/update-ozone-site-config-doc.yml
b/.github/workflows/update-ozone-site-config-doc.yml
index 73c839c14d7..e5196778a4a 100644
--- a/.github/workflows/update-ozone-site-config-doc.yml
+++ b/.github/workflows/update-ozone-site-config-doc.yml
@@ -73,7 +73,7 @@ jobs:
exit 0
fi
- TARGET_FILE="$TARGET_DIR/05-appendix.md"
+ TARGET_FILE="$TARGET_DIR/99-appendix.md"
echo "Checking against $TARGET_FILE"
# Copy new file to target location
diff --git a/dev-support/ci/xml_to_md.py b/dev-support/ci/xml_to_md.py
index e3c6ef14ebc..54e885c2833 100644
--- a/dev-support/ci/xml_to_md.py
+++ b/dev-support/ci/xml_to_md.py
@@ -106,10 +106,14 @@ def generate_markdown(properties):
|:-----|:--------------|:-----|:------------|
"""
+ placeholder_pattern = re.compile(r'(\$)?\{([^}]+)\}')
+
for prop in sorted(properties.values(), key=lambda p: p.name):
- # Escape pipe characters in description to prevent breaking the table
+ # Escape pipe characters and wrap {placeholders} in backticks
description = prop.description.replace('|', '\\|')
- value = prop.value if prop.value else ''
+ description = placeholder_pattern.sub(r'`\1{\2}`', description)
+ value = prop.value.replace('|', '\\|') if prop.value else ''
+ value = placeholder_pattern.sub(r'`\1{\2}`', value) if value else ''
markdown += f"| `{prop.name}` | {value} | {prop.tag} | {description} |\n"
---------------------------------------------------------------------
To unsubscribe, e-mail: [email protected]
For additional commands, e-mail: [email protected]
