Mailing-List: contact derby-dev-help@db.apache.org; run by ezmlm
Precedence: bulk
Reply-To: <derby-dev@db.apache.org>
Message-ID: <1587412.22321271714989603.JavaMail.jira@thor>
Date: Mon, 19 Apr 2010 18:09:49 -0400 (EDT)
From: "Kim Haase (JIRA)" <jira@apache.org>
To: derby-dev@db.apache.org
Subject: [jira] Commented: (DERBY-4618) "Syntax for the derbyrun.jar file"
 document page modification
In-Reply-To: <866879.30411271566286814.JavaMail.jira@thor>
MIME-Version: 1.0
Content-Type: text/plain; charset=utf-8
Content-Transfer-Encoding: 7bit


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

Kim Haase commented on DERBY-4618:
----------------------------------

Thank you very much, Nirmal, for adding this helpful information (and for your skill using DITA). I am wondering, though, whether the very simple "Getting Started" manual is the best place for information on using a special classpath to bring in additional classes for running ij. This information might be more suited to the "Starting ij" topic of the Tools and Utilities Guide. In any case, I think it should be added to that topic too.

I have some suggestions on rewording the text (English syntax, terminology, documentation conventions -- nothing major).

Suggested rewording if you keep it in Getting Started:

"You cannot use the -cp argument to set the classpath when you use the -jar argument to start the ij tool. Instead, you need to set the CLASSPATH environment variable beforehand. See Choosing a method to run the Derby tools and startup utilities  for more information on setting the CLASSPATH environment variable.

There is no such limitation when you run the sysinfo tool. See Running sysinfo for more information on running the sysinfo tool."

For this topic I have another question that may need an expert to answer it. I notice that the syntax for sysinfo in the table actually shows the -cp option, while the syntax for both ij and dblook as well as the server argument does not. Do you know whether -cp is also ignored when you run dblook or start the network server? There is probably less need for a special classpath with those, of course.

Suggested rewording for adding it to the Tools Guide topic (ttoolsij11815.dita):

If you need to use other classes in addition to derbyrun.jar, you cannot use the -cp argument to set the classpath when you use the -jar argument to start the ij tool. Instead, you need to set the CLASSPATH environment variable beforehand."

Maybe the best place would be after the paragraph that begins "If you use the last form of the command ..."

One further suggestion -- when you add new material, it is helpful to use an 80-character line length rather than putting an entire paragraph on one line. It helps readability in different editors.

Thanks very much for this contribution.

> "Syntax for the derbyrun.jar file" document page modification
> -------------------------------------------------------------
>
>                 Key: DERBY-4618
>                 URL: https://issues.apache.org/jira/browse/DERBY-4618
>             Project: Derby
>          Issue Type: Bug
>          Components: Documentation
>    Affects Versions: 10.3.1.4, 10.3.2.1, 10.3.3.0, 10.4.1.3, 10.4.2.0, 10.5.1.1, 10.5.2.0, 10.5.3.0
>            Reporter: C.S. Nirmal J. Fernando
>            Assignee: C.S. Nirmal J. Fernando
>            Priority: Trivial
>         Attachments: Derby-4618.zip, derby4618.diff
>
>
> In "Syntax for the derbyrun.jar file" (http://db.apache.org/derby/docs/10.5/getstart/rgsderbyrunjarsyntax.html) document page the use of -classpath or -cp when issuing java commands is not that explicitly explained. 

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