You are viewing a plain text version of this content. The canonical link for it is here.
Posted to issues@maven.apache.org by "suryakant-source (via GitHub)" <gi...@apache.org> on 2026/10/22 11:54:39 UTC
[PR] docs: fix rendering of element names in repositoryOrigins/settings descriptions [maven]
suryakant-source opened a new pull request, #13680:
URL: https://github.com/apache/maven/pull/13680
Fixes #13675.
## Problem
On https://maven.apache.org/ref/3.10.0/maven-settings/settings.html, several descriptions render with an empty inline code element, e.g. "not listed in `<code></code>` but activated through `<code></code>` or `<code>-P</code>`", so the element names (`<server>`, `<activeProfile>`, ...) are swallowed.
## Root cause
In `api/maven-api-settings/src/main/mdo/settings.mdo`, the affected descriptions write the element names as `{@code <X>}`. After the .mdo XML decoding, modello-plugin-xdoc's `rewrite()` (javadoc-parser + jsoup) receives `{@code <X>}` and generates `<code><X></X></code>`: the unknown element inside `<code>` is dropped downstream, leaving an empty code element. The raw-markup form `<code><X></code>`, already used elsewhere in the same file, survives the pipeline and renders correctly.
I reproduced this locally with the exact `rewrite()` code path of modello-plugin-xdoc using modello's pinned versions (javadoc-parser 0.3.1, jsoup 1.23.2): the `{@code <X>}` form produces the nested/broken markup while `<code><X></code>` produces the correct output.
## Solution
Switch the affected descriptions in `settings.mdo` (proxy, server, activeProfiles, activation, property.name) from `{@code <X>}` to `<code><X></code>`. This form renders correctly in both the generated site page and the generated javadoc.
## Testing
- Local repro harness against modello-plugin-xdoc's `rewrite()` code path (javadoc-parser 0.3.1 + jsoup 1.23.2): verified broken output before and correct output after for each of the 5 changed spots.
- Verified the modified `settings.mdo` is still well-formed XML.
- I could not run the full Maven site build in my environment (no Maven available), so the regenerated site page itself was not rebuilt.
## Risk
Low: docs-source-only change. Note: the same `{@code <...>}` pattern exists in other .mdo files (e.g. `maven.mdo`); I left those untouched here and can follow up if the maintainers want them fixed the same way.
--
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@maven.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
Re: [PR] docs: fix rendering of element names in repositoryOrigins/settings descriptions [maven]
Posted by "gnodet (via GitHub)" <gi...@apache.org>.
gnodet commented on PR #13680:
URL: https://github.com/apache/maven/pull/13680#issuecomment-6341209940
Closing in favour of #13678 which fixes the same issue (#13675) more broadly across all .mdo files.
--
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@maven.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
Re: [PR] docs: fix rendering of element names in repositoryOrigins/settings descriptions [maven]
Posted by "gnodet (via GitHub)" <gi...@apache.org>.
gnodet closed pull request #13680: docs: fix rendering of element names in repositoryOrigins/settings descriptions
URL: https://github.com/apache/maven/pull/13680
--
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@maven.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
Re: [PR] docs: fix rendering of element names in repositoryOrigins/settings descriptions [maven]
Posted by "suryakant-source (via GitHub)" <gi...@apache.org>.
suryakant-source commented on PR #13680:
URL: https://github.com/apache/maven/pull/13680#issuecomment-6341255452
Makes sense, thanks @gnodet - #13678 covering all .mdo files is the better fix. Closing this one.
--
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@maven.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org