You are viewing a plain text version of this content. The canonical link for it is here.
Posted to derby-commits@db.apache.org by rh...@apache.org on 2018/07/02 12:35:47 UTC
svn commit: r1834841 - in /db/derby/code/trunk: ./ build.xml
tools/ant/properties/release.properties tools/javadoc/publishedapi.ant
tools/javadoc/publishedapi_jdbc.ant
Author: rhillegas
Date: Mon Jul 2 12:35:47 2018
New Revision: 1834841
URL: http://svn.apache.org/viewvc?rev=1834841&view=rev
Log:
DERBY-6945: Generate module-aware javadoc; tests passed cleanly on derby-6945-44-aa-moduleAwareJavadoc.diff.
Removed:
db/derby/code/trunk/tools/javadoc/publishedapi.ant
db/derby/code/trunk/tools/javadoc/publishedapi_jdbc.ant
Modified:
db/derby/code/trunk/ (props changed)
db/derby/code/trunk/build.xml
db/derby/code/trunk/tools/ant/properties/release.properties
Propchange: db/derby/code/trunk/
------------------------------------------------------------------------------
--- svn:ignore (original)
+++ svn:ignore Mon Jul 2 12:35:47 2018
@@ -8,8 +8,7 @@ junit_*
generated
release
local.properties
-packageListLoc-j2ee-7
-packageListLoc-se-8
+packageListLoc*
TAGS
facts.txt
CURRPATCH
Modified: db/derby/code/trunk/build.xml
URL: http://svn.apache.org/viewvc/db/derby/code/trunk/build.xml?rev=1834841&r1=1834840&r2=1834841&view=diff
==============================================================================
--- db/derby/code/trunk/build.xml (original)
+++ db/derby/code/trunk/build.xml Mon Jul 2 12:35:47 2018
@@ -32,6 +32,14 @@
<property file="${properties.dir}/dirs.properties"/>
<!-- Compiler settings -->
<property file="${properties.dir}/sane${sanity}.properties"/>
+ <!-- Public api -->
+ <property file="${javadoctools.dir}/publishedapi.ant"/>
+
+ <!-- You can override this property in local.properties to fetch from an alternative location -->
+ <property name="javasedoc.url" value="https://docs.oracle.com/javase/9/docs/api"/>
+ <property name="j2eedoc.url" value="https://docs.oracle.com/javaee/7/api"/>
+ <property name="javasedoc.local" value="packageListLoc-se-9"/>
+ <property name="j2eedoc.local" value="packageListLoc-j2ee-7"/>
<!-- These properties are used by the Release build process. -->
<condition property="isWindows">
@@ -980,28 +988,16 @@
<target
name="javadoc"
- depends="init,initjars,publishedapi,derbydocs,toolsdocs,grammardocs,testingdocs"
+ depends="init,initjars,publishedapi,derbydocs,toolsdocs,grammardocs,demodocs"
description="Build all of the javadoc, including the public api, the production javadoc, and the testing javadoc."
/>
<target name="publishedapi" depends="initjars">
- <tstamp>
- <format
- property="javadoc.ts"
- pattern="EEE yyyy-MM-dd HH:mm:ssZ"
- locale="en, us"/>
- </tstamp>
- <property
- name="javadoc.Footer"
- value="Built on ${javadoc.ts}, from revision ${changenumber}"/>
-
<delete dir="${public.api.dir}"/>
<mkdir dir="${public.api.dir}"/>
- <antcall target="publishedapi-workhorse">
- <param name="extraApi" value="publishedapi_jdbc.ant"/>
- </antcall>
+ <antcall target="publishedapi-workhorse"/>
</target>
@@ -1009,12 +1005,6 @@
<!-- 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="https://docs.oracle.com/javase/9/docs/api"/>
- <property name="j2eedoc.url" value="https://docs.oracle.com/javaee/7/api"/>
- <property name="javasedoc.local" value="packageListLoc-se-9"/>
- <property name="j2eedoc.local" value="packageListLoc-j2ee-7"/>
-
<target name="packagelist_check">
<condition property="javadoc_local.exists">
<and>
@@ -1046,51 +1036,68 @@
-->
<target name="publishedapi-workhorse" depends="initjars,set-doclint,install_packagelists">
- <!-- Only include the files we want customers to see. -->
- <mkdir dir="${javadoc.temp.dir}"/>
- <antcall target="include-in-javadoc">
- <param name="more_inclusions" value="publishedapi.ant"/>
- </antcall>
- <antcall target="include-in-javadoc">
- <param name="more_inclusions" value="${extraApi}"/>
- </antcall>
-
- <javadoc bootclasspath="${bootClasspath}"
- classpath="${bootClasspath};${osgi};${servlet24};${out.all.dir};${jars.javadoc}"
- sourcepath="${derby.engine.src.dir}:${derby.client.src.dir}:${derby.drda.src.dir}:${derby.shared.src.dir}:${derby.optional.src.dir}:${derby.tools.src.dir}"
- excludepackagenames="org.apache.derby.*"
- breakiterator="true"
- access="public"
- destdir="${public.api.dir}"
- Overview="${basedir}/published_api_overview.html"
- Windowtitle="Apache Derby ${major}.${minor} API Documentation"
- Header="Apache Derby ${major}.${minor}"
- Footer="${javadoc.Footer}"
- bottom="Apache Derby ${major}.${minor} API Documentation - <i>Copyright &copy; 2004,${copyright.year} The Apache Software Foundation. All Rights Reserved.</i>">
- <Doctitle> Apache Derby ${major}.${minor} API Documentation</Doctitle>
- <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}"
- includesfile="${javadoc.inclusions}"/>
- <fileset dir="${derby.drda.src.dir}"
- includesfile="${javadoc.inclusions}"/>
- <fileset dir="${derby.tools.src.dir}"
- includesfile="${javadoc.inclusions}"/>
- <fileset dir="${derby.optional.src.dir}"
- includesfile="${javadoc.inclusions}"/>
- <arg value="${xarg.doclint}"/>
- </javadoc>
+ <exec executable="javadoc">
+ <arg value ="-d"/><arg value="${public.api.dir}"/>
+ <arg value="-Xdoclint:none"/>
+ <arg value="-breakiterator"/>
+ <arg value="-overview"/><arg value="${basedir}/published_api_overview.html"/>
+ <arg value="-windowtitle"/><arg value="Apache Derby ${major}.${minor} API Documentation"/>
+ <arg value="-header"/><arg value="Apache Derby ${major}.${minor}"/>
+ <arg value="-footer"/><arg value="${javadoc.Footer}"/>
+ <arg value="-bottom"/><arg value="Apache Derby ${major}.${minor} API Documentation - <i>Copyright &copy; 2004,${copyright.year} The Apache Software Foundation. All Rights Reserved.</i>"/>
+ <arg value="-doctitle"/><arg value="Apache Derby ${major}.${minor} API Documentation"/>
+ <arg value="-linkoffline"/><arg value="${javasedoc.url}"/><arg value="${javasedoc.local}"/>
+ <arg value="-linkoffline"/><arg value="${j2eedoc.url}"/><arg value="${j2eedoc.local}"/>
+ <arg value="--module-source-path"/><arg value="${javasrc.dir}:${generated.src.dir}"/>
+ <arg value="--module-path"/><arg value="${osgi}:${servlet24}:${junit}:${lucene_core}:${lucene_a_co}:${lucene_qp}:${json_simple}"/>
+ <arg value="${derby.shared.src.dir}/org/apache/derby/shared/common/security/SystemPermission.java"/>
+ <arg value="${derby.engine.src.dir}/org/apache/derby/agg/Aggregator.java"/>
+ <arg value="${derby.engine.src.dir}/org/apache/derby/authentication/UserAuthenticator.java"/>
+ <arg value="${derby.engine.src.dir}/org/apache/derby/catalog/SequencePreallocator.java"/>
+ <arg value="${derby.engine.src.dir}/org/apache/derby/mbeans/CacheManagerMBean.java"/>
+ <arg value="${derby.engine.src.dir}/org/apache/derby/mbeans/JDBCMBean.java"/>
+ <arg value="${derby.engine.src.dir}/org/apache/derby/mbeans/Management.java"/>
+ <arg value="${derby.engine.src.dir}/org/apache/derby/mbeans/ManagementMBean.java"/>
+ <arg value="${derby.engine.src.dir}/org/apache/derby/mbeans/VersionMBean.java"/>
+ <arg value="${derby.engine.src.dir}/org/apache/derby/vti/AwareVTI.java"/>
+ <arg value="${derby.engine.src.dir}/org/apache/derby/vti/ForeignTableVTI.java"/>
+ <arg value="${derby.engine.src.dir}/org/apache/derby/vti/ForwardingVTI.java"/>
+ <arg value="${derby.engine.src.dir}/org/apache/derby/vti/RestrictedVTI.java"/>
+ <arg value="${derby.engine.src.dir}/org/apache/derby/vti/Restriction.java"/>
+ <arg value="${derby.engine.src.dir}/org/apache/derby/vti/StringColumnVTI.java"/>
+ <arg value="${derby.engine.src.dir}/org/apache/derby/vti/VTICosting.java"/>
+ <arg value="${derby.engine.src.dir}/org/apache/derby/vti/VTIContext.java"/>
+ <arg value="${derby.engine.src.dir}/org/apache/derby/vti/VTIEnvironment.java"/>
+ <arg value="${derby.engine.src.dir}/org/apache/derby/vti/VTITemplate.java"/>
+ <arg value="${derby.drda.src.dir}/org/apache/derby/drda/NetServlet.java"/>
+ <arg value="${derby.drda.src.dir}/org/apache/derby/drda/NetworkServerControl.java"/>
+ <arg value="${derby.drda.src.dir}/org/apache/derby/mbeans/drda/NetworkServerMBean.java"/>
+ <arg value="${derby.tools.src.dir}/org/apache/derby/jdbc/BasicClientConnectionPoolDataSource40.java"/>
+ <arg value="${derby.tools.src.dir}/org/apache/derby/jdbc/BasicClientDataSource40.java"/>
+ <arg value="${derby.tools.src.dir}/org/apache/derby/jdbc/BasicClientXADataSource40.java"/>
+ <arg value="${derby.tools.src.dir}/org/apache/derby/jdbc/BasicEmbeddedConnectionPoolDataSource40.java"/>
+ <arg value="${derby.tools.src.dir}/org/apache/derby/jdbc/BasicEmbeddedDataSource40.java"/>
+ <arg value="${derby.tools.src.dir}/org/apache/derby/jdbc/BasicEmbeddedXADataSource40.java"/>
+ <arg value="${derby.tools.src.dir}/org/apache/derby/jdbc/ClientConnectionPoolDataSource.java"/>
+ <arg value="${derby.tools.src.dir}/org/apache/derby/jdbc/ClientDataSource.java"/>
+ <arg value="${derby.tools.src.dir}/org/apache/derby/jdbc/ClientDriver.java"/>
+ <arg value="${derby.tools.src.dir}/org/apache/derby/jdbc/ClientXADataSource.java"/>
+ <arg value="${derby.tools.src.dir}/org/apache/derby/jdbc/EmbeddedConnectionPoolDataSource.java"/>
+ <arg value="${derby.tools.src.dir}/org/apache/derby/jdbc/EmbeddedDataSource.java"/>
+ <arg value="${derby.tools.src.dir}/org/apache/derby/jdbc/EmbeddedDriver.java"/>
+ <arg value="${derby.tools.src.dir}/org/apache/derby/jdbc/EmbeddedXADataSource.java"/>
+ <arg value="${derby.tools.src.dir}/org/apache/derby/tools/dblook.java"/>
+ <arg value="${derby.tools.src.dir}/org/apache/derby/tools/ij.java"/>
+ <arg value="${derby.tools.src.dir}/org/apache/derby/tools/sysinfo.java"/>
+ <arg value="${derby.optional.src.dir}/org/apache/derby/optional/api/LuceneIndexDescriptor.java"/>
+ <arg value="${derby.optional.src.dir}/org/apache/derby/optional/api/LuceneUtils.java"/>
+ <arg value="${derby.optional.src.dir}/org/apache/derby/optional/api/SimpleJsonUtils.java"/>
+ <arg value="${derby.optional.src.dir}/org/apache/derby/optional/api/SimpleJsonVTI.java"/>
+ </exec>
- <delete dir="${javadoc.temp.dir}"/>
-
<!-- Copy the logo needed by the Doctitle attribute above -->
<copy file="${javadoctools.dir}/logo/derby_logo64.png"
- todir="${public.api.dir}/resources"/>
-
+ todir="${public.api.dir}/resources"/>
</target>
@@ -1100,92 +1107,30 @@
<delete dir="${out.javadoc.dir}/engine"/>
<mkdir dir="${out.javadoc.dir}/engine"/>
- <!-- Some of the link tags are lost when using nested filesets. Fool -->
- <!-- javadoc into creating relative links by seeding it with the list -->
- <!-- of packages that have @link tags in their package.htmls -->
- <copy file="${javadoctools.dir}/package-list"
- todir="${out.javadoc.dir}/engine"/>
-
- <!-- Build scripts and other cruft choke javadoc. Exclude these files. -->
- <mkdir dir="${javadoc.temp.dir}"/>
- <antcall target="exclude-from-javadoc">
- <param name="more_exclusions" value="derbydocs_exclusions.ant"/>
- </antcall>
-
- <javadoc
- additionalparam="-J-mx500M"
- packagenames="org.*"
- access="private"
- breakiterator="yes"
- useexternalfile="yes"
- classpath="${out.all.dir};${jars.javadoc}"
- destdir="${out.javadoc.dir}/engine"
- windowtitle="Apache Derby V${major}.${minor} Internals"
- doctitle="Apache Derby V${major}.${minor} Internals"
- Footer="${javadoc.Footer}"
- bottom="Apache Derby V${major}.${minor} Internals - <i>Copyright &copy; 2004,${copyright.year} The Apache Software Foundation. All Rights Reserved.</i>">
- <taglet name="org.apache.derbyBuild.javadoc.FormatIdTaglet"
- path="${basedir}/classes"/>
- <taglet name="org.apache.derbyBuild.javadoc.PurposeTaglet"
- path="${basedir}/classes"/>
- <taglet name="org.apache.derbyBuild.javadoc.UpgradeTaglet"
- path="${basedir}/classes"/>
- <taglet name="org.apache.derbyBuild.javadoc.DiskLayoutTaglet"
- path="${basedir}/classes"/>
- <taglet name="org.apache.derbyBuild.javadoc.EndFormatTaglet"
- path="${basedir}/classes"/>
- <fileset dir="${derby.engine.src.dir}"
- excludesfile="${javadoc.exclusions}"/>
- <fileset dir="${derby.client.src.dir}"
- excludesfile="${javadoc.exclusions}"/>
- <fileset dir="${derby.drda.src.dir}"
- excludesfile="${javadoc.exclusions}"/>
- <fileset dir="${derby.shared.src.dir}"
- excludesfile="${javadoc.exclusions}"/>
- <fileset dir="${derby.tools.src.dir}"
- excludesfile="${javadoc.exclusions}"/>
- <link href="."/>
- <arg value="${xarg.doclint}"/>
- </javadoc>
-
- <delete dir="${javadoc.temp.dir}"/>
+ <exec executable="javadoc">
+ <arg value ="-d"/><arg value="${out.javadoc.dir}/engine"/>
+ <arg value="-Xdoclint:none"/>
+ <arg value="-private"/>
+ <arg value="-breakiterator"/>
+ <arg value="-windowtitle"/><arg value="Apache Derby V${major}.${minor} Internals"/>
+ <arg value="-header"/><arg value="Apache Derby ${major}.${minor}"/>
+ <arg value="-footer"/><arg value="${javadoc.Footer}"/>
+ <arg value="-bottom"/><arg value="Apache Derby V${major}.${minor} Internals - <i>Copyright &copy; 2004,${copyright.year} The Apache Software Foundation. All Rights Reserved.</i>"/>
+ <arg value="-doctitle"/><arg value="Apache Derby V${major}.${minor} Internals"/>
+ <arg value="-tagletpath"/><arg value="${out.build.dir}"/>
+ <arg value="-taglet"/><arg value="org.apache.derbyBuild.javadoc.FormatIdTaglet"/>
+ <arg value="-taglet"/><arg value="org.apache.derbyBuild.javadoc.PurposeTaglet"/>
+ <arg value="-taglet"/><arg value="org.apache.derbyBuild.javadoc.UpgradeTaglet"/>
+ <arg value="-taglet"/><arg value="org.apache.derbyBuild.javadoc.DiskLayoutTaglet"/>
+ <arg value="-taglet"/><arg value="org.apache.derbyBuild.javadoc.EndFormatTaglet"/>
+ <arg value="--module-source-path"/><arg value="${javasrc.dir}:${generated.src.dir}"/>
+ <arg value="--module-path"/><arg value="${osgi}:${servlet24}:${lucene_core}:${lucene_a_co}:${lucene_qp}:${json_simple}:${junit}"/>
+ <arg value="--show-module-contents"/><arg value="all"/>
+ <arg value="--module"/><arg value="${module.name.commons},${module.name.engine},${module.name.client},${module.name.server},${module.name.tools},${module.name.optionaltools},${module.name.runner},${module.name.tests}"/>
+ </exec>
</target>
- <!--
- Include more files in the javadoc. Successive calls to this
- target append more inclusions to the master file that tells
- javadoc which files to notice.
-
- Parameters:
-
- more_inclusions Additional file to append to master inclusions file.
- -->
- <target name="include-in-javadoc">
- <concat destfile="${javadoc.inclusions}" append="yes">
- <filelist dir="${javadoctools.dir}"
- files="${more_inclusions}"
- />
- </concat>
- </target>
-
- <!--
- Exclude more files from the javadoc. Successive calls to this
- target append more exclusions to the master file that tells
- javadoc which files to ignore.
-
- Parameters:
-
- more_exclusions Additional file to append to master exclusions file.
- -->
- <target name="exclude-from-javadoc">
- <concat destfile="${javadoc.exclusions}" append="yes">
- <filelist dir="${javadoctools.dir}"
- files="${more_exclusions}"
- />
- </concat>
- </target>
-
<target name="toolsdocs">
<delete dir="${out.javadoc.dir}/tools"/>
@@ -1244,33 +1189,6 @@
</target>
- <target name="testingdocs" depends="initjars,set-doclint">
-
- <antcall target="exclude-from-javadoc">
- <param name="more_exclusions" value="derbydocs_exclusions.ant"/>
- </antcall>
-
- <javadoc
- additionalparam="-J-mx500M"
- packagenames="org.*"
- access="private"
- breakiterator="yes"
- useexternalfile="yes"
- classpath="${out.all.dir};${jars.javadoc};${junit}"
- destdir="${out.javadoc.dir}/testing"
- windowtitle="Apache Derby V${major}.${minor} Test Javadoc"
- doctitle="Apache Derby V${major}.${minor} Test Javadoc"
- Footer="${javadoc.Footer}"
- bottom="Apache Derby V${major}.${minor} Internals - <i>Copyright &copy; 2004,${copyright.year} The Apache Software Foundation. All Rights Reserved.</i>"
- source="${min.version}"
- >
- <fileset dir="${derby.testing.src.dir}"
- excludesfile="${javadoc.exclusions}"/>
- <arg value="${xarg.doclint}"/>
- </javadoc>
-
- </target>
-
<target name="cleandocs">
<delete dir="${out.javadoc.dir}"/>
@@ -1340,6 +1258,7 @@
name="buildjars"
depends="initjars,derbysharedjar,derbyjar,derbynetjar,derbyclientjar,derbytoolsjar,derbyoptionaltoolsjar,derbyrunjar,derbywar,derbylocalejars,derbytestingjar,jardriftcheck"
description="Build all of the Derby jar files."
+
/>
<target name="initjars" depends="setsanityname,getsvnversion,setCompilerProperties">
@@ -1347,6 +1266,17 @@
<property name="derby.jar.topdir" value="${jarsdist.dir}"/>
<mkdir dir="${derby.jar.dir}"/>
<mkdir dir="${derby.jar.dir}/lists"/>
+
+ <tstamp>
+ <format
+ property="javadoc.ts"
+ pattern="EEE yyyy-MM-dd HH:mm:ssZ"
+ locale="en, us"/>
+ </tstamp>
+ <property
+ name="javadoc.Footer"
+ value="Built on ${javadoc.ts}, from revision ${changenumber}"/>
+
</target>
Modified: db/derby/code/trunk/tools/ant/properties/release.properties
URL: http://svn.apache.org/viewvc/db/derby/code/trunk/tools/ant/properties/release.properties?rev=1834841&r1=1834840&r2=1834841&view=diff
==============================================================================
--- db/derby/code/trunk/tools/ant/properties/release.properties (original)
+++ db/derby/code/trunk/tools/ant/properties/release.properties Mon Jul 2 12:35:47 2018
@@ -20,7 +20,7 @@ major=10
minor=15
eversion=10.15
beta=true
-copyright.comment=Copyright 1997, 2017 The Apache Software Foundation or its licensors, as applicable.
+copyright.comment=Copyright 1997, 2018 The Apache Software Foundation or its licensors, as applicable.
vendor=The Apache Software Foundation
-copyright.year=2017
+copyright.year=2018
release.id.long=10.15.0.0 beta