You are viewing a plain text version of this content. The canonical link for it is here.
Posted to dev@lucene.apache.org by "Robert Muir (JIRA)" <ji...@apache.org> on 2012/04/22 23:37:33 UTC
[jira] [Created] (LUCENE-4011) Check for broken documentation links
in hudson
Robert Muir created LUCENE-4011:
-----------------------------------
Summary: Check for broken documentation links in hudson
Key: LUCENE-4011
URL: https://issues.apache.org/jira/browse/LUCENE-4011
Project: Lucene - Java
Issue Type: Task
Components: general/javadocs
Reporter: Robert Muir
Fix For: 4.0
Mike added a cool script to dev-tools (checkJavadocLinks.py) that checks
all local links in our documentation.
I think we really need to check this in hudson and fail on any errors, for these reasons:
* javadocs external linking is really broken, so 'ant javadocs' doesnt find all errors.
for example you can do this:
{noformat}
{@link java.lang.JavaDocsSucks}
{noformat}
and nothing will ever give you any warning: just a broken link. thats because javadocs
external linking is fundamentally package-driven, broken by design for compile-time
verification of correctness.
* some documentation files have internal href links which should be checked to be correct.
* this checker finds broken html links like unescaped slashes that we currently don't catch.
* this checker finds real API bugs that javadocs won't warn about, such as protected methods
returning package-private classes and so on.
Once we fix the broken links we should be able to enforce all of this stuff in hudson, helping
to prevent our documentation from growing wildly out of date.
--
This message is automatically generated by JIRA.
If you think it was sent incorrectly, please contact your JIRA administrators: https://issues.apache.org/jira/secure/ContactAdministrators!default.jspa
For more information on JIRA, see: http://www.atlassian.com/software/jira
---------------------------------------------------------------------
To unsubscribe, e-mail: dev-unsubscribe@lucene.apache.org
For additional commands, e-mail: dev-help@lucene.apache.org
[jira] [Updated] (LUCENE-4011) Check for broken documentation links
in hudson
Posted by "Chris Male (JIRA)" <ji...@apache.org>.
[ https://issues.apache.org/jira/browse/LUCENE-4011?page=com.atlassian.jira.plugin.system.issuetabpanels:all-tabpanel ]
Chris Male updated LUCENE-4011:
-------------------------------
Attachment: LUCENE-4011-solr-links.patch
And for completion, solr. Will commit this now.
> Check for broken documentation links in hudson
> ----------------------------------------------
>
> Key: LUCENE-4011
> URL: https://issues.apache.org/jira/browse/LUCENE-4011
> Project: Lucene - Java
> Issue Type: Task
> Components: general/javadocs
> Reporter: Robert Muir
> Fix For: 4.0
>
> Attachments: LUCENE-4011-core-links.patch, LUCENE-4011-lucene-links.patch, LUCENE-4011-solr-links.patch
>
>
> Mike added a cool script to dev-tools (checkJavadocLinks.py) that checks
> all local links in our documentation.
> I think we really need to check this in hudson and fail on any errors, for these reasons:
> * javadocs external linking is really broken, so 'ant javadocs' doesnt find all errors.
> for example you can do this:
> {noformat}
> {@link java.lang.JavaDocsSucks}
> {noformat}
> and nothing will ever give you any warning: just a broken link. thats because javadocs
> external linking is fundamentally package-driven, broken by design for compile-time
> verification of correctness.
> * some documentation files have internal href links which should be checked to be correct.
> * this checker finds broken html links like unescaped slashes that we currently don't catch.
> * this checker finds real API bugs that javadocs won't warn about, such as protected methods
> returning package-private classes and so on.
> Once we fix the broken links we should be able to enforce all of this stuff in hudson, helping
> to prevent our documentation from growing wildly out of date.
--
This message is automatically generated by JIRA.
If you think it was sent incorrectly, please contact your JIRA administrators: https://issues.apache.org/jira/secure/ContactAdministrators!default.jspa
For more information on JIRA, see: http://www.atlassian.com/software/jira
---------------------------------------------------------------------
To unsubscribe, e-mail: dev-unsubscribe@lucene.apache.org
For additional commands, e-mail: dev-help@lucene.apache.org
[jira] [Commented] (LUCENE-4011) Check for broken documentation
links in hudson
Posted by "Robert Muir (JIRA)" <ji...@apache.org>.
[ https://issues.apache.org/jira/browse/LUCENE-4011?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=13259607#comment-13259607 ]
Robert Muir commented on LUCENE-4011:
-------------------------------------
Two broken links left and we can kick this one on for Solr.
One is caused by lucene package organization (LUCENE-4015)
The other i have no clue yet about (need to investigate). Maybe another javadocs generification bug.
> Check for broken documentation links in hudson
> ----------------------------------------------
>
> Key: LUCENE-4011
> URL: https://issues.apache.org/jira/browse/LUCENE-4011
> Project: Lucene - Java
> Issue Type: Task
> Components: general/javadocs
> Reporter: Robert Muir
> Fix For: 4.0
>
> Attachments: LUCENE-4011-core-links.patch, LUCENE-4011-lucene-links.patch, LUCENE-4011-solr-links.patch, LUCENE-4011.patch
>
>
> Mike added a cool script to dev-tools (checkJavadocLinks.py) that checks
> all local links in our documentation.
> I think we really need to check this in hudson and fail on any errors, for these reasons:
> * javadocs external linking is really broken, so 'ant javadocs' doesnt find all errors.
> for example you can do this:
> {noformat}
> {@link java.lang.JavaDocsSucks}
> {noformat}
> and nothing will ever give you any warning: just a broken link. thats because javadocs
> external linking is fundamentally package-driven, broken by design for compile-time
> verification of correctness.
> * some documentation files have internal href links which should be checked to be correct.
> * this checker finds broken html links like unescaped slashes that we currently don't catch.
> * this checker finds real API bugs that javadocs won't warn about, such as protected methods
> returning package-private classes and so on.
> Once we fix the broken links we should be able to enforce all of this stuff in hudson, helping
> to prevent our documentation from growing wildly out of date.
--
This message is automatically generated by JIRA.
If you think it was sent incorrectly, please contact your JIRA administrators: https://issues.apache.org/jira/secure/ContactAdministrators!default.jspa
For more information on JIRA, see: http://www.atlassian.com/software/jira
---------------------------------------------------------------------
To unsubscribe, e-mail: dev-unsubscribe@lucene.apache.org
For additional commands, e-mail: dev-help@lucene.apache.org
[jira] [Updated] (LUCENE-4011) Check for broken documentation links
in hudson
Posted by "Robert Muir (JIRA)" <ji...@apache.org>.
[ https://issues.apache.org/jira/browse/LUCENE-4011?page=com.atlassian.jira.plugin.system.issuetabpanels:all-tabpanel ]
Robert Muir updated LUCENE-4011:
--------------------------------
Attachment: LUCENE-4011.patch
here's the ant task (for running locally or on hudson). the links are fixed for lucene, we can actually turn this on right now if we want in hudson jobs.
for solr we have to go thru the same process (starting with html escaping etc) before we can enable it, but the task is here.
> Check for broken documentation links in hudson
> ----------------------------------------------
>
> Key: LUCENE-4011
> URL: https://issues.apache.org/jira/browse/LUCENE-4011
> Project: Lucene - Java
> Issue Type: Task
> Components: general/javadocs
> Reporter: Robert Muir
> Fix For: 4.0
>
> Attachments: LUCENE-4011-core-links.patch, LUCENE-4011-lucene-links.patch, LUCENE-4011-solr-links.patch, LUCENE-4011.patch
>
>
> Mike added a cool script to dev-tools (checkJavadocLinks.py) that checks
> all local links in our documentation.
> I think we really need to check this in hudson and fail on any errors, for these reasons:
> * javadocs external linking is really broken, so 'ant javadocs' doesnt find all errors.
> for example you can do this:
> {noformat}
> {@link java.lang.JavaDocsSucks}
> {noformat}
> and nothing will ever give you any warning: just a broken link. thats because javadocs
> external linking is fundamentally package-driven, broken by design for compile-time
> verification of correctness.
> * some documentation files have internal href links which should be checked to be correct.
> * this checker finds broken html links like unescaped slashes that we currently don't catch.
> * this checker finds real API bugs that javadocs won't warn about, such as protected methods
> returning package-private classes and so on.
> Once we fix the broken links we should be able to enforce all of this stuff in hudson, helping
> to prevent our documentation from growing wildly out of date.
--
This message is automatically generated by JIRA.
If you think it was sent incorrectly, please contact your JIRA administrators: https://issues.apache.org/jira/secure/ContactAdministrators!default.jspa
For more information on JIRA, see: http://www.atlassian.com/software/jira
---------------------------------------------------------------------
To unsubscribe, e-mail: dev-unsubscribe@lucene.apache.org
For additional commands, e-mail: dev-help@lucene.apache.org
[jira] [Resolved] (LUCENE-4011) Check for broken documentation
links in hudson
Posted by "Robert Muir (JIRA)" <ji...@apache.org>.
[ https://issues.apache.org/jira/browse/LUCENE-4011?page=com.atlassian.jira.plugin.system.issuetabpanels:all-tabpanel ]
Robert Muir resolved LUCENE-4011.
---------------------------------
Resolution: Fixed
> Check for broken documentation links in hudson
> ----------------------------------------------
>
> Key: LUCENE-4011
> URL: https://issues.apache.org/jira/browse/LUCENE-4011
> Project: Lucene - Java
> Issue Type: Task
> Components: general/javadocs
> Reporter: Robert Muir
> Fix For: 4.0
>
> Attachments: LUCENE-4011-core-links.patch, LUCENE-4011-lucene-links.patch, LUCENE-4011-solr-links.patch, LUCENE-4011.patch
>
>
> Mike added a cool script to dev-tools (checkJavadocLinks.py) that checks
> all local links in our documentation.
> I think we really need to check this in hudson and fail on any errors, for these reasons:
> * javadocs external linking is really broken, so 'ant javadocs' doesnt find all errors.
> for example you can do this:
> {noformat}
> {@link java.lang.JavaDocsSucks}
> {noformat}
> and nothing will ever give you any warning: just a broken link. thats because javadocs
> external linking is fundamentally package-driven, broken by design for compile-time
> verification of correctness.
> * some documentation files have internal href links which should be checked to be correct.
> * this checker finds broken html links like unescaped slashes that we currently don't catch.
> * this checker finds real API bugs that javadocs won't warn about, such as protected methods
> returning package-private classes and so on.
> Once we fix the broken links we should be able to enforce all of this stuff in hudson, helping
> to prevent our documentation from growing wildly out of date.
--
This message is automatically generated by JIRA.
If you think it was sent incorrectly, please contact your JIRA administrators: https://issues.apache.org/jira/secure/ContactAdministrators!default.jspa
For more information on JIRA, see: http://www.atlassian.com/software/jira
---------------------------------------------------------------------
To unsubscribe, e-mail: dev-unsubscribe@lucene.apache.org
For additional commands, e-mail: dev-help@lucene.apache.org
[jira] [Commented] (LUCENE-4011) Check for broken documentation
links in hudson
Posted by "Robert Muir (JIRA)" <ji...@apache.org>.
[ https://issues.apache.org/jira/browse/LUCENE-4011?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=13259639#comment-13259639 ]
Robert Muir commented on LUCENE-4011:
-------------------------------------
The last solr broken link (on java7, on java6, there are more)
seems to be a bug in javadocs?
{noformat}
[exec] build/docs/api/constant-values.html
[exec] BROKEN ANCHOR: build/docs/api/org/apache/solr/client/solrj/beans/Field.html#DEFAULT
[exec]
[exec] build/docs/api/solrj/constant-values.html
[exec] BROKEN ANCHOR: build/docs/api/solrj/org/apache/solr/client/solrj/beans/Field.html#DEFAULT
{noformat}
The problem is that this Field is an annotation with a 'public static final String DEFAULT',
and javadocs doesn't generate any documentation for this constant in Field.html itself,
but refers to it elsewhere.
I think we can exclude this one in the checker since its not our fault... unless I am missing something?
> Check for broken documentation links in hudson
> ----------------------------------------------
>
> Key: LUCENE-4011
> URL: https://issues.apache.org/jira/browse/LUCENE-4011
> Project: Lucene - Java
> Issue Type: Task
> Components: general/javadocs
> Reporter: Robert Muir
> Fix For: 4.0
>
> Attachments: LUCENE-4011-core-links.patch, LUCENE-4011-lucene-links.patch, LUCENE-4011-solr-links.patch, LUCENE-4011.patch
>
>
> Mike added a cool script to dev-tools (checkJavadocLinks.py) that checks
> all local links in our documentation.
> I think we really need to check this in hudson and fail on any errors, for these reasons:
> * javadocs external linking is really broken, so 'ant javadocs' doesnt find all errors.
> for example you can do this:
> {noformat}
> {@link java.lang.JavaDocsSucks}
> {noformat}
> and nothing will ever give you any warning: just a broken link. thats because javadocs
> external linking is fundamentally package-driven, broken by design for compile-time
> verification of correctness.
> * some documentation files have internal href links which should be checked to be correct.
> * this checker finds broken html links like unescaped slashes that we currently don't catch.
> * this checker finds real API bugs that javadocs won't warn about, such as protected methods
> returning package-private classes and so on.
> Once we fix the broken links we should be able to enforce all of this stuff in hudson, helping
> to prevent our documentation from growing wildly out of date.
--
This message is automatically generated by JIRA.
If you think it was sent incorrectly, please contact your JIRA administrators: https://issues.apache.org/jira/secure/ContactAdministrators!default.jspa
For more information on JIRA, see: http://www.atlassian.com/software/jira
---------------------------------------------------------------------
To unsubscribe, e-mail: dev-unsubscribe@lucene.apache.org
For additional commands, e-mail: dev-help@lucene.apache.org
[jira] [Updated] (LUCENE-4011) Check for broken documentation links
in hudson
Posted by "Chris Male (JIRA)" <ji...@apache.org>.
[ https://issues.apache.org/jira/browse/LUCENE-4011?page=com.atlassian.jira.plugin.system.issuetabpanels:all-tabpanel ]
Chris Male updated LUCENE-4011:
-------------------------------
Attachment: LUCENE-4011-core-links.patch
IntelliJ can also identify what it deems to be broken links, primarily when a class or method do not exist, or when a class is used in a link but not imported.
I'm attaching a patch which fixes these for lucene-core. Tell me what you think.
> Check for broken documentation links in hudson
> ----------------------------------------------
>
> Key: LUCENE-4011
> URL: https://issues.apache.org/jira/browse/LUCENE-4011
> Project: Lucene - Java
> Issue Type: Task
> Components: general/javadocs
> Reporter: Robert Muir
> Fix For: 4.0
>
> Attachments: LUCENE-4011-core-links.patch
>
>
> Mike added a cool script to dev-tools (checkJavadocLinks.py) that checks
> all local links in our documentation.
> I think we really need to check this in hudson and fail on any errors, for these reasons:
> * javadocs external linking is really broken, so 'ant javadocs' doesnt find all errors.
> for example you can do this:
> {noformat}
> {@link java.lang.JavaDocsSucks}
> {noformat}
> and nothing will ever give you any warning: just a broken link. thats because javadocs
> external linking is fundamentally package-driven, broken by design for compile-time
> verification of correctness.
> * some documentation files have internal href links which should be checked to be correct.
> * this checker finds broken html links like unescaped slashes that we currently don't catch.
> * this checker finds real API bugs that javadocs won't warn about, such as protected methods
> returning package-private classes and so on.
> Once we fix the broken links we should be able to enforce all of this stuff in hudson, helping
> to prevent our documentation from growing wildly out of date.
--
This message is automatically generated by JIRA.
If you think it was sent incorrectly, please contact your JIRA administrators: https://issues.apache.org/jira/secure/ContactAdministrators!default.jspa
For more information on JIRA, see: http://www.atlassian.com/software/jira
---------------------------------------------------------------------
To unsubscribe, e-mail: dev-unsubscribe@lucene.apache.org
For additional commands, e-mail: dev-help@lucene.apache.org
[jira] [Commented] (LUCENE-4011) Check for broken documentation
links in hudson
Posted by "Robert Muir (JIRA)" <ji...@apache.org>.
[ https://issues.apache.org/jira/browse/LUCENE-4011?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=13259311#comment-13259311 ]
Robert Muir commented on LUCENE-4011:
-------------------------------------
patch looks like it fixes a bunch of bogus stuff :)
I just glanced thru it, but looks good.
> Check for broken documentation links in hudson
> ----------------------------------------------
>
> Key: LUCENE-4011
> URL: https://issues.apache.org/jira/browse/LUCENE-4011
> Project: Lucene - Java
> Issue Type: Task
> Components: general/javadocs
> Reporter: Robert Muir
> Fix For: 4.0
>
> Attachments: LUCENE-4011-core-links.patch
>
>
> Mike added a cool script to dev-tools (checkJavadocLinks.py) that checks
> all local links in our documentation.
> I think we really need to check this in hudson and fail on any errors, for these reasons:
> * javadocs external linking is really broken, so 'ant javadocs' doesnt find all errors.
> for example you can do this:
> {noformat}
> {@link java.lang.JavaDocsSucks}
> {noformat}
> and nothing will ever give you any warning: just a broken link. thats because javadocs
> external linking is fundamentally package-driven, broken by design for compile-time
> verification of correctness.
> * some documentation files have internal href links which should be checked to be correct.
> * this checker finds broken html links like unescaped slashes that we currently don't catch.
> * this checker finds real API bugs that javadocs won't warn about, such as protected methods
> returning package-private classes and so on.
> Once we fix the broken links we should be able to enforce all of this stuff in hudson, helping
> to prevent our documentation from growing wildly out of date.
--
This message is automatically generated by JIRA.
If you think it was sent incorrectly, please contact your JIRA administrators: https://issues.apache.org/jira/secure/ContactAdministrators!default.jspa
For more information on JIRA, see: http://www.atlassian.com/software/jira
---------------------------------------------------------------------
To unsubscribe, e-mail: dev-unsubscribe@lucene.apache.org
For additional commands, e-mail: dev-help@lucene.apache.org
[jira] [Commented] (LUCENE-4011) Check for broken documentation
links in hudson
Posted by "Robert Muir (JIRA)" <ji...@apache.org>.
[ https://issues.apache.org/jira/browse/LUCENE-4011?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=13259644#comment-13259644 ]
Robert Muir commented on LUCENE-4011:
-------------------------------------
I added an exclusion for this one, and enabled link checking for solr too.
> Check for broken documentation links in hudson
> ----------------------------------------------
>
> Key: LUCENE-4011
> URL: https://issues.apache.org/jira/browse/LUCENE-4011
> Project: Lucene - Java
> Issue Type: Task
> Components: general/javadocs
> Reporter: Robert Muir
> Fix For: 4.0
>
> Attachments: LUCENE-4011-core-links.patch, LUCENE-4011-lucene-links.patch, LUCENE-4011-solr-links.patch, LUCENE-4011.patch
>
>
> Mike added a cool script to dev-tools (checkJavadocLinks.py) that checks
> all local links in our documentation.
> I think we really need to check this in hudson and fail on any errors, for these reasons:
> * javadocs external linking is really broken, so 'ant javadocs' doesnt find all errors.
> for example you can do this:
> {noformat}
> {@link java.lang.JavaDocsSucks}
> {noformat}
> and nothing will ever give you any warning: just a broken link. thats because javadocs
> external linking is fundamentally package-driven, broken by design for compile-time
> verification of correctness.
> * some documentation files have internal href links which should be checked to be correct.
> * this checker finds broken html links like unescaped slashes that we currently don't catch.
> * this checker finds real API bugs that javadocs won't warn about, such as protected methods
> returning package-private classes and so on.
> Once we fix the broken links we should be able to enforce all of this stuff in hudson, helping
> to prevent our documentation from growing wildly out of date.
--
This message is automatically generated by JIRA.
If you think it was sent incorrectly, please contact your JIRA administrators: https://issues.apache.org/jira/secure/ContactAdministrators!default.jspa
For more information on JIRA, see: http://www.atlassian.com/software/jira
---------------------------------------------------------------------
To unsubscribe, e-mail: dev-unsubscribe@lucene.apache.org
For additional commands, e-mail: dev-help@lucene.apache.org
[jira] [Commented] (LUCENE-4011) Check for broken documentation
links in hudson
Posted by "Michael McCandless (JIRA)" <ji...@apache.org>.
[ https://issues.apache.org/jira/browse/LUCENE-4011?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=13259599#comment-13259599 ]
Michael McCandless commented on LUCENE-4011:
--------------------------------------------
Thanks Robert! So nice to have an "ant javadocs-lint" target now...
> Check for broken documentation links in hudson
> ----------------------------------------------
>
> Key: LUCENE-4011
> URL: https://issues.apache.org/jira/browse/LUCENE-4011
> Project: Lucene - Java
> Issue Type: Task
> Components: general/javadocs
> Reporter: Robert Muir
> Fix For: 4.0
>
> Attachments: LUCENE-4011-core-links.patch, LUCENE-4011-lucene-links.patch, LUCENE-4011-solr-links.patch, LUCENE-4011.patch
>
>
> Mike added a cool script to dev-tools (checkJavadocLinks.py) that checks
> all local links in our documentation.
> I think we really need to check this in hudson and fail on any errors, for these reasons:
> * javadocs external linking is really broken, so 'ant javadocs' doesnt find all errors.
> for example you can do this:
> {noformat}
> {@link java.lang.JavaDocsSucks}
> {noformat}
> and nothing will ever give you any warning: just a broken link. thats because javadocs
> external linking is fundamentally package-driven, broken by design for compile-time
> verification of correctness.
> * some documentation files have internal href links which should be checked to be correct.
> * this checker finds broken html links like unescaped slashes that we currently don't catch.
> * this checker finds real API bugs that javadocs won't warn about, such as protected methods
> returning package-private classes and so on.
> Once we fix the broken links we should be able to enforce all of this stuff in hudson, helping
> to prevent our documentation from growing wildly out of date.
--
This message is automatically generated by JIRA.
If you think it was sent incorrectly, please contact your JIRA administrators: https://issues.apache.org/jira/secure/ContactAdministrators!default.jspa
For more information on JIRA, see: http://www.atlassian.com/software/jira
---------------------------------------------------------------------
To unsubscribe, e-mail: dev-unsubscribe@lucene.apache.org
For additional commands, e-mail: dev-help@lucene.apache.org
[jira] [Commented] (LUCENE-4011) Check for broken documentation
links in hudson
Posted by "Robert Muir (JIRA)" <ji...@apache.org>.
[ https://issues.apache.org/jira/browse/LUCENE-4011?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=13259319#comment-13259319 ]
Robert Muir commented on LUCENE-4011:
-------------------------------------
took another look, +1
> Check for broken documentation links in hudson
> ----------------------------------------------
>
> Key: LUCENE-4011
> URL: https://issues.apache.org/jira/browse/LUCENE-4011
> Project: Lucene - Java
> Issue Type: Task
> Components: general/javadocs
> Reporter: Robert Muir
> Fix For: 4.0
>
> Attachments: LUCENE-4011-core-links.patch
>
>
> Mike added a cool script to dev-tools (checkJavadocLinks.py) that checks
> all local links in our documentation.
> I think we really need to check this in hudson and fail on any errors, for these reasons:
> * javadocs external linking is really broken, so 'ant javadocs' doesnt find all errors.
> for example you can do this:
> {noformat}
> {@link java.lang.JavaDocsSucks}
> {noformat}
> and nothing will ever give you any warning: just a broken link. thats because javadocs
> external linking is fundamentally package-driven, broken by design for compile-time
> verification of correctness.
> * some documentation files have internal href links which should be checked to be correct.
> * this checker finds broken html links like unescaped slashes that we currently don't catch.
> * this checker finds real API bugs that javadocs won't warn about, such as protected methods
> returning package-private classes and so on.
> Once we fix the broken links we should be able to enforce all of this stuff in hudson, helping
> to prevent our documentation from growing wildly out of date.
--
This message is automatically generated by JIRA.
If you think it was sent incorrectly, please contact your JIRA administrators: https://issues.apache.org/jira/secure/ContactAdministrators!default.jspa
For more information on JIRA, see: http://www.atlassian.com/software/jira
---------------------------------------------------------------------
To unsubscribe, e-mail: dev-unsubscribe@lucene.apache.org
For additional commands, e-mail: dev-help@lucene.apache.org
[jira] [Commented] (LUCENE-4011) Check for broken documentation
links in hudson
Posted by "Robert Muir (JIRA)" <ji...@apache.org>.
[ https://issues.apache.org/jira/browse/LUCENE-4011?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=13259375#comment-13259375 ]
Robert Muir commented on LUCENE-4011:
-------------------------------------
I committed the script... tomorrow will test on hudson before adding to nightly tasks,
and then tackle the solr pieces.
> Check for broken documentation links in hudson
> ----------------------------------------------
>
> Key: LUCENE-4011
> URL: https://issues.apache.org/jira/browse/LUCENE-4011
> Project: Lucene - Java
> Issue Type: Task
> Components: general/javadocs
> Reporter: Robert Muir
> Fix For: 4.0
>
> Attachments: LUCENE-4011-core-links.patch, LUCENE-4011-lucene-links.patch, LUCENE-4011-solr-links.patch, LUCENE-4011.patch
>
>
> Mike added a cool script to dev-tools (checkJavadocLinks.py) that checks
> all local links in our documentation.
> I think we really need to check this in hudson and fail on any errors, for these reasons:
> * javadocs external linking is really broken, so 'ant javadocs' doesnt find all errors.
> for example you can do this:
> {noformat}
> {@link java.lang.JavaDocsSucks}
> {noformat}
> and nothing will ever give you any warning: just a broken link. thats because javadocs
> external linking is fundamentally package-driven, broken by design for compile-time
> verification of correctness.
> * some documentation files have internal href links which should be checked to be correct.
> * this checker finds broken html links like unescaped slashes that we currently don't catch.
> * this checker finds real API bugs that javadocs won't warn about, such as protected methods
> returning package-private classes and so on.
> Once we fix the broken links we should be able to enforce all of this stuff in hudson, helping
> to prevent our documentation from growing wildly out of date.
--
This message is automatically generated by JIRA.
If you think it was sent incorrectly, please contact your JIRA administrators: https://issues.apache.org/jira/secure/ContactAdministrators!default.jspa
For more information on JIRA, see: http://www.atlassian.com/software/jira
---------------------------------------------------------------------
To unsubscribe, e-mail: dev-unsubscribe@lucene.apache.org
For additional commands, e-mail: dev-help@lucene.apache.org
[jira] [Commented] (LUCENE-4011) Check for broken documentation
links in hudson
Posted by "Robert Muir (JIRA)" <ji...@apache.org>.
[ https://issues.apache.org/jira/browse/LUCENE-4011?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=13259329#comment-13259329 ]
Robert Muir commented on LUCENE-4011:
-------------------------------------
+1
> Check for broken documentation links in hudson
> ----------------------------------------------
>
> Key: LUCENE-4011
> URL: https://issues.apache.org/jira/browse/LUCENE-4011
> Project: Lucene - Java
> Issue Type: Task
> Components: general/javadocs
> Reporter: Robert Muir
> Fix For: 4.0
>
> Attachments: LUCENE-4011-core-links.patch, LUCENE-4011-lucene-links.patch
>
>
> Mike added a cool script to dev-tools (checkJavadocLinks.py) that checks
> all local links in our documentation.
> I think we really need to check this in hudson and fail on any errors, for these reasons:
> * javadocs external linking is really broken, so 'ant javadocs' doesnt find all errors.
> for example you can do this:
> {noformat}
> {@link java.lang.JavaDocsSucks}
> {noformat}
> and nothing will ever give you any warning: just a broken link. thats because javadocs
> external linking is fundamentally package-driven, broken by design for compile-time
> verification of correctness.
> * some documentation files have internal href links which should be checked to be correct.
> * this checker finds broken html links like unescaped slashes that we currently don't catch.
> * this checker finds real API bugs that javadocs won't warn about, such as protected methods
> returning package-private classes and so on.
> Once we fix the broken links we should be able to enforce all of this stuff in hudson, helping
> to prevent our documentation from growing wildly out of date.
--
This message is automatically generated by JIRA.
If you think it was sent incorrectly, please contact your JIRA administrators: https://issues.apache.org/jira/secure/ContactAdministrators!default.jspa
For more information on JIRA, see: http://www.atlassian.com/software/jira
---------------------------------------------------------------------
To unsubscribe, e-mail: dev-unsubscribe@lucene.apache.org
For additional commands, e-mail: dev-help@lucene.apache.org
[jira] [Updated] (LUCENE-4011) Check for broken documentation links
in hudson
Posted by "Chris Male (JIRA)" <ji...@apache.org>.
[ https://issues.apache.org/jira/browse/LUCENE-4011?page=com.atlassian.jira.plugin.system.issuetabpanels:all-tabpanel ]
Chris Male updated LUCENE-4011:
-------------------------------
Attachment: LUCENE-4011-lucene-links.patch
Another patch fixing the remaining intellij reported problems in all of lucene (primarily the facet module).
> Check for broken documentation links in hudson
> ----------------------------------------------
>
> Key: LUCENE-4011
> URL: https://issues.apache.org/jira/browse/LUCENE-4011
> Project: Lucene - Java
> Issue Type: Task
> Components: general/javadocs
> Reporter: Robert Muir
> Fix For: 4.0
>
> Attachments: LUCENE-4011-core-links.patch, LUCENE-4011-lucene-links.patch
>
>
> Mike added a cool script to dev-tools (checkJavadocLinks.py) that checks
> all local links in our documentation.
> I think we really need to check this in hudson and fail on any errors, for these reasons:
> * javadocs external linking is really broken, so 'ant javadocs' doesnt find all errors.
> for example you can do this:
> {noformat}
> {@link java.lang.JavaDocsSucks}
> {noformat}
> and nothing will ever give you any warning: just a broken link. thats because javadocs
> external linking is fundamentally package-driven, broken by design for compile-time
> verification of correctness.
> * some documentation files have internal href links which should be checked to be correct.
> * this checker finds broken html links like unescaped slashes that we currently don't catch.
> * this checker finds real API bugs that javadocs won't warn about, such as protected methods
> returning package-private classes and so on.
> Once we fix the broken links we should be able to enforce all of this stuff in hudson, helping
> to prevent our documentation from growing wildly out of date.
--
This message is automatically generated by JIRA.
If you think it was sent incorrectly, please contact your JIRA administrators: https://issues.apache.org/jira/secure/ContactAdministrators!default.jspa
For more information on JIRA, see: http://www.atlassian.com/software/jira
---------------------------------------------------------------------
To unsubscribe, e-mail: dev-unsubscribe@lucene.apache.org
For additional commands, e-mail: dev-help@lucene.apache.org