HDDS-14976. xml_to_md.py does not handle generated XML files#10044
Open
adoroszlai wants to merge 3 commits intoapache:masterfrom
Open
HDDS-14976. xml_to_md.py does not handle generated XML files#10044adoroszlai wants to merge 3 commits intoapache:masterfrom
adoroszlai wants to merge 3 commits intoapache:masterfrom
Conversation
Contributor
|
Thanks @adoroszlai for the patch. Overall, LGTM. I just have a few minor comments. |
rich7420
approved these changes
Apr 5, 2026
Contributor
rich7420
left a comment
There was a problem hiding this comment.
thanks for the patch @adoroszlai
Russole
reviewed
Apr 5, 2026
Comment on lines
59
to
60
| name = prop.findtext('name') | ||
| if not name: |
Contributor
There was a problem hiding this comment.
I noticed that some property names still contain trailing newlines in the generated markdown (e.g. wrapped to the next line).
This seems unrelated to this change, but it might be worth normalizing name as well when parsing the XML, similar to how description is handled, for example:
name = prop.findtext('name')
name = ' '.join(name.split()).strip() if name else ''
This would help prevent formatting issues in the generated table. For example, some entries are currently rendered like:
| `hdds.container.ratis.ipc.random.port
` | false | `OZONE`, `DEBUG` | Allocates a random free port for ozone ratis port for the container. This is used only while running unit tests. |
| `hdds.container.ratis.leader.pending.bytes.limit
` | 1GB | `OZONE`, `RATIS`, `PERFORMANCE` | Limit on the total bytes of pending requests after which leader starts rejecting requests from client. |
| `hdds.container.ratis.log.appender.queue.byte-limit
` | 32MB | `OZONE`, `DEBUG`, `CONTAINER`, `RATIS` | Byte limit for ratis leader's log appender queue. |
Russole
approved these changes
Apr 5, 2026
Contributor
Russole
left a comment
There was a problem hiding this comment.
Thanks for the change. It looks good, LGTM!
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
What changes were proposed in this pull request?
dev-support/ci/xml_to_md.pyreads onlyozone-default.xml. It misses other, generated XML files, e.g.hdds-common-default.xml.-default.xmlconfig files, but skipnetwork-topology-default.xml(which is a different kind of config). Also skipozone-filesystem-hadoopshaded jar files, which contain contents from several other jars, no own config.ozone/hadoop-ozone/httpfsgateway/src/main/resources/httpfs-default.xml
Lines 111 to 117 in c0d50fe
https://issues.apache.org/jira/browse/HDDS-14976
How was this patch tested?
Generated config doc:
verified missing properties (e.g.
ozone.tracing.*) are present.https://github.com/adoroszlai/ozone/actions/runs/23983488947/job/69952049151