Solr
  1. Solr
  2. SOLR-3323

fix solr javadocs to link to local lucene javadocs w/relative links when users build locally

    Details

    • Type: Task Task
    • Status: Closed
    • Priority: Major Major
    • Resolution: Fixed
    • Affects Version/s: None
    • Fix Version/s: 4.0-ALPHA
    • Component/s: documentation
    • Labels:
      None

      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)

        Issue Links

          Activity

          Hide
          Hoss Man added a comment -

          yep yep ... good catch sarowe

          Committed revision 1310062.

          Show
          Hoss Man added a comment - yep yep ... good catch sarowe Committed revision 1310062.
          Hide
          Steve Rowe added a comment -

          This:

          +              value="${common-solr.dir}/../lucene/build/docs/api/all/"/>
          

          might be better as:

          +              value="${common.dir}/build/docs/api/all/"/>
          
          Show
          Steve Rowe added a comment - This: + value="${common-solr.dir}/../lucene/build/docs/api/all/"/> might be better as: + value="${common.dir}/build/docs/api/all/"/>
          Hide
          Hoss Man added a comment -

          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.

          Show
          Hoss Man added a comment - 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.
          Hide
          Steve Rowe added a comment -

          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:

          <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>
          

          That is, Solr trunk javadocs point to the branch_3x Lucene javadocs .

          Show
          Steve Rowe added a comment - 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: <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> That is, Solr trunk javadocs point to the branch_3x Lucene javadocs .
          Hide
          Hoss Man added a comment -

          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/"

          Show
          Hoss Man added a comment - 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/"

            People

            • Assignee:
              Hoss Man
              Reporter:
              Hoss Man
            • Votes:
              0 Vote for this issue
              Watchers:
              0 Start watching this issue

              Dates

              • Created:
                Updated:
                Resolved:

                Development