db-derby-commits mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From d..@apache.org
Subject svn commit: r1603943 - in /db/derby/code/trunk: ./ build.xml
Date Thu, 19 Jun 2014 17:02:06 GMT
Author: dag
Date: Thu Jun 19 17:02:06 2014
New Revision: 1603943

URL: http://svn.apache.org/r1603943
Log:
DERBY-6552 The public api includes methods inherited from superclasses which aren't in the
public api and so have no javadoc comments

Patch derby-6552-firewall-balm:

- Use an explicit <get> task to download the required package lists
  for the external Java SE and J2EE Javadocs we want to link to from
  our published API docs.

- Remove the explicit boot classpath set to 16 level lest we get
  errors generating the docs for classes which require a higher
  level. The new method needs to see all source file to be able to
  resolve links and inherit javadocs. The first time the publishedapi
  target is built, the package lists will be downloaded and cached in
  local directories. Added svn ignore setting for those. On subsequent
  builds, the cached values will be used. If behind a firewall the
  first time one builds, one needs to let ant know how to bypass the
  firewall, e.g. this way in bash:

     > export ANT_OPTS="-Dhttp.proxyHost=proxyserver -Dhttp.proxyPort=80"

  in bash(1).


Modified:
    db/derby/code/trunk/   (props changed)
    db/derby/code/trunk/build.xml

Propchange: db/derby/code/trunk/
------------------------------------------------------------------------------
--- svn:ignore (original)
+++ svn:ignore Thu Jun 19 17:02:06 2014
@@ -8,3 +8,9 @@ junit_*
 generated
 release
 local.properties
+packageListLoc-j2ee-7
+packageListLoc-se-8
+TAGS
+facts.txt
+CURRPATCH
+foo*

Modified: db/derby/code/trunk/build.xml
URL: http://svn.apache.org/viewvc/db/derby/code/trunk/build.xml?rev=1603943&r1=1603942&r2=1603943&view=diff
==============================================================================
--- db/derby/code/trunk/build.xml (original)
+++ db/derby/code/trunk/build.xml Thu Jun 19 17:02:06 2014
@@ -1049,12 +1049,37 @@
     <mkdir dir="${public.api.dir}"/>
  
     <antcall target="publishedapi-workhorse">
-      <param name="bootClasspath" value="${java16compile.classpath}"/>
       <param name="extraApi" value="publishedapi_jdbc.ant"/>
     </antcall>
 
   </target>
 
+<!-- ==================================================================== -->
+<!--                     Download Java SE and J2EE's "package-list"s      -->
+<!-- ==================================================================== -->
+
+   <!-- You can override this property in local.properties to fetch from an alternative
location -->
+   <property name="javasedoc.url" value="http://docs.oracle.com/javase/8/docs/api"/>
+   <property name="j2eedoc.url" value="http://docs.oracle.com/javaee/7/api"/>
+   <property name="javasedoc.local" value="packageListLoc-se-8"/>
+   <property name="j2eedoc.local" value="packageListLoc-j2ee-7"/>
+
+   <target name="packagelist_check">
+     <condition property="javadoc_local.exists">
+       <and>
+       <available file="${javasedoc.local}/package-list" property="javasedoc.exists"/>
+       <available file="${j2eedoc.local}/package-list" property="j2eedoc.exists"/>
+       </and>
+     </condition>
+   </target>
+
+   <target name="install_packagelists" depends="packagelist_check" unless="javadoc_local.exists"
description="downloads Java SE and J2EE package lists to local cache">
+       <mkdir dir="${javasedoc.local}"/>
+       <mkdir dir="${j2eedoc.local}"/>
+       <get src="${javasedoc.url}/package-list" dest="${javasedoc.local}/" verbose="true"
ignoreerrors="false"/>
+       <get src="${j2eedoc.url}/package-list" dest="${j2eedoc.local}/" verbose="true"
ignoreerrors="false"/>
+   </target>
+
   <!--
     This target used to be called twice, once to build the JDBC3 public api
     and then a second time to build the JDBC4 api. Now it is only called once,
@@ -1068,7 +1093,7 @@
     folders ./packageListLoc-se-8 and ./packageListLoc-j2ee-7 instead
     to get a correct build.
   -->
-  <target name="publishedapi-workhorse" depends="initjars,set-doclint">
+  <target name="publishedapi-workhorse" depends="initjars,set-doclint,install_packagelists">
  
     <!--  Only include the files we want customers to see.  -->
     <mkdir dir="${javadoc.temp.dir}"/>
@@ -1092,12 +1117,10 @@
              Footer="${javadoc.Footer}"
              bottom="Apache Derby ${major}.${minor} API Documentation  -  &lt;i&gt;Copyright
&amp;copy; 2004,${copyright.year} The Apache Software Foundation. All Rights Reserved.&lt;/i&gt;">
       <Doctitle> Apache Derby ${major}.${minor} API Documentation</Doctitle>
  
-      <link offline="true" href="http://docs.oracle.com/javase/8/docs/api/"
-                         packagelistLoc="packageListLoc-se-8" />
-      <link href="http://docs.oracle.com/javase/8/docs/api/"/>
-      <link offline="true" href="http://docs.oracle.com/javaee/7/api/"
-                     packagelistLoc="packageListLoc-j2ee-7" />
-      <link href="http://docs.oracle.com/javaee/7/api/"/>
+      <link offline="true" href="${javasedoc.url}"
+                         packagelistLoc="${javasedoc.local}" />
+      <link offline="true" href="${j2eedoc.url}"
+                     packagelistLoc="${j2eedoc.local}" />
       <fileset dir="${derby.engine.src.dir}"
                includesfile="${javadoc.inclusions}"/>
       <fileset dir="${derby.client.src.dir}"



Mime
View raw message