You are viewing a plain text version of this content. The canonical link for it is here.
Posted to issues@ozone.apache.org by "adoroszlai (via GitHub)" <gi...@apache.org> on 2026/04/04 17:22:30 UTC

[PR] HDDS-14976. xml_to_md.py does not handle generated XML files [ozone]

adoroszlai opened a new pull request, #10044:
URL: https://github.com/apache/ozone/pull/10044

   ## What changes were proposed in this pull request?
   
   `dev-support/ci/xml_to_md.py` reads only `ozone-default.xml`.  It misses other, generated XML files, e.g. `hdds-common-default.xml`.
   
   - Handle all `-default.xml` config files, but skip `network-topology-default.xml` (which is a different kind of config).  Also skip `ozone-filesystem-hadoop` shaded jar files, which contain contents from several other jars, no own config.
   - Further tweak default values to handle special value: https://github.com/apache/ozone/blob/c0d50fe17d27fb6fbb7b20fabea0157e537c1e55/hadoop-ozone/httpfsgateway/src/main/resources/httpfs-default.xml#L111-L117
   
   https://issues.apache.org/jira/browse/HDDS-14976
   
   ## How was this patch tested?
   
   Generated config doc:
   
   ```bash
   python3 dev-support/ci/xml_to_md.py hadoop-ozone/dist/target after.md
   ```
   
   verified missing properties (e.g. `ozone.tracing.*`) are present.
   
   https://github.com/adoroszlai/ozone/actions/runs/23983488947/job/69952049151


-- 
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.

To unsubscribe, e-mail: issues-unsubscribe@ozone.apache.org

For queries about this service, please contact Infrastructure at:
users@infra.apache.org


---------------------------------------------------------------------
To unsubscribe, e-mail: issues-unsubscribe@ozone.apache.org
For additional commands, e-mail: issues-help@ozone.apache.org


Re: [PR] HDDS-14976. xml_to_md.py does not handle generated XML files [ozone]

Posted by "sarvekshayr (via GitHub)" <gi...@apache.org>.
sarvekshayr merged PR #10044:
URL: https://github.com/apache/ozone/pull/10044


-- 
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.

To unsubscribe, e-mail: issues-unsubscribe@ozone.apache.org

For queries about this service, please contact Infrastructure at:
users@infra.apache.org


---------------------------------------------------------------------
To unsubscribe, e-mail: issues-unsubscribe@ozone.apache.org
For additional commands, e-mail: issues-help@ozone.apache.org


Re: [PR] HDDS-14976. xml_to_md.py does not handle generated XML files [ozone]

Posted by "adoroszlai (via GitHub)" <gi...@apache.org>.
adoroszlai commented on code in PR #10044:
URL: https://github.com/apache/ozone/pull/10044#discussion_r3036499659


##########
dev-support/ci/xml_to_md.py:
##########


Review Comment:
   Thanks @Russole for spotting this.



-- 
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.

To unsubscribe, e-mail: issues-unsubscribe@ozone.apache.org

For queries about this service, please contact Infrastructure at:
users@infra.apache.org


---------------------------------------------------------------------
To unsubscribe, e-mail: issues-unsubscribe@ozone.apache.org
For additional commands, e-mail: issues-help@ozone.apache.org


Re: [PR] HDDS-14976. xml_to_md.py does not handle generated XML files [ozone]

Posted by "Russole (via GitHub)" <gi...@apache.org>.
Russole commented on code in PR #10044:
URL: https://github.com/apache/ozone/pull/10044#discussion_r3036263365


##########
dev-support/ci/xml_to_md.py:
##########


Review 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. |
   ```



-- 
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.

To unsubscribe, e-mail: issues-unsubscribe@ozone.apache.org

For queries about this service, please contact Infrastructure at:
users@infra.apache.org


---------------------------------------------------------------------
To unsubscribe, e-mail: issues-unsubscribe@ozone.apache.org
For additional commands, e-mail: issues-help@ozone.apache.org


Re: [PR] HDDS-14976. xml_to_md.py does not handle generated XML files [ozone]

Posted by "Russole (via GitHub)" <gi...@apache.org>.
Russole commented on PR #10044:
URL: https://github.com/apache/ozone/pull/10044#issuecomment-4188060360

   Thanks @adoroszlai for the patch. Overall, LGTM. I just have a few minor comments.


-- 
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.

To unsubscribe, e-mail: issues-unsubscribe@ozone.apache.org

For queries about this service, please contact Infrastructure at:
users@infra.apache.org


---------------------------------------------------------------------
To unsubscribe, e-mail: issues-unsubscribe@ozone.apache.org
For additional commands, e-mail: issues-help@ozone.apache.org


Re: [PR] HDDS-14976. xml_to_md.py does not handle generated XML files [ozone]

Posted by "sarvekshayr (via GitHub)" <gi...@apache.org>.
sarvekshayr commented on PR #10044:
URL: https://github.com/apache/ozone/pull/10044#issuecomment-4190698973

   Thanks @adoroszlai for the patch, @Russole and @rich7420 for the review.


-- 
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.

To unsubscribe, e-mail: issues-unsubscribe@ozone.apache.org

For queries about this service, please contact Infrastructure at:
users@infra.apache.org


---------------------------------------------------------------------
To unsubscribe, e-mail: issues-unsubscribe@ozone.apache.org
For additional commands, e-mail: issues-help@ozone.apache.org


Re: [PR] HDDS-14976. xml_to_md.py does not handle generated XML files [ozone]

Posted by "adoroszlai (via GitHub)" <gi...@apache.org>.
adoroszlai commented on PR #10044:
URL: https://github.com/apache/ozone/pull/10044#issuecomment-4190784101

   Thanks @rich7420, @Russole, @sarvekshayr for the review.


-- 
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.

To unsubscribe, e-mail: issues-unsubscribe@ozone.apache.org

For queries about this service, please contact Infrastructure at:
users@infra.apache.org


---------------------------------------------------------------------
To unsubscribe, e-mail: issues-unsubscribe@ozone.apache.org
For additional commands, e-mail: issues-help@ozone.apache.org