You are viewing a plain text version of this content. The canonical link for it is here.
Posted to dev@lucene.apache.org by "Hoss Man (Created) (JIRA)" <ji...@apache.org> on 2012/04/05 21:30:24 UTC
[jira] [Created] (SOLR-3323) fix solr javadocs to link to local
lucene javadocs w/relative links when users build locally
fix solr javadocs to link to local lucene javadocs w/relative links when users build locally
--------------------------------------------------------------------------------------------
Key: SOLR-3323
URL: https://issues.apache.org/jira/browse/SOLR-3323
Project: Solr
Issue Type: Task
Components: documentation
Reporter: Hoss Man
Assignee: Steven Rowe
Fix For: 3.6, 4.0
Now that solr/lucene are in lock step development, and solr releases include the entire lucene-java release, the solr ant targets for building javadocs should depend on the lucene (and module) targets for building javadocs and link directly to the local copies of those docs (using relative paths)
(currently, the links point to https://hudson.apache.org/hudson/job/Lucene-trunk/javadoc/all/)
--
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] (SOLR-3323) fix solr javadocs to link to local
lucene javadocs w/relative links when users build locally
Posted by "Steven Rowe (Commented) (JIRA)" <ji...@apache.org>.
[ https://issues.apache.org/jira/browse/SOLR-3323?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=13247607#comment-13247607 ]
Steven Rowe commented on SOLR-3323:
-----------------------------------
This:
{noformat}
+ value="${common-solr.dir}/../lucene/build/docs/api/all/"/>
{noformat}
might be better as:
{noformat}
+ value="${common.dir}/build/docs/api/all/"/>
{noformat}
> fix solr javadocs to link to local lucene javadocs w/relative links when users build locally
> --------------------------------------------------------------------------------------------
>
> Key: SOLR-3323
> URL: https://issues.apache.org/jira/browse/SOLR-3323
> Project: Solr
> Issue Type: Task
> Components: documentation
> Reporter: Hoss Man
> Assignee: Steven Rowe
> Fix For: 4.0
>
> Attachments: SOLR-3323.patch
>
>
> SOLR-2439 changed how javadoc linkages are handled between solr javadocs and lucene javadocs -- but i think there is still an improvement to be made.
> currently if you are building a "SNAPSHOT" of solr, it links to builds.apache.org for the lucene docs -- but if you are building solr from src, you must have a full copy of the entire lucene+solr tree, so we should just use a relative link up to the local copy of the lucene javadocs (if you are compiling your own solr, you are probably not using precompiled lucene jars, so you may want to update the lucene javadocs as well)
--
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] (SOLR-3323) fix solr javadocs to link to local
lucene javadocs w/relative links when users build locally
Posted by "Steven Rowe (Commented) (JIRA)" <ji...@apache.org>.
[ https://issues.apache.org/jira/browse/SOLR-3323?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=13247585#comment-13247585 ]
Steven Rowe commented on SOLR-3323:
-----------------------------------
bq. i'm pretty sure this is as simple as changing the default value of lucene.javadoc.url set in target "define-lucene-javadoc-url-SNAPSHOT" to something like "../lucene/build/docs/api/all/"
+1.
Separately, in trunk right now:
{code:xml}
<target name="define-lucene-javadoc-url-SNAPSHOT" if="version.contains.SNAPSHOT">
<property name="lucene.javadoc.url"
value="https://builds.apache.org/job/Lucene-3.x/javadoc/all/"/>
</target>
{code}
That is, Solr trunk javadocs point to the branch_3x Lucene javadocs :(.
> fix solr javadocs to link to local lucene javadocs w/relative links when users build locally
> --------------------------------------------------------------------------------------------
>
> Key: SOLR-3323
> URL: https://issues.apache.org/jira/browse/SOLR-3323
> Project: Solr
> Issue Type: Task
> Components: documentation
> Reporter: Hoss Man
> Assignee: Steven Rowe
> Fix For: 4.0
>
>
> SOLR-2439 changed how javadoc linkages are handled between solr javadocs and lucene javadocs -- but i think there is still an improvement to be made.
> currently if you are building a "SNAPSHOT" of solr, it links to builds.apache.org for the lucene docs -- but if you are building solr from src, you must have a full copy of the entire lucene+solr tree, so we should just use a relative link up to the local copy of the lucene javadocs (if you are compiling your own solr, you are probably not using precompiled lucene jars, so you may want to update the lucene javadocs as well)
--
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] (SOLR-3323) fix solr javadocs to link to local
lucene javadocs w/relative links when users build locally
Posted by "Hoss Man (Updated) (JIRA)" <ji...@apache.org>.
[ https://issues.apache.org/jira/browse/SOLR-3323?page=com.atlassian.jira.plugin.system.issuetabpanels:all-tabpanel ]
Hoss Man updated SOLR-3323:
---------------------------
Attachment: SOLR-3323.patch
quick patch.
this definitely works from the top level, not sure yet about what happens if you run "ant javadocs" from within a single contrib or something like that.
> fix solr javadocs to link to local lucene javadocs w/relative links when users build locally
> --------------------------------------------------------------------------------------------
>
> Key: SOLR-3323
> URL: https://issues.apache.org/jira/browse/SOLR-3323
> Project: Solr
> Issue Type: Task
> Components: documentation
> Reporter: Hoss Man
> Assignee: Steven Rowe
> Fix For: 4.0
>
> Attachments: SOLR-3323.patch
>
>
> SOLR-2439 changed how javadoc linkages are handled between solr javadocs and lucene javadocs -- but i think there is still an improvement to be made.
> currently if you are building a "SNAPSHOT" of solr, it links to builds.apache.org for the lucene docs -- but if you are building solr from src, you must have a full copy of the entire lucene+solr tree, so we should just use a relative link up to the local copy of the lucene javadocs (if you are compiling your own solr, you are probably not using precompiled lucene jars, so you may want to update the lucene javadocs as well)
--
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] (SOLR-3323) fix solr javadocs to link to local
lucene javadocs w/relative links when users build locally
Posted by "Hoss Man (Resolved) (JIRA)" <ji...@apache.org>.
[ https://issues.apache.org/jira/browse/SOLR-3323?page=com.atlassian.jira.plugin.system.issuetabpanels:all-tabpanel ]
Hoss Man resolved SOLR-3323.
----------------------------
Resolution: Fixed
Assignee: Hoss Man (was: Steven Rowe)
yep yep ... good catch sarowe
Committed revision 1310062.
> fix solr javadocs to link to local lucene javadocs w/relative links when users build locally
> --------------------------------------------------------------------------------------------
>
> Key: SOLR-3323
> URL: https://issues.apache.org/jira/browse/SOLR-3323
> Project: Solr
> Issue Type: Task
> Components: documentation
> Reporter: Hoss Man
> Assignee: Hoss Man
> Fix For: 4.0
>
> Attachments: SOLR-3323.patch
>
>
> SOLR-2439 changed how javadoc linkages are handled between solr javadocs and lucene javadocs -- but i think there is still an improvement to be made.
> currently if you are building a "SNAPSHOT" of solr, it links to builds.apache.org for the lucene docs -- but if you are building solr from src, you must have a full copy of the entire lucene+solr tree, so we should just use a relative link up to the local copy of the lucene javadocs (if you are compiling your own solr, you are probably not using precompiled lucene jars, so you may want to update the lucene javadocs as well)
--
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] (SOLR-3323) fix solr javadocs to link to local
lucene javadocs w/relative links when users build locally
Posted by "Hoss Man (Updated) (JIRA)" <ji...@apache.org>.
[ https://issues.apache.org/jira/browse/SOLR-3323?page=com.atlassian.jira.plugin.system.issuetabpanels:all-tabpanel ]
Hoss Man updated SOLR-3323:
---------------------------
Description:
SOLR-2439 changed how javadoc linkages are handled between solr javadocs and lucene javadocs -- but i think there is still an improvement to be made.
currently if you are building a "SNAPSHOT" of solr, it links to builds.apache.org for the lucene docs -- but if you are building solr from src, you must have a full copy of the entire lucene+solr tree, so we should just use a relative link up to the local copy of the lucene javadocs (if you are compiling your own solr, you are probably not using precompiled lucene jars, so you may want to update the lucene javadocs as well)
was:
Now that solr/lucene are in lock step development, and solr releases include the entire lucene-java release, the solr ant targets for building javadocs should depend on the lucene (and module) targets for building javadocs and link directly to the local copies of those docs (using relative paths)
(currently, the links point to https://hudson.apache.org/hudson/job/Lucene-trunk/javadoc/all/)
Fix Version/s: (was: 3.6)
updating summary.
i'm pretty sure this is as simple as changing the default value of lucene.javadoc.url set in target "define-lucene-javadoc-url-SNAPSHOT" to something like "../lucene/build/docs/api/all/"
> fix solr javadocs to link to local lucene javadocs w/relative links when users build locally
> --------------------------------------------------------------------------------------------
>
> Key: SOLR-3323
> URL: https://issues.apache.org/jira/browse/SOLR-3323
> Project: Solr
> Issue Type: Task
> Components: documentation
> Reporter: Hoss Man
> Assignee: Steven Rowe
> Fix For: 4.0
>
>
> SOLR-2439 changed how javadoc linkages are handled between solr javadocs and lucene javadocs -- but i think there is still an improvement to be made.
> currently if you are building a "SNAPSHOT" of solr, it links to builds.apache.org for the lucene docs -- but if you are building solr from src, you must have a full copy of the entire lucene+solr tree, so we should just use a relative link up to the local copy of the lucene javadocs (if you are compiling your own solr, you are probably not using precompiled lucene jars, so you may want to update the lucene javadocs as well)
--
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