You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@lucene.apache.org by Apache Wiki <wi...@apache.org> on 2013/12/02 19:30:05 UTC

[Lucene-java Wiki] Update of "HowToGenerateNiceJavadocs" by UweSchindler

Dear Wiki user,

You have subscribed to a wiki page or wiki category on "Lucene-java Wiki" for change notification.

The "HowToGenerateNiceJavadocs" page has been changed by UweSchindler:
https://wiki.apache.org/lucene-java/HowToGenerateNiceJavadocs?action=diff&rev1=5&rev2=6

Comment:
Add warning. We should add better checks to ANT

   1. To make java7 javadocs for the website, first take your checkout of the release tag and clean old docs:
      {{{rm -rf solr/build/docs lucene/build/docs}}}
   1. Next put a java7 compiler in your JAVA_HOME and $JAVA_HOME/bin in the front of your path.
-  1. Under {{{lucene/}}}: {{{ant -Dversion=X.Y.Z -Djavadoc.noindex=false -Dbootclasspath=/path/to/the/minimum/java/jre/lib/rt.jar documentation}}}
-  1. Under {{{solr/}}}: {{{ant -Dversion=X.Y.Z -Djavadoc.noindex=false -Dbootclasspath=/path/to/the/minimum/java/jre/lib/rt.jar documentation}}}
+  1. Under {{{lucene/}}}: {{{ant -Dversion=X.Y.Z -Djavadoc.noindex=false -Dbootclasspath=/path/to/the/minimum/java/jre/lib/rt.jar documentation}}} (important: the path after -Dbootclasspath must be absolute and without shell specials like ~ or $ENV)
+  1. Under {{{solr/}}}: {{{ant -Dversion=X.Y.Z -Djavadoc.noindex=false -Dbootclasspath=/path/to/the/minimum/java/jre/lib/rt.jar documentation}}} (important: the path after -Dbootclasspath must be absolute and without shell specials like ~ or $ENV)
   1. Now you have fancy javadocs under lucene/build/docs/api and solr/build/docs/api, that otherwise link to the correct java versions and APIs, just look (hopefully) nicer.
   1. Deploy these to the website instead of the ones from the RC. (someone could always volunteer to do that after the release really at any time)