Developer's Guide has duplicate information on database connections
-------------------------------------------------------------------
Key: DERBY-3274
URL: https://issues.apache.org/jira/browse/DERBY-3274
Project: Derby
Issue Type: Bug
Affects Versions: 10.3.1.4
Reporter: Kim Haase
The Developer's Guide contains some duplicated information about database
connections and related topics. One glaring example is the short top-level
section "Embedded Derby basics", which comes after a longer section of the same
title under "JDBC applications and Derby basics". The information in the short
section that doesn't duplicate information elsewhere needs to be included in
appropriate places in the long section (and elsewhere as appropriate). The
topics for the short section should then be removed.
Specifically:
For the two introductory topics, the two sentences from
http://db.apache.org/derby/docs/dev/devguide/cdevdvlp25174.html ("Derby
embedded basics") should replace the sentence in
http://db.apache.org/derby/docs/dev/devguide/cdevdvlp39409.html (same title),
since they offer more substance.
The first sentence of
http://db.apache.org/derby/docs/dev/devguide/cdevdvlp40170.html ("Embedded
Derby JDBC driver"), "The Derby driver class name for the embedded environment
is org.apache.derby.jdbc.EmbeddedDriver.", should be moved to
http://db.apache.org/derby/docs/dev/devguide/cdevdvlp40653.html, "Derby JDBC
driver".
Most of http://db.apache.org/derby/docs/dev/devguide/rdevdvlp38881.html
("Embedded Derby JDBC database connection URL") should be moved to
http://db.apache.org/derby/docs/dev/devguide/cdevdvlp17453.html, "Derby JDBC
database connection URL". Also, this text should cross-reference the sections
http://db.apache.org/derby/docs/dev/devguide/cdevdvlp91854.html ("Accessing
databases from the classpath") and
http://db.apache.org/derby/docs/dev/devguide/cdevdvlp24155.html ("Accessing
databases from a jar or zip file"). In
http://db.apache.org/derby/docs/dev/devguide/cdevdvlp17453.html itself, the
sentence "For more information about what you can specify with the Derby
connection URL, see "Examples"." is incorrect. I believe this should be a
cross-reference to the section
http://db.apache.org/derby/docs/dev/devguide/rdevdvlp22102.html ("Database
connection examples"). Also, the sentence "For detailed reference about
attributes and values, as well as syntax of the database connection URL, see
the "Derby Database Connection URL Syntax" in the Derby Reference Manual."
refers, I believe, to the wrong section. That particular topic contains only a
couple of sentences and refers back to the Developer's Guide. I think the
sentence should say instead, "For detailed reference about attributes and
values, see "Setting attributes for the database connection URL" in the Derby
Reference Manual." (The syntax is actually covered more fully in the
Developer's Guide than in the Reference Manual.)
The last paragraph of
http://db.apache.org/derby/docs/dev/devguide/cdevdvlp10252.html ("Getting a
nested connection") should be moved to
http://db.apache.org/derby/docs/dev/devguide/cdevspecial29620.html,
"Database-side JDBC procedures and nested connections". (This topic also has a
couple of minor typographical issues that can be fixed at the same time.)
The example of the use of the jdbc.drivers system property should be moved from
http://db.apache.org/derby/docs/dev/devguide/tdevdvlp38381.html ("Starting
Derby as an embedded database") to
http://db.apache.org/derby/docs/dev/devguide/cdevdvlp40653.html, "Derby JDBC
driver".
The following sections can then be removed:
http://db.apache.org/derby/docs/dev/devguide/cdevdvlp25174.html ("Derby
embedded basics")
http://db.apache.org/derby/docs/dev/devguide/cdevdvlp40170.html ("Embedded
Derby JDBC driver")
http://db.apache.org/derby/docs/dev/devguide/rdevdvlp38881.html ("Embedded
Derby JDBC database connection URL")
http://db.apache.org/derby/docs/dev/devguide/cdevdvlp10252.html ("Getting a
nested connection")
http://db.apache.org/derby/docs/dev/devguide/tdevdvlp38381.html ("Starting
Derby as an embedded database")
--
This message is automatically generated by JIRA.
-
You can reply to this email to add a comment to the issue online.
