[
https://issues.apache.org/jira/browse/DERBY-3668?page=com.atlassian.jira.plugin.system.issuetabpanels:all-tabpanel
]
Kim Haase updated DERBY-3668:
-----------------------------
Attachment: DERBY-3668-5.zip
DERBY-3668-5.stat
DERBY-3668-5.diff
Lance Andersen has provided some helpful offline feedback that resulted in the
following changes:
cdevconcepts22641.dita (Scrollable result sets): This sentence contained a
circular definition: "Insensitive result sets, in contrast to sensitive result
sets, are insensitive to changes made by others on the rows ..." I changed "are
insensitive to" to "cannot see".
cdevconcepts29416.dita (Using auto-commit): "Commit() or rollback() begins a
transaction" is misleading -- changed "begins" to "completes".
cdevstandardsxml.dita (XML data types and operators), whose first paragraph
appears in cdevstandards806118.dita (Derby and standards) and is misleadingly
incomplete: Changed
"Derby supports the XML data type and a set of operators that work with the XML
data type."
to
"Derby supports the XML data type and a set of operators that work with the XML
data type, but does not provide JDBC support for the XML data type."
I'm attaching DERBY-3668-5.diff, DERBY-3668-5.stat, and DERBY-3668-5.zip, which
incorporate these additional changes.
I'll commit this latest patch in a few days if no one suggests further changes.
> Remove JDBC 3.0-specific topics from Reference Manual and merge
> implementation notes as needed
> ----------------------------------------------------------------------------------------------
>
> Key: DERBY-3668
> URL: https://issues.apache.org/jira/browse/DERBY-3668
> Project: Derby
> Issue Type: Sub-task
> Components: Documentation
> Affects Versions: 10.4.1.3
> Reporter: Kim Haase
> Assignee: Kim Haase
> Priority: Minor
> Attachments: DERBY-3668-2.diff, DERBY-3668-2.stat, DERBY-3668-2.zip,
> DERBY-3668-3.diff, DERBY-3668-3.zip, DERBY-3668-4.diff, DERBY-3668-4.stat,
> DERBY-3668-4.zip, DERBY-3668-5.diff, DERBY-3668-5.stat, DERBY-3668-5.zip,
> DERBY-3668.diff, DERBY-3668.stat, DERBY-3668.zip
>
>
> The following files should be removed and their contents merged, where
> appropriate, with the main files for the interfaces concerned. If
> implementation notes in the JDBC 3.0 topics are identical to the javadoc
> (i.e. they are not really implementation notes), they can be dropped.
> rrefjdbc32593.html ("JDBC 3.0 features"): remove.
> rrefjdbcjavasqlconnection30.html ("java.sql.Connection interface: supported
> JDBC 3.0 methods"): remove and merge implementation notes with
> rrefjdbc27734.html ("java.sql.Connection interface") as needed. Only the last
> two items in the table contain implementation-specific information.
> rrefjdbcdatabasemetadata30.html ("java.sql.DatabaseMetaData interface:
> supported JDBC 3.0 methods"): remove and merge implementation notes with
> rrefjdbc15905.html ("java.sql.DatabaseMetaData interface") as needed. Only
> the last item in the table contains implementation-specific information.
> rrefjdbcparametermetadata30.html ("java.sql.ParameterMetaData interface:
> supported JDBC 3.0 methods"): remove. No need to create a topic for this
> interface in the general JDBC reference, since there is no
> implementation-specific information for it.
> rrefjdbcjavasqlpreparedstatement30.html ("java.sql.PreparedStatement
> interface: supported JDBC 3.0 methods"): remove. No implementation-specific
> information to merge.
> rrefjdbcjavasqlsavepoint.html ("java.sql.Savepoint interface") and its
> subtopics: This is a somewhat complicated case. There is information in here
> that really belongs in the Developer's Guide, I believe. I think this topic
> file should be moved up to the main JDBC reference section, but its only
> contents should be the two Derby-specific restrictions described in
> rrefjavsaverestrict.html ("Restrictions on savepoints"). The topic
> rrefjavsaverestrict.html should then be removed, since the rest of its
> contents are not implementation-specific. The substantive contents of
> rrefjdbcjavasqlsavepoint.html ("java.sql.Savepoint interface"),
> crefjavsavesetroll.html ("Setting and rolling back to a savepoint"),
> crefjavsaverel.html ("Releasing a savepoint"), and crefjavsaverules.html
> ("Rules for savepoints") could be combined into one topic and added to the
> Developer's Guide, probably as an additional subtopic of "Transactions" under
> "The JDBC Connection and Transaction Model", if that would make sense.
> rrefjdbcjavasqlstatement30.html ("java.sql.Statement interface: supported
> JDBC 3.0 methods"): remove and merge implementation notes with
> rrefjdbc40794.html ("java.sql.Statement interface") as needed. The subtopic
> crefjavstateautogen.html ("Autogenerated keys") should be made a subtopic of
> rrefjdbc40794.html ("java.sql.Statement interface"), after the "ResultSet
> objects" topic.
--
This message is automatically generated by JIRA.
-
You can reply to this email to add a comment to the issue online.
