You are viewing a plain text version of this content. The canonical link for it is here.
Posted to issues@lucene.apache.org by GitBox <gi...@apache.org> on 2020/07/26 09:02:21 UTC
[GitHub] [lucene-solr] mocobeta opened a new pull request #1695: LUCENE-9321: Fix Javadoc offline link base url for snapshot build
mocobeta opened a new pull request #1695:
URL: https://github.com/apache/lucene-solr/pull/1695
This includes two changes in documentation task.
1. Fix Javadoc offline link base url to make snapshot build pass `checkBrokenLinks`.
2. Explicitly disable cross-project link for `:solr:test-framework`, otherwise broken links are generated due to split package issue.
See: https://github.com/apache/lucene-solr/blob/master/solr/test-framework/build.xml#L59
----------------------------------------------------------------
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.
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
---------------------------------------------------------------------
To unsubscribe, e-mail: issues-unsubscribe@lucene.apache.org
For additional commands, e-mail: issues-help@lucene.apache.org
[GitHub] [lucene-solr] mocobeta commented on pull request #1695: LUCENE-9321: Fix Javadoc offline link base url for snapshot build
Posted by GitBox <gi...@apache.org>.
mocobeta commented on pull request #1695:
URL: https://github.com/apache/lucene-solr/pull/1695#issuecomment-664343912
@uschindler would you check the changes?
----------------------------------------------------------------
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.
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
---------------------------------------------------------------------
To unsubscribe, e-mail: issues-unsubscribe@lucene.apache.org
For additional commands, e-mail: issues-help@lucene.apache.org
[GitHub] [lucene-solr] mocobeta commented on pull request #1695: LUCENE-9321: Fix Javadoc offline link base url for snapshot build
Posted by GitBox <gi...@apache.org>.
mocobeta commented on pull request #1695:
URL: https://github.com/apache/lucene-solr/pull/1695#issuecomment-665018578
Thanks for confirming, I merged it.
p.s.
> I don't fully understand the issue, but as a workaround it's ok for now.
Here is a bit more detailed explanation for the second change I omitted for laziness...
Without the change, several invalid links are generated (in solr-test-framework javadocs). e.g.:
```
BROKEN LINK: file:///mnt/hdd/repo/lucene-solr/lucene/build/documentation/core/org/apache/lucene/util/LuceneTestCase.html
BROKEN LINK: file:///mnt/hdd/repo/lucene-solr/solr/build/documentation/solrj/org/apache/solr/client/solrj/embedded/JettySolrRunner.html
```
They are invalid because `LuceneTestCase` actually belongs to `lucene-test-framework` module, and `JettySolrRunner` belongs to `solr-core` module. Seems like javadoc tool sees only package names in `element-list` and don't check if the classes really exist in the package when making links to referred classes (maybe it's an expected behaviour since the tool cannot retrieve the actual HTML files when `--linkoffline` option is used).
(Of course if we have no shared package names between modules, this problem should not occur.)
----------------------------------------------------------------
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.
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
---------------------------------------------------------------------
To unsubscribe, e-mail: issues-unsubscribe@lucene.apache.org
For additional commands, e-mail: issues-help@lucene.apache.org
[GitHub] [lucene-solr] dweiss commented on pull request #1695: LUCENE-9321: Fix Javadoc offline link base url for snapshot build
Posted by GitBox <gi...@apache.org>.
dweiss commented on pull request #1695:
URL: https://github.com/apache/lucene-solr/pull/1695#issuecomment-664187825
Look all right to me.
----------------------------------------------------------------
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.
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
---------------------------------------------------------------------
To unsubscribe, e-mail: issues-unsubscribe@lucene.apache.org
For additional commands, e-mail: issues-help@lucene.apache.org
[GitHub] [lucene-solr] mocobeta merged pull request #1695: LUCENE-9321: Fix Javadoc offline link base url for snapshot build
Posted by GitBox <gi...@apache.org>.
mocobeta merged pull request #1695:
URL: https://github.com/apache/lucene-solr/pull/1695
----------------------------------------------------------------
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.
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
---------------------------------------------------------------------
To unsubscribe, e-mail: issues-unsubscribe@lucene.apache.org
For additional commands, e-mail: issues-help@lucene.apache.org
[GitHub] [lucene-solr] mocobeta edited a comment on pull request #1695: LUCENE-9321: Fix Javadoc offline link base url for snapshot build
Posted by GitBox <gi...@apache.org>.
mocobeta edited a comment on pull request #1695:
URL: https://github.com/apache/lucene-solr/pull/1695#issuecomment-665018578
Thanks for confirming, I merged it.
p.s.
> I don't fully understand the issue, but as a workaround it's ok for now.
Here is a bit more detailed explanation for the second change I omitted for laziness
Without the change, several invalid links are generated (in solr-test-framework javadocs). e.g.:
```
BROKEN LINK: file:///mnt/hdd/repo/lucene-solr/lucene/build/documentation/core/org/apache/lucene/util/LuceneTestCase.html
BROKEN LINK: file:///mnt/hdd/repo/lucene-solr/solr/build/documentation/solrj/org/apache/solr/client/solrj/embedded/JettySolrRunner.html
```
They are invalid because `LuceneTestCase` actually belongs to `lucene-test-framework` module, and `JettySolrRunner` belongs to `solr-core` module. Seems like javadoc tool sees only package names in `element-list` and don't check if the classes really exist in the package when making links to referred classes (maybe it's an expected behaviour since the tool cannot retrieve the actual HTML files when `--linkoffline` option is used).
(Of course if we have no shared package names between modules, this problem should not occur.)
----------------------------------------------------------------
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.
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
---------------------------------------------------------------------
To unsubscribe, e-mail: issues-unsubscribe@lucene.apache.org
For additional commands, e-mail: issues-help@lucene.apache.org