db-derby-dev mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From "Andrew McIntyre (JIRA)" <derby-...@db.apache.org>
Subject [jira] Commented: (DERBY-1223) Update Getting Started to include instructions on setting JAVA_HOME variable.
Date Fri, 08 Sep 2006 05:50:23 GMT
    [ http://issues.apache.org/jira/browse/DERBY-1223?page=comments#action_12433332 ] 
Andrew McIntyre commented on DERBY-1223:

Thanks, Laura, this is getting very close. Comments on the _3 patch:

cgsinstallingderby: the use of <filepath> blocks has caused the formatting of the last
bulleted list to be off. This is probably a bug in the DITA toolkit's transfomations for <filepath>s.
Maybe <codeph> should continue to be used here until we can figure out exactly what
is going on.

tgssetupjavaenvir: The fifth bullet point was also removed. Was that intentional? If so, it's
ok, since if a user is following along in the manual, running sysinfo is only a couple of
pages away. The Unix example for #3 contains an extra equals after DERBY_HOME: export PATH="$DERBY_HOME=/bin:$PATH".
With the description for #3, maybe the sentence after the examples is unnecessary? I'll leave
that decision up to you. At the end "For more information on scripts," should probably be
"For more information on the scripts included in the bin distribution"?

cgsusingtoolsutils: looks great, much improvement. Several small issues: second paragraph:
"Use the Derby scripts" should maybe be "You can use"? Extra period in the third paragraph
before "For example". Last sentence: "In discussing these tools in embedded mode, the directory
is referred to as the /bin directory unless stated otherwise." I think "DERBY_HOME/bin" is
used elsewhere, but maybe we don't even need to mention it? How about something like: "The
use of the Derby scripts to launch the tools in the following examples use the embedded mode
of the Derby database engine."

cgsusingsysinfo: sorry I missed this before, "After you set the DERBY_HOME/bin directory in
your PATH" should probably be "After you put the DERBY_HOME/bin directory into your PATH"?
Similar wording may be desirable for the first part of the 'Running ij' page.

Feel free to pass on anything with a question mark up there. In fact, I could even fix the
filepath -> codeph and the Unix example in tgssetupjavaenvir and commit this patch as-is.
Let me know if you'd like to address any of the other items I brought up and I'll wait for
another patch, or if you'd prefer I fix those two issues and commit as-is.

I'll look into the formatting for the choice tables. I agree that they could use more space.
I don't think that should be a hindrance to getting this patch committed, though.

> Update Getting Started to include instructions on setting JAVA_HOME variable.
> -----------------------------------------------------------------------------
>                 Key: DERBY-1223
>                 URL: http://issues.apache.org/jira/browse/DERBY-1223
>             Project: Derby
>          Issue Type: Improvement
>          Components: Documentation
>    Affects Versions:
>            Reporter: Andrew McIntyre
>         Assigned To: Laura Stewart
>            Priority: Minor
>             Fix For:
>         Attachments: derby1223.diff, derby1223_2.diff, derby1223_3.diff, Derby1223_html.zip,
derby1223_html2.zip, derby1223_html3.zip, Derby1223_ProposedChanges.txt
> As of the fix for DERBY-1082, the scripts were made consistent to require setting DERBY_HOME
(or DERBY_INSTALL) and JAVA_HOME. The documentation on setting up your environment in the
Getting Started guide should be updated to reflect that these variables should be set. 

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


View raw message