db-derby-dev mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From "Kim Haase (JIRA)" <j...@apache.org>
Subject [jira] [Commented] (DERBY-6236) Remove references to old JVMs (pre-Java 6) from the user guides
Date Wed, 05 Feb 2014 18:24:10 GMT

    [ https://issues.apache.org/jira/browse/DERBY-6236?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=13892384#comment-13892384
] 

Kim Haase commented on DERBY-6236:
----------------------------------

In the Reference Manual, it seems to me that not only "Features supported on all JDBC 4 releases"
but also "Features supported on JDBC 4.1 and above" can be merged into the main JDBC topics,
since JDBC 4.1 applies to JDK 6 and above. 

Under "Features supported on all JDBC 4 releases", two subtopics can be removed entirely,
since they describe nothing that is Derby-specific but only list standard new features: "java.sql.Connection
interface: JDBC 4.0 features" and "java.sql.Statement interface: JDBC 4.0 features". The information
in "javax.sql.DataSource interface: JDBC 3 and JDBC 4.0 features" overlaps with the information
in "DataSource classes" near the end of the manual and can therefore be removed. The parent
topic can also be removed, I believe.

The contents of "Refined subclasses of SQLException" can be moved, with modification, into
the "java.sql.SQLException class" topic. By the way, does the information in the Developer's
Guide section "Working with Derby SQLExceptions in an application" also apply to working with
the refined subtypes of SQLException? I am guessing it does.

The only Derby-specific item in "java.sql.DatabaseMetaData interface: JDBC 4.0 features" is,
I think, the statement that "The getColumns method reports IS_AUTOINCREMENT = YES if a column
is generated", which can be moved into the "java.sql.DatabaseMetaData interface" topic.

The "java.sql.SQLXML interface" topic can be moved up into the general JDBC section.

The "java.sql.Connection interface: JDBC 4.1 features" topic can be retitled "java.sql.Connection.abort
method" and moved (with appropriate edits) under the "java.sql.Connection interface" topic.

The information in "javax.sql.DataSource interface: JDBC 4.1 features" also overlaps with
the information in "DataSource classes" near the end of the manual and can therefore be removed.

There should, however, be a link to the "DataSource classes" topic from the top-level "JDBC
reference" topic.

Please let me know if anything here is off track. Thanks!

> Remove references to old JVMs (pre-Java 6) from the user guides
> ---------------------------------------------------------------
>
>                 Key: DERBY-6236
>                 URL: https://issues.apache.org/jira/browse/DERBY-6236
>             Project: Derby
>          Issue Type: Improvement
>          Components: Documentation
>    Affects Versions: 10.11.0.0
>            Reporter: Rick Hillegas
>            Assignee: Kim Haase
>
> DERBY-6213 removed support for Java 5 and CDC. We need to scour references to these platforms
from our user documentation. This includes scouring references to JDBC 3.0 and JSR 169. Changes
include the following:
> -------- Admin Guide -------------
> o "Differences in JDBC 3.0 methods": The section should be renamed to "Differences in
JDBC methods" and references to JDBC 3.0 should be removed from its text.
> -------- Developer's Guide -------------
> o "Derby and Java Virtual Machines (JVMs)": the lowest supported JVM level should be
changed from 5 to 6.
> -------- Getting Started Guide -------------
> o "System requirements": the lowest supported JVM level should be changed from 5 to 6.
> o"Verifying the Derby system configuration": bullet 1, references to Java version 5 should
be changed to 6.
> o "Self-study tutorial for users new to Derby": references to JDK version 5 should be
changed to 6.
> -------- Reference Guide -------------
> o "JDBC reference": Change "JDBC 3.0 and 4.0 APIs" -> "JDBC API"
> o "java.sql.Driver interface": This section gives instructions on how to load the JDBC
driver if you are running on an old (pre-Java 6) JVM. The section is almost vacuous now. It
can be collapsed to the following summary:
> "The class that loads Derby's local JDBC driver is the class org.apache.derby.jdbc.EmbeddedDriver.
The class that loads Derby's network client driver is the class org.apache.derby.jdbc.ClientDriver."
> o "JDBC Package for Connected Device Configuration/Foundation Profile (JSR 169)": Remove
this section.
> o "Features supported on all JDBC 4 releases": This section should be removed and its
material should be merged into the preceding sections.
> o "DataSource classes": The following changes should be made.
> "Embedded environment, for applications running on JDK 5 or higher and using JDBC 3 and
JDBC 4.0 methods:" -> "Embedded environment, for applications running on Java 6 or higher:"
> Remove the following paragraph and the list of *40 DataSources which it introduces:
> "Embedded environment, for applications running on JDK 6 or higher and using methods
specific to JDBC 4.1 or JDBC 4.2:"
> "Client-server environment, for applications running on JDK 5 or higher and using JDBC
3 and JDBC 4.0 methods:" -> "Client-server environment, for applications running on Java
6 or higher:"
> Remove the following paragraph and the list of *40 DataSources which it introduces:
> "Client-server environment, for applications running on JDK 6 or higher and using methods
specific to JDBC 4.1 or JDBC 4.2:"
> -------- Tools Guide -------------
> o "Environment setup and the Derby tools": The minimum Java level is 6, not 5.



--
This message was sent by Atlassian JIRA
(v6.1.5#6160)

Mime
View raw message