[
https://issues.apache.org/jira/browse/LUCENE-6188?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=14286294#comment-14286294
]
Robert Muir commented on LUCENE-6188:
-------------------------------------
{quote}
If it's not adding value anymore (e.g. we recently turned on faster javadocs
checking via javac's doclint options), I agree we should remove it: it's slow
and hackity and un-understandable.
{quote}
The doclint stuff added (TRUNK ONLY) is blazing fast and nice, but there is a
good amount of work before its checking html, i see these steps:
* actually turn on html verification in doclint. this can't be done until a lot
of problems are fixed. When they are fixed we can enable "html":
{noformat}-Xdoclint:all/protected -Xdoclint:-html -Xdoclint:-missing{noformat}
* figure out how to check overview.html and package.html. I suspect they are
currently not being checked (but maybe im wrong). Maybe we can ask the openjdk
developers about it.
Then jtidy could be removed completely. python linting is still needed until we
can properly enable "missing" and cutover build logic to that. Then i think its
check-missing could be removed. As far as the python broken links checker, im
not sure if there is a replacement. Ideally we are just using doclint for all
checks in the future.
> Remove HTML verification from checkJavaDocs.py
> ----------------------------------------------
>
> Key: LUCENE-6188
> URL: https://issues.apache.org/jira/browse/LUCENE-6188
> Project: Lucene - Core
> Issue Type: Improvement
> Components: general/javadocs
> Reporter: Ramkumar Aiyengar
> Assignee: Erick Erickson
> Priority: Minor
> Attachments: LUCENE-6188.patch, LUCENE-6188.patch
>
>
> Currently, the broken HTML verification in {{checkJavaDocs.py}} has issues in
> some cases (see SOLR-6902).
> On looking further to fix it with the {{html.parser}} package instead,
> noticed that there is broken HTML verification already present (using
> {{html.parser}}!)in {{checkJavadocLinks.py}} anyway which takes care of
> validation, and probably {{jTidy}} does it as well, going by the output
> (haven't verified it).
> Given this, the validation in {{checkJavaDocs.py}} doesn't seem to add any
> further value, so here's a patch to just nuke it instead.
--
This message was sent by Atlassian JIRA
(v6.3.4#6332)
---------------------------------------------------------------------
To unsubscribe, e-mail: [email protected]
For additional commands, e-mail: [email protected]
