Mailing-List: contact derby-dev-help@db.apache.org; run by ezmlm
Precedence: bulk
Reply-To: <derby-dev@db.apache.org>
Date: Thu, 20 Feb 2014 00:24:25 +0000 (UTC)
From: "Myrna van Lunteren (JIRA)" <jira@apache.org>
To: derby-dev@db.apache.org
Message-ID: <JIRA.12694001.1391807870745.69160.1392855865319@arcas>
In-Reply-To: <JIRA.12694001.1391807870745@arcas>
References: <JIRA.12694001.1391807870745@arcas>
Subject: [jira] [Commented] (DERBY-6473) Manuals are inconsistent in
 subsubprotocol information
MIME-Version: 1.0
Content-Type: text/plain; charset=utf-8
Content-Transfer-Encoding: 7bit


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

Myrna van Lunteren commented on DERBY-6473:
-------------------------------------------

Looks good. 

It's too bad we're losing the link when we move things to a different guide, but I think it is the right thing to do in this case.

I have one minor comment (was already like this in the original text when it was in the devguide) re rrefjdbc37352:('Syntax of database connection URLs for applications with embedded databases'), 
- inconsistent casing: the syntax shows 'databasename' (in italics), but sections underneath use 'databaseNames' or 'databaseName'.


> Manuals are inconsistent in subsubprotocol information
> ------------------------------------------------------
>
>                 Key: DERBY-6473
>                 URL: https://issues.apache.org/jira/browse/DERBY-6473
>             Project: Derby
>          Issue Type: Bug
>          Components: Documentation
>    Affects Versions: 10.11.0.0
>            Reporter: Kim Haase
>            Assignee: Kim Haase
>            Priority: Minor
>         Attachments: DERBY-6473.diff, DERBY-6473.stat, DERBY-6473.zip
>
>
> Four subsubprotocols are listed in http://db.apache.org/derby/docs/10.10/devguide/cdevdvlp17453.html (Derby JDBC database connection URL), but only three in http://db.apache.org/derby/docs/10.10/ref/rrefjdbc37352.html (Syntax of database connection URLs for applications with embedded databases), which was apparently not updated when we documented in-memory databases. The Reference Manual should be corrected.
> Since reference information really belongs in the Reference Manual and duplicate information is hard to maintain, it would probably be a good idea to correct the syntax information in the reference manual topic, remove it from the Developer's Guide topic, and point Developer's Guide readers to the Reference Manual. I'll plan on doing this unless I hear otherwise.


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