You are viewing a plain text version of this content. The canonical link for it is here.
Posted to derby-dev@db.apache.org by "Jean T. Anderson (JIRA)" <de...@db.apache.org> on 2006/09/02 02:34:23 UTC

[jira] Commented: (DERBY-1798) Document Update: Tools Guide - Added derbyrun.jar information and clarified / corrected info on IJ and database loading classes

    [ http://issues.apache.org/jira/browse/DERBY-1798?page=comments#action_12432264 ] 
            
Jean T. Anderson commented on DERBY-1798:
-----------------------------------------

Very nice! I applied the patch and Stan updated 38 files with many improvements.

I have a couple comments:

1) In the ij.protocol description at http://db.apache.org/derby/docs/10.2/tools/rtoolsijpropref35032.html , this sentence was removed:
"Automatically loads the appropriate driver for recognized subprotocol."

2) In the "Notes" section of the ij.driver description at http://db.apache.org/derby/docs/10.2/tools/rtoolsijpropref41073.html the sentence "The driver property is a synonym." gets removed.

I can't judge if those deletions need to be revisited. Stan mentioned that he's now on vacation, but I can manage re-inserting those if needed (doesn't require DITA knowledge).

Finally, Stan introduces derbyrun.jar, but doesn't really explain it and I wonder if a little more could be useful (DERBY-1622).

At any rate, this patch is a definite step forward and I'll commit it unless there are any objections.

> Document Update: Tools Guide - Added derbyrun.jar information and clarified / corrected info on IJ and database loading classes
> -------------------------------------------------------------------------------------------------------------------------------
>
>                 Key: DERBY-1798
>                 URL: http://issues.apache.org/jira/browse/DERBY-1798
>             Project: Derby
>          Issue Type: Improvement
>          Components: Documentation
>    Affects Versions: 10.0.2.0, 10.0.2.1, 10.1.1.0, 10.1.2.1, 10.1.3.0, 10.1.3.1
>            Reporter: Stan Bradbury
>             Fix For: 10.2.2.0
>
>         Attachments: derbytools.pdf, ToolsGuide10.2upd.diff
>
>
> Attached:  patch for the document updates and pdf for review of resulting document.  Things were worse than I expected when I signed up to do  the review but they will be better with these changes - IMHO.
> NOTE: I am now on vacation so I will not be able to respond until I return after the expected release of version 10.2 - if you see something amiss please file an issue or correct it an submit a patch.
> Patch:  ToolsGuide10.2upd.diff
> Review output:  derbytools.pdf
> For more details see the 10.2 documentation review Wiki page :
> http://wiki.apache.org/db-derby/ToolsUtilitesTenTwo
> Here are few anotations I made about the changes before I ran out of time to continue this effort (many changes are minor but important for clarity):
>  o toolsconref.dita:  Changed DERBY_INSTALL to DERBY_HOME, added citwwd for reference to the Working With Derby docuement.
>  o ctoolspre23947.dita:  How this guide is organized
>     >> Added missing bullet for 'Storing jar files in a database'
>  o  ctoolsijtools26429.dita: What are the Derby tools and utilities?
>      >> Wrote a reasonable description 
>  o   ctoolsijtools30948.dita: in OVERVIEW: Made title consistant (added 'loading')
> Database class loading utilities - removed the questionable phrase:  '..and to boot an application using the stored classes' - added clarication about using import and export in a client/server environment.
>  o   ctoolsijtools30948.dita: JVM and classpath for Derby tools - Renamed to: 'Environment setup and the Derby tools' - added 'loading' to class loading util and clarified database-side comment.
>  o  rtools1003161.dita: Added information derbyrun.jar
>  o  ctoolsijtools20118.dita : Renamed 'JDBC basics' to 'JDBC connection basics' and added tie-in sentence.
>  o ctoolsijtools16011.dita : Database connection URLs; client driver section
>     >> Removed URL  attribute quoting statement and example (JCC only) - no longer needed: "..by using double quotes (") around the database name portion of the URL, as follows:"
>  o ctoolsij34525.dita: Using IJ: cleaned up wording
>  o ttoolsij11815.dita: Starting IJ - added derbyrun info - cleaned up wording - corrected formatting (PDF probelms) in the example by removing links.
>  o  ttoolsij30600.dita:Starting ij using properties  - Removed old information:
> To start ij to connect to the Derby Network Server, you must specify the user and
> password attributes on the URL. For more information, see the Derby Server and
> Administration Guide .
> o rtoolsdrvrnmeurl.dita - rewrote the section

-- 
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