improve checkJavadocLinks.py to detect "invalid reference" #14287
Conversation
This file contains 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
See background by @mkhludnev on the dev list: https://lists.apache.org/thread/pm1szr9og6qhmjzp371xwk0mvwxxkd1l In some cases: "invalid reference" is generated, passes through Xdoclint and broken-link checkers, yet links are broken. Instead of a 404, javadocs seems to emit this in the resulting HTML: <details class="invalid-tag"> <summary>invalid reference</summary> <pre>flexible query parser</pre> </details Fix checkJavadocLinks.py to fail the build on these. Closes apache#14285
asfgit
pushed a commit
that referenced
this pull request
Feb 25, 2025
See background by @mkhludnev on the dev list: https://lists.apache.org/thread/pm1szr9og6qhmjzp371xwk0mvwxxkd1l In some cases: "invalid reference" is generated, passes through Xdoclint and broken-link checkers, yet links are broken. Instead of a 404, javadocs seems to emit this in the resulting HTML: <details class="invalid-tag"> <summary>invalid reference</summary> <pre>flexible query parser</pre> </details Fix checkJavadocLinks.py to fail the build on these. Closes #14285
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.
See background by @mkhludnev on the dev list: https://lists.apache.org/thread/pm1szr9og6qhmjzp371xwk0mvwxxkd1l
In some cases: "invalid reference" is generated, passes through Xdoclint and broken-link checkers, yet links are broken.
Instead of a 404, javadocs seems to emit this in the resulting HTML:
Fix
checkJavadocLinks.pyto fail the build on these.Closes #14285
Note: I rewound to before the fix was committed to this issue and validated it fails build. Not great error but par for the course for this checker, and it does the job.
