You are viewing a plain text version of this content. The canonical link for it is here.
Posted to dev@lucene.apache.org by "Mark Miller (JIRA)" <ji...@apache.org> on 2009/09/08 00:56:57 UTC
[jira] Created: (LUCENE-1897) Links to javadoc from the site pages
do not work in the src dist because it does not include the javadoc under
docs.
Links to javadoc from the site pages do not work in the src dist because it does not include the javadoc under docs.
--------------------------------------------------------------------------------------------------------------------
Key: LUCENE-1897
URL: https://issues.apache.org/jira/browse/LUCENE-1897
Project: Lucene - Java
Issue Type: Bug
Components: Javadocs
Reporter: Mark Miller
Fix For: 2.9
Links to javadoc from the site pages do not work in the src dist because it does not include the javadoc under docs.
--
This message is automatically generated by JIRA.
-
You can reply to this email to add a comment to the issue online.
---------------------------------------------------------------------
To unsubscribe, e-mail: java-dev-unsubscribe@lucene.apache.org
For additional commands, e-mail: java-dev-help@lucene.apache.org
[jira] Issue Comment Edited: (LUCENE-1897) Links to javadoc from
the site pages do not work in the src dist because it does not include the
javadoc under docs.
Posted by "Mark Miller (JIRA)" <ji...@apache.org>.
[ https://issues.apache.org/jira/browse/LUCENE-1897?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=12754480#action_12754480 ]
Mark Miller edited comment on LUCENE-1897 at 9/11/09 10:04 PM:
---------------------------------------------------------------
I guess.
bq. if we had a refrence to a jar file in a README or an html page we wouldn't consider it a bug that people couldn't find that jar file in a source release
I dunno - perhaps. If the README said, you will find this jar at /lucene/jar and then I go to /lucene/jar and nothing is there, I would personally find that a bit confusing. But it wouldnt bother me too much I guess.
But if I open the site HTML in the folder docs, and most of the links are broken cause they point to javadoc - that seems broken to me. Whether we want to fix it or not, I don't know and I don't have a real suggestion - but certainly seems like a bug when we distribute a bunch of docs in a doc folder with a bunch of broken links.
* edit *
Unless it says somewhere - by the way - the doc folder will contain a bunch of links until you build the javadocs - that would convince me otherwise.
I'm not super concerned either way - you can feel free to close - it was more to flag a discussion than anything I'm personally vested in. To me, downloading to view the source, and then looking through the docs, I'd be confused when the links didn't work - but that doesn't mean anything has to change.
was (Author: markrmiller@gmail.com):
I guess.
bq. if we had a refrence to a jar file in a README or an html page we wouldn't consider it a bug that people couldn't find that jar file in a source release
I dunno - perhaps. If the README said, you will find this jar at /lucene/jar and then I go to /lucene/jar and nothing is there, I would personally find that a bit confusing. But it wouldnt bother me too much I guess.
But if I open the site HTML in the folder docs, and most of the links are broken cause they point to javadoc - that seems broken to me. Whether we want to fix it or not, I don't know and I don't have a real suggestion - but certainly seems like a bug when we distribute a bunch of docs in a doc folder with a bunch of broken links.
> Links to javadoc from the site pages do not work in the src dist because it does not include the javadoc under docs.
> --------------------------------------------------------------------------------------------------------------------
>
> Key: LUCENE-1897
> URL: https://issues.apache.org/jira/browse/LUCENE-1897
> Project: Lucene - Java
> Issue Type: Bug
> Components: Javadocs
> Reporter: Mark Miller
> Priority: Minor
> Fix For: 2.9
>
>
> Links to javadoc from the site pages do not work in the src dist because it does not include the javadoc under docs.
--
This message is automatically generated by JIRA.
-
You can reply to this email to add a comment to the issue online.
---------------------------------------------------------------------
To unsubscribe, e-mail: java-dev-unsubscribe@lucene.apache.org
For additional commands, e-mail: java-dev-help@lucene.apache.org
[jira] Commented: (LUCENE-1897) Links to javadoc from the site
pages do not work in the src dist because it does not include the javadoc
under docs.
Posted by "Hoss Man (JIRA)" <ji...@apache.org>.
[ https://issues.apache.org/jira/browse/LUCENE-1897?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=12754379#action_12754379 ]
Hoss Man commented on LUCENE-1897:
----------------------------------
Honestly: i don't think this is a bug. javadocs are generated, just like jar files ... if we had a refrence to a jar file in a README or an html page we wouldn't consider it a bug that people couldn't find that jar file in a source release, it's understood that they have to *build* the source release for the generated artifacts to be where they expect.
as long as running "ant javadoc" in a source release puts the javadocs in the right spot so that the linkss start working, we're doing the right thing.
> Links to javadoc from the site pages do not work in the src dist because it does not include the javadoc under docs.
> --------------------------------------------------------------------------------------------------------------------
>
> Key: LUCENE-1897
> URL: https://issues.apache.org/jira/browse/LUCENE-1897
> Project: Lucene - Java
> Issue Type: Bug
> Components: Javadocs
> Reporter: Mark Miller
> Priority: Minor
> Fix For: 2.9
>
>
> Links to javadoc from the site pages do not work in the src dist because it does not include the javadoc under docs.
--
This message is automatically generated by JIRA.
-
You can reply to this email to add a comment to the issue online.
---------------------------------------------------------------------
To unsubscribe, e-mail: java-dev-unsubscribe@lucene.apache.org
For additional commands, e-mail: java-dev-help@lucene.apache.org
[jira] Updated: (LUCENE-1897) Links to javadoc from the site pages
do not work in the src dist because it does not include the javadoc under
docs.
Posted by "Mark Miller (JIRA)" <ji...@apache.org>.
[ https://issues.apache.org/jira/browse/LUCENE-1897?page=com.atlassian.jira.plugin.system.issuetabpanels:all-tabpanel ]
Mark Miller updated LUCENE-1897:
--------------------------------
Fix Version/s: (was: 2.9)
we will likely just close this, but for now I'm just taking off 2.9 (didn't plan/think it would be done for 2.9 in the first place actually)
> Links to javadoc from the site pages do not work in the src dist because it does not include the javadoc under docs.
> --------------------------------------------------------------------------------------------------------------------
>
> Key: LUCENE-1897
> URL: https://issues.apache.org/jira/browse/LUCENE-1897
> Project: Lucene - Java
> Issue Type: Bug
> Components: Javadocs
> Reporter: Mark Miller
> Priority: Minor
>
> Links to javadoc from the site pages do not work in the src dist because it does not include the javadoc under docs.
--
This message is automatically generated by JIRA.
-
You can reply to this email to add a comment to the issue online.
---------------------------------------------------------------------
To unsubscribe, e-mail: java-dev-unsubscribe@lucene.apache.org
For additional commands, e-mail: java-dev-help@lucene.apache.org
[jira] Updated: (LUCENE-1897) Links to javadoc from the site pages
do not work in the src dist because it does not include the javadoc under
docs.
Posted by "Mark Miller (JIRA)" <ji...@apache.org>.
[ https://issues.apache.org/jira/browse/LUCENE-1897?page=com.atlassian.jira.plugin.system.issuetabpanels:all-tabpanel ]
Mark Miller updated LUCENE-1897:
--------------------------------
Priority: Minor (was: Major)
> Links to javadoc from the site pages do not work in the src dist because it does not include the javadoc under docs.
> --------------------------------------------------------------------------------------------------------------------
>
> Key: LUCENE-1897
> URL: https://issues.apache.org/jira/browse/LUCENE-1897
> Project: Lucene - Java
> Issue Type: Bug
> Components: Javadocs
> Reporter: Mark Miller
> Priority: Minor
> Fix For: 2.9
>
>
> Links to javadoc from the site pages do not work in the src dist because it does not include the javadoc under docs.
--
This message is automatically generated by JIRA.
-
You can reply to this email to add a comment to the issue online.
---------------------------------------------------------------------
To unsubscribe, e-mail: java-dev-unsubscribe@lucene.apache.org
For additional commands, e-mail: java-dev-help@lucene.apache.org
[jira] Commented: (LUCENE-1897) Links to javadoc from the site
pages do not work in the src dist because it does not include the javadoc
under docs.
Posted by "Mark Miller (JIRA)" <ji...@apache.org>.
[ https://issues.apache.org/jira/browse/LUCENE-1897?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=12754480#action_12754480 ]
Mark Miller commented on LUCENE-1897:
-------------------------------------
I guess.
bq. if we had a refrence to a jar file in a README or an html page we wouldn't consider it a bug that people couldn't find that jar file in a source release
I dunno - perhaps. If the README said, you will find this jar at /lucene/jar and then I go to /lucene/jar and nothing is there, I would personally find that a bit confusing. But it wouldnt bother me too much I guess.
But if I open the site HTML in the folder docs, and most of the links are broken cause they point to javadoc - that seems broken to me. Whether we want to fix it or not, I don't know and I don't have a real suggestion - but certainly seems like a bug when we distribute a bunch of docs in a doc folder with a bunch of broken links.
> Links to javadoc from the site pages do not work in the src dist because it does not include the javadoc under docs.
> --------------------------------------------------------------------------------------------------------------------
>
> Key: LUCENE-1897
> URL: https://issues.apache.org/jira/browse/LUCENE-1897
> Project: Lucene - Java
> Issue Type: Bug
> Components: Javadocs
> Reporter: Mark Miller
> Priority: Minor
> Fix For: 2.9
>
>
> Links to javadoc from the site pages do not work in the src dist because it does not include the javadoc under docs.
--
This message is automatically generated by JIRA.
-
You can reply to this email to add a comment to the issue online.
---------------------------------------------------------------------
To unsubscribe, e-mail: java-dev-unsubscribe@lucene.apache.org
For additional commands, e-mail: java-dev-help@lucene.apache.org
[jira] Commented: (LUCENE-1897) Links to javadoc from the site
pages do not work in the src dist because it does not include the javadoc
under docs.
Posted by "Mark Miller (JIRA)" <ji...@apache.org>.
[ https://issues.apache.org/jira/browse/LUCENE-1897?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=12753401#action_12753401 ]
Mark Miller commented on LUCENE-1897:
-------------------------------------
this one I think we are going to live with - unless we decide to include the expanded javadocs in src release.
I'm not going to worry about it myself for this release.
> Links to javadoc from the site pages do not work in the src dist because it does not include the javadoc under docs.
> --------------------------------------------------------------------------------------------------------------------
>
> Key: LUCENE-1897
> URL: https://issues.apache.org/jira/browse/LUCENE-1897
> Project: Lucene - Java
> Issue Type: Bug
> Components: Javadocs
> Reporter: Mark Miller
> Priority: Minor
> Fix For: 2.9
>
>
> Links to javadoc from the site pages do not work in the src dist because it does not include the javadoc under docs.
--
This message is automatically generated by JIRA.
-
You can reply to this email to add a comment to the issue online.
---------------------------------------------------------------------
To unsubscribe, e-mail: java-dev-unsubscribe@lucene.apache.org
For additional commands, e-mail: java-dev-help@lucene.apache.org
[jira] Commented: (LUCENE-1897) Links to javadoc from the site
pages do not work in the src dist because it does not include the javadoc
under docs.
Posted by "Hoss Man (JIRA)" <ji...@apache.org>.
[ https://issues.apache.org/jira/browse/LUCENE-1897?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=12754486#action_12754486 ]
Hoss Man commented on LUCENE-1897:
----------------------------------
bq. If the README said, you will find this jar at /lucene/jar and then I go to /lucene/jar and nothing is there, I would personally find that a bit confusing. But it wouldnt bother me too much I guess.
That's almost exactly what our README file says actually...
{noformat}
...
FILES
lucene-core-XX.jar
The compiled lucene library.
lucene-demos-XX.jar
The compiled simple example code.
luceneweb.war
The compiled simple example Web Application.
contrib/*
Contributed code which extends and enhances Lucene, but is not
part of the core library. Of special note are the JAR files in the analyzers
and snowball directory which
contain various analyzers that people may find useful in place of the Standard
Analyzer.
docs/index.html
The contents of the Lucene website.
docs/api/index.html
The Javadoc Lucene API documentation. This includes the core
library, the demo, as well as all of the contrib modules.
...
{noformat}
...if anything, it's somewhat odd that we include the generated documentation in our source release (instead of just the forrest docs) but that's only because the generated docs are also committed into SVN (which now that i tihnk about it is also really weird since we seperated the version specific docs from the site docs)
> Links to javadoc from the site pages do not work in the src dist because it does not include the javadoc under docs.
> --------------------------------------------------------------------------------------------------------------------
>
> Key: LUCENE-1897
> URL: https://issues.apache.org/jira/browse/LUCENE-1897
> Project: Lucene - Java
> Issue Type: Bug
> Components: Javadocs
> Reporter: Mark Miller
> Priority: Minor
> Fix For: 2.9
>
>
> Links to javadoc from the site pages do not work in the src dist because it does not include the javadoc under docs.
--
This message is automatically generated by JIRA.
-
You can reply to this email to add a comment to the issue online.
---------------------------------------------------------------------
To unsubscribe, e-mail: java-dev-unsubscribe@lucene.apache.org
For additional commands, e-mail: java-dev-help@lucene.apache.org
[jira] Issue Comment Edited: (LUCENE-1897) Links to javadoc from
the site pages do not work in the src dist because it does not include the
javadoc under docs.
Posted by "Mark Miller (JIRA)" <ji...@apache.org>.
[ https://issues.apache.org/jira/browse/LUCENE-1897?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=12754480#action_12754480 ]
Mark Miller edited comment on LUCENE-1897 at 9/11/09 10:05 PM:
---------------------------------------------------------------
I guess.
bq. if we had a refrence to a jar file in a README or an html page we wouldn't consider it a bug that people couldn't find that jar file in a source release
I dunno - perhaps. If the README said, you will find this jar at /lucene/jar and then I go to /lucene/jar and nothing is there, I would personally find that a bit confusing. But it wouldnt bother me too much I guess.
But if I open the site HTML in the folder docs, and most of the links are broken cause they point to javadoc - that seems broken to me. Whether we want to fix it or not, I don't know and I don't have a real suggestion - but certainly seems like a bug when we distribute a bunch of docs in a doc folder with a bunch of broken links.
* edit *
Unless it says somewhere - by the way - the doc folder will contain a bunch of broken links until you build the javadocs - that would convince me otherwise.
I'm not super concerned either way - you can feel free to close - it was more to flag a discussion than anything I'm personally vested in. To me, downloading to view the source, and then looking through the docs, I'd be confused when the links didn't work - but that doesn't mean anything has to change.
was (Author: markrmiller@gmail.com):
I guess.
bq. if we had a refrence to a jar file in a README or an html page we wouldn't consider it a bug that people couldn't find that jar file in a source release
I dunno - perhaps. If the README said, you will find this jar at /lucene/jar and then I go to /lucene/jar and nothing is there, I would personally find that a bit confusing. But it wouldnt bother me too much I guess.
But if I open the site HTML in the folder docs, and most of the links are broken cause they point to javadoc - that seems broken to me. Whether we want to fix it or not, I don't know and I don't have a real suggestion - but certainly seems like a bug when we distribute a bunch of docs in a doc folder with a bunch of broken links.
* edit *
Unless it says somewhere - by the way - the doc folder will contain a bunch of links until you build the javadocs - that would convince me otherwise.
I'm not super concerned either way - you can feel free to close - it was more to flag a discussion than anything I'm personally vested in. To me, downloading to view the source, and then looking through the docs, I'd be confused when the links didn't work - but that doesn't mean anything has to change.
> Links to javadoc from the site pages do not work in the src dist because it does not include the javadoc under docs.
> --------------------------------------------------------------------------------------------------------------------
>
> Key: LUCENE-1897
> URL: https://issues.apache.org/jira/browse/LUCENE-1897
> Project: Lucene - Java
> Issue Type: Bug
> Components: Javadocs
> Reporter: Mark Miller
> Priority: Minor
> Fix For: 2.9
>
>
> Links to javadoc from the site pages do not work in the src dist because it does not include the javadoc under docs.
--
This message is automatically generated by JIRA.
-
You can reply to this email to add a comment to the issue online.
---------------------------------------------------------------------
To unsubscribe, e-mail: java-dev-unsubscribe@lucene.apache.org
For additional commands, e-mail: java-dev-help@lucene.apache.org