[jira] Commented: (DERBY-1662) Document derbyrun.jar

["Andrew McIntyre (JIRA)" <ji...@apache.org>]

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

Andrew McIntyre commented on DERBY-1662:
----------------------------------------

adminguide/tadmincbdjhhfd.html: 

This looks great. Seeing it this way, I can now clearly see a different use case for each type of invocation:

1. Scripts - for a user that might be new to Java - btw, we should add setting JAVA_HOME here because the scripts do require JAVA_HOME to be set (except on Mac OS X, where the location of the default JVM is always known).

2. derbyrun.jar - the user that is familiar with Java and has it in their path, but not necessarily familiar with Derby and can get right up and running with derbyrun.jar without having to set classpath.

3. expert user - the user is familiar with Java and Derby, has their classpath set already set appropriately with the Derby jars and knows the Derby class to invoke for a particular tool.

cgsusingtoolsutils.html:

second paragraph - ... can use the Derby scripts in /bin to start the Derby tools.

third paragraph - this seems to disrupt the flow of the text, can this move elsewhere? Then the second, fourth, adn fifth paragraphs could probably be combined. Also, there is an extra period after first sentence

1st bullet point under ways to run the tools - set your path to include..., although maybe this should say 'Follow the instructions in Setting Up Your Environment'...

2nd bullet point - ...change your path in order to run the tools and you already have a java executable in your PATH.  and ...

3rd bullet - ... specifying a classname, for example: ... as ij is just one of the four classes we are talking about here.

Comments on the files in the tools guide shortly...

> Document derbyrun.jar
> ---------------------
>
>                 Key: DERBY-1662
>                 URL: https://issues.apache.org/jira/browse/DERBY-1662
>             Project: Derby
>          Issue Type: Bug
>          Components: Documentation
>    Affects Versions: 10.2.1.6
>            Reporter: David Van Couvering
>         Assigned To: Kim Haase
>            Priority: Minor
>         Attachments: cgsusingtoolsutils.html, DERBY-1662-2.diff, DERBY-1662-2.zip, DERBY-1662.diff, tadmincbdjhhfd.html
>
>
> The documentation for ij in the Tools Guide only describes how to start ij the old way.  It should also describe how to start it using derbyrun.jar. 
> I wonder if the same is true for the other tools, although I haven't investigated.

-- 
This message is automatically generated by JIRA.
-
You can reply to this email to add a comment to the issue online.