HDDS-14976. xml_to_md.py does not handle generated XML files#10044
HDDS-14976. xml_to_md.py does not handle generated XML files#10044sarvekshayr merged 3 commits intoapache:masterfrom
Conversation
|
Thanks @adoroszlai for the patch. Overall, LGTM. I just have a few minor comments. |
rich7420
left a comment
There was a problem hiding this comment.
thanks for the patch @adoroszlai
| name = prop.findtext('name') | ||
| if not name: |
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
left a comment
There was a problem hiding this comment.
Thanks for the change. It looks good, LGTM!
|
Thanks @adoroszlai for the patch, @Russole and @rich7420 for the review. |
|
Thanks @rich7420, @Russole, @sarvekshayr for the review. |
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