Mailing-List: contact derby-dev-help@db.apache.org; run by ezmlm
Precedence: bulk
Reply-To: <derby-dev@db.apache.org>
Message-ID: <20790348.1147214825351.JavaMail.jira@brutus>
Date: Tue, 9 May 2006 22:47:05 +0000 (GMT+00:00)
From: "Rick Hillegas (JIRA)" <derby-dev@db.apache.org>
To: derby-dev@db.apache.org
Subject: [jira] Updated: (DERBY-1079) Build javadoc  under jdk 1.6
In-Reply-To: <1503284705.1141690529243.JavaMail.jira@ajax>
MIME-Version: 1.0
Content-Type: text/plain; charset=utf-8
Content-Transfer-Encoding: 7bit

     [ http://issues.apache.org/jira/browse/DERBY-1079?page=all ]

Rick Hillegas updated DERBY-1079:
---------------------------------

    Attachment: bug1079_split2.diff

Committed bug1079_split2.diff at subversion revision 405560. This improves the previous patch as follows:

o Renames the webpage to trunk/index.html and removes it from the publishedapi directory. Andrew will sand down this file and link it to additional documents, including our html user guides.

o Corrects the wording of the webpage as John recommended.

Note that the if="jdk16" conditional mentioned by Andrew is included in the target itself. If you build the javadoc without jdk16 in your ant.properties, then you will get the same javadoc you got six months ago.

> Build javadoc  under jdk 1.6
> ----------------------------
>
>          Key: DERBY-1079
>          URL: http://issues.apache.org/jira/browse/DERBY-1079
>      Project: Derby
>         Type: Bug

>   Components: Build tools
>     Versions: 10.2.0.0
>     Reporter: Rick Hillegas
>     Assignee: Rick Hillegas
>      Fix For: 10.2.0.0
>  Attachments: bug1079_clientPublicAPI.diff, bug1079_deprecated.diff, bug1079_embeddedPublicAPI.diff, bug1079_rev1.diff, bug1079_split.diff, bug1079_split2.diff
>
> We would like to build the javadoc under 1.6 so that all of the classes (including the JDBC 3 and JDBC 4 support) end up in the same directory tree. This is particularly important for the published API which we expose to end-users.
> Right now you can do the following:
> 1) Build the whole codeline using the 1.4 compiler for most classes and the 1.6 compiler for the JDBC4 support.
> 2) Build javadoc in a 1.4 environment (with JAVA_HOME set to 1.4). This runs step (1) if it has not already happened. This javadoc excludes the JDBC4 support because generics-laden JDBC4 signatures choke the 1.4 compiler.
> 3) Build the javadoc in a 1.6 environment (with JAVA_HOME set to 1.6). This will fail if you have not run step (1); this is because you can't build Derby in a 1.6 environment yet. This also generates a number of warnings because the 1.6 javadoc tool objects to code generated by the JAVACC grammar tool; JAVACC turns out code with loop variables distastefully named "enum". In addition, today, the 1.6 javadoc excludes the JDBC4 support.
> We would like to end up with the following situation:
> a) If your ant.properties points at a 1.6 installation, then the javadoc targets will use the 1.6 javadoc tool and will include Derby's JDBC4 support. This will work regardless of whether you have already built the class tree. If you have not already built the class tree, then we will compile it under scenario (1) above.
> b) If, however, your ant.properties does not point at a 1.6 installation, then the javadocs target will continue to use the 1.4 javadoc tool to build only the classes built today. The JDBC4 support will be excluded from this javadoc.
> c) As part of releasing 10.2, we will build the javadoc under scenario (a).
> d) Once 1.6 exits beta and becomes a production vm, the community can debate when we want to fix DERBY-1078 and require 1.6 in the build environment.

-- 
This message is automatically generated by JIRA.
-
If you think it was sent incorrectly contact one of the administrators:
   http://issues.apache.org/jira/secure/Administrators.jspa
-
For more information on JIRA, see:
   http://www.atlassian.com/software/jira